Concept Office Rest API - Vorgänge

Ein Concept Office Vorgang wird primär über die folgenden Datenbanktabellen befüllt:

Domänenbegriff Tabelle Rolle Abhängigkeiten
Vorgangskopf Auftragskoepfe Hauptobjekt Referenziert u. a. Kunde und Geschäftsbereich
Vorgangsposition AuftragsPositionen Unterobjekt Gehört zu einem Vorgang über auftragsnummer
Kalkulation AuftragsKalkulationen Unterobjekt Gehört zu einem Vorgang
Auftragsanschrift AuftragsAnschriften Unterobjekt Gehört zu einem Vorgang

Hinweis: Eine Vorgangsposition kann erst angelegt werden, wenn der Vorgangskopf angelegt ist.


Auftragskoepfe (Hauptobjekt)

Get

  • Mehrere Vorgänge aufrufen:
    GET /Office/CoServiceRestApi/office/auftragskoepfe
  • Ausgewählten Vorgang aufrufen:
    GET /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}
  • Vorgang suchen:
    GET /Office/CoServiceRestApi/office/auftragskoepfe?q=XXXXX&count=2&skip=0

Post (Pflichtfelder / Beispiel)

Neuen Vorgang anlegen:

POST /Office/CoServiceRestApi/office/auftragskoepfe
{
  "KundenNr": 10000,
  "Abwicklungsart": "Strecke",
  "AnsprechpartnerNrNichtNeuErmitteln": false,
  "AuftragsrechteIgnorieren": false,
  "IstGutschrift": false,
  "bearbeitungsstatus": 0,
  "ShallSave": true,
  "Geschaeftsbereich": "Bueromoebel"
}

Put

Ausgewählten Vorgang bearbeiten:

PUT /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}
{
  "bearbeitungsstatus": 2,
  "sbmitarbeiternummer": 999,
  "vorgangstitel": "Projekt Mustermann",
  "auslieferungsbemerkung": "Dieser Vorgang wurde via API bearbeitet und bestaetigt."
}

Delete

Ausgewählten Vorgang löschen:

DELETE /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}

AuftragsPositionen (Unterobjekt)

Get

  • Ausgewählte Vorgangsposition aufrufen:
    GET /Office/CoServiceRestApi/office/auftragspositionen/{auftragsNummer}/{positionsNummer}

Post (Pflichtfelder / Beispiel)

Neue Vorgangsposition anlegen:

POST /Office/CoServiceRestApi/office/auftragspositionen
{
  "auftragsnummer": 4205100,
  "artikelnummer": "ART-001",
  "mandant": 1,
  "bestellmenge": 1,
  "positionsart": 1,
  "bezeichnung": "Bezeichnung",
  "positionstext": "Positionstext"
}

Put

Ausgewählte Vorgangsposition bearbeiten:

PUT /Office/CoServiceRestApi/office/auftragspositionen/{auftragsNummer}/{positionsNummer}
{
  "zulieferndemenge": 1,
  "bestellmenge": 5
}

Delete

Ausgewählte Vorgangsposition löschen:

DELETE /Office/CoServiceRestApi/office/auftragspositionen/{auftragsNummer}/{positionsNummer}

Belegdruck (Unterobjekt)

Post

  • Angebot erzeugen:
    POST /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}/documents/angebote/angebot
  • Auftragsbestätigung erzeugen:
    POST /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}/documents/auftragsbestaetigungen/auftragsbestaetigung
  • Lieferavis erzeugen:
    POST /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}/documents/lieferavis/lieferavis
  • Lieferschein erzeugen:
    POST /Office/CoServiceRestApi/office/auftragskoepfe/{auftragsNummer}/documents/lieferscheine/lieferschein

Der folgende Body gilt für alle Belegdrucke:

{
  "druckSteuerungVerwenden": true
}