Zum Inhalt
Integrationen (API / 3rd Party)

Belegs-API

Belege über die Schnittstelle anlegen, übergeben und abrufen: saveDocument, transferDocument, Nummernvergabe, Lagerzuordnung und Idempotenz.

Aktualisiert am 4. Oktober 2026

Die Belegs-API deckt den Lebenszyklus eines Belegs ab: anlegen (saveDocument), Positionen hinzufügen, in Folgebelege übergeben (transferDocument), Status setzen, PDF erzeugen und abrufen.

Grundlagen

  • Ein neuer Beleg braucht Belegart (Kürzel) und Adresse; Belegdatum, Zahlungsbedingung, Preisliste und Lagerplatz werden aus Adresse und Mandant vorbelegt.
  • Jedes saveDocument verbraucht eine Belegnummer, auch für Entwürfe. Verwenden Sie eine eigene Referenz (referenceId), um Wiederholungen zu erkennen.
  • Übergaben per transferDocument folgen den Übergaberegeln; offene Mengen werden geführt.
  • Belege lassen sich per Suche nach Nummer, Belegart, Partner oder Zeitraum abrufen; Positionen und Vorgänger- und Folgebelege sind enthalten.

Unterartikel

  • Lagerung: Prioritäten bei der Bestimmung des Lagerplatzes eines extern gespeicherten Belegs.

Hinweise

  • Anhänge werden über eigene Aufrufe hochgeladen, nicht über saveDocument.
  • Lange Transaktionen bei vielen Positionen: Zeitüberschreitungen im Client großzügig setzen und bei unklarem Ergebnis den Beleg über die Referenz prüfen statt erneut anzulegen.
  • Das Schema der Aufrufe steht in der Tabellenbeschreibung.

Unterartikel

Verwandte Artikel