Auftrag anlegen (REST API)

Diese Artikel könnten Sie auch interessieren:
Aufträge auflisten

POST Aufruf an api/order

Beispiel Anlage einer Rechnung mit zwei Positionen.
Die erste Position wird aus dem Artikel mit der Artikelnummer A01 generiert. Bei der zweiten Position werden alle Felder übergeben, sie ist nicht mit einem Artikel verknüpft.

{
   "Subject":"API Test",
   "IntroductoryText":null,
   "ConclusionText":null,
   "Number":null,
   "Date":null,
   "OrderType":"Invoice",
   "OrderState":null,
   "TimeOfSupply":null,
   "TimeOfSupplyEnd":null,
   "EstimatedConfirmation":null,
   "ConfirmationProbability":null,
   "ReferenceNumber":null,
   "Contact":"geyer@meier.com",
   "ContactId":null,
   "Person":null,
   "PersonId":null,
   "DeliveryTerms":null,
   "DeliveryDate":null,
   "PaymentTerms":null,
   "Agent":null,
   "AgentId":null,
   "Items":[
      {
         "NetPurchasePrice":null,
         "NetSalePrice":null,
         "Quantity":2,
         "Designation":null,
         "ProductNumber":"A01",
         "TaxRate":null,
         "Unit":null,
         "ProductGroup":null,
         "LongDescription":null
      },
      {
         "NetPurchasePrice":2.99,
         "NetSalePrice":3.99,
         "Quantity":3,
         "Designation":"Spezielle Dienstleistung",
         "ProductNumber":null,
         "TaxRate":19,
         "Unit":"Stück",
         "ProductGroup":"Dienstleistungen",
         "LongDescription":"Erste Zeile\r\nZweite Zeile"
      }
   ],
   "CustomField":null
}

Felder, die nicht gefüllt werden sollen, können weggelassen werden im JSON.

Felder:

Feld Typ Bedeutung
Subject* Text Kurze, einzeilige Bezeichnung des Auftrags
IntroductoryText Memo Ausführlicher, mehrzeiliger Text, der am Anfang des Auftrags erscheint.
ConclusionText Memo Ausführlicher, mehrzeiliger Text, der am Ende des Auftrags erscheint.
Date DateTime Auftragsdatum (z.B. Rechnungsdatum)
Falls leer, wird automatisch das aktuelle Datum gesetzt.
OrderType* Enum Auftragsart mit folgenden möglichen Werten:
  • Offer (Angebot)
  • Confirmation (Auftragsbestätigung)
  • Invoice (Rechnung)
  • DeliveryNote (Lieferschein)
  • CreditNote (Gutschrift)
  • Booking (Bestellung)
  • IncomingInvoice (Eingangsrechnung)
  • Nur im WebAccess: Opportunity (Auftragschance)
OrderState Enum Aktueller Auftragsstatus
Die möglichen Werte sind abhängig von der Auftragsart:
  • Status der Auftragsart Offer (Angebot):
    • Open (Offen)
    • Confirmed (Bestätigt)
    • Rejected (Abgelehnt)
    • Obsolete (Weitergeführt)
  • Status der Auftragsarten Invoice (Rechnung) und IncomingInvoice (Eingangsrechnung):
    • Open (Offen)
    • Paid (Bezahlt)
    • FirstReminder (Zahlungserinnerung)
    • SecondReminder (Mahnung)
    • FinalDemandForPayment (Mahnbescheid)
    • WrittenOff (Ausgebucht)
    • Canceled (Storniert)
  • Status der Auftragsart CreditNote (Gutschrift):
    • Open (Offen)
    • Paid (Bezahlt)
  • Status der Auftragsart Booking (Bestellung):
    • Open (Offen)
    • Delivered (Geliefert)
    • Canceled (Storniert)
Die Auftragsarten Auftragsbestätigung und Lieferschein haben keinen Status.
Falls leer, wird automatisch der Standard-Status der Auftragsart gesetzt (normalerweise Offen).
TimeOfSupply Date Leistungsdatum
TimeOfSupplyEnd Date Ende des Leistungszeitraums. Ist dieses Datum gesetzt, wird TimeOfSupply zum Beginn des Leistungszeitraums.
EstimatedConfirmation Date Geschätztes Eingangsdatum (bei Angeboten)
ConfirmationProbability Float Wahrscheinlichkeit in % (bei Angeboten)
ReferenceNumber Text Bestellnummer
Agent
AgentId
Text
ID
Betreuer (Sachbearbeiter) des Auftrags
Es kann entweder die ID des Benutzers übergeben werden (AgentId) oder die E-Mail-Adresse (Agent).
Wenn leer, wird der aktuelle Benutzer gesetzt.
Contact
ContactId
Person
PersonId
Text
ID
Text
ID
Es kann über ContactId oder PersonId die ID eines Kontaktes übergeben werden. 
Im Feld Contact kann auch die E-Mail-Adresse eines Kontaktes übergeben werden.
Um einen Auftrag anlegen zu können, muss ein gültiger Kontakt gesetzt sein.
Items* Array

Bei den Auftragspositionen kann entweder Quantity und ProductNumber übergeben werden. In diesem Fall werden alle Informationen aus dem Artikel gezogen.
Alternativ kann ProductNumber weggelassen werden und die Felder der Auftragsposition im JSON übergeben werden.
GrossSalePrice (Brutto Verkaufspreis) wird immer automatisch berechnet.

Weitere Details zu den Feldern siehe unten.

PaymentTerms Text Zahlungsbedingungen
DeliveryTerms Text  Lieferbedingungen
DeliveryDate Text  Lieferdatum 
CustomField Dictionary Die eigenen Felder zum Auftrag.

 

Felder der Auftragspositionen (Items)

Feld Typ Bedeutung
Quantity Float Menge
Unit Text  Einheit
NetSalePrice Currency Einzelpreis netto
NetPurchasePrice Currency Einkaufspreis netto (nur WebAccess)
ProductNumber Text

Artikelnummer

Wird eine Artikelnummer übergeben, so werden die Felder der Auftragsposition aus dem Artikel gefüllt. Lediglich die Quantity muss zusätzlich übergeben werden.

Designation Text Artikelbezeichnung (einzeilig)
LongDescription Text  Mehrzeilige Artikelbeschreibung
ProductGroup Text 

Warengruppe

Muss mit dem Namen einer bestehenden Warengruppe übereinstimmen.

TaxRate Float Steuersatz in %

In Kürze wird auch unterstützt:

Feld Typ Bedeutung
ItemType Enum

Art der Position

Mögliche Werte:
Item
Subtotal (Zwischensumme)

DiscountPercentage Float Rabatt in %
DiscountAbsolute Currency Rabattbetrag in Auftragswährung

* Pflichtfelder, bei denen Werte übergeben werden müssen

Haben Sie Fragen? Anfrage einreichen

Kommentare

Powered by Zendesk