Zum Inhalt

Dokumente erstellen

Diese Anleitung beschreibt, wie Sie Rechnungen und Gutschriften in xTool erstellen oder hochladen — über die Weboberfläche oder die API.

Methoden

Methode Web API
Formular (Modell) Dokumente → Erstellen → Format und Richtung wählen → Formular ausfüllen. POST Upload Modell (JSON-Body).
XML Dokumente → Hochladen → Datei wählen; Format kann angegeben oder automatisch erkannt werden. POST Upload XML mit Datei oder Body.

Ergebnis ist ein Dokument mit einer id. Danach können Sie es versenden (Peppol, E-Mail), anzeigen oder Validierungs-/Konvertierungs-Endpoints nutzen. Siehe Dokumentenmodell und Formate.

Web: Aus Formular erstellen

  1. Dokumente → Erstellen.
  2. Format (z. B. XRechnung UBL, Peppol BIS Billing) und Richtung (ausgehend/eingehend) wählen.
  3. Pflichtfelder ausfüllen (Verkäufer, Käufer, Positionen, Beträge usw.). Die Pflichtfelder hängen vom Format ab.
  4. Speichern. Das Dokument wird erstellt und erscheint in der Liste. Danach können Sie es versenden oder bearbeiten.

Web: XML hochladen

  1. Dokumente → Hochladen.
  2. XML-Datei wählen (oder Inhalt einfügen, falls die Oberfläche das anbietet).
  3. Optional Format angeben; sonst wird es aus der Datei erkannt.
  4. Bestätigen. Das Dokument wird aus dem XML erstellt.

API: Modell hochladen (JSON)

POST-Request an den Upload-Modell-Endpoint mit JSON-Body senden, der dem Formatmodell des gewählten Formats entspricht.

Endpoint: POST /api/v2/documents/upload/model

Header: x-api-key, Content-Type: application/json

Body: JSON gemäß Format (z. B. Basis- oder Minimalmodell). Siehe Formatmodelle und Basis-Modell-Beispiel.

Die Antwort enthält das erstellte Dokument (inkl. id). Diese id können Sie für Versand, Abruf oder Liste nutzen.

API: XML hochladen

POST-Request an den Upload-XML-Endpoint mit der XML-Datei oder dem rohen XML-Body senden.

Endpoint: POST /api/v2/documents/upload/xml

Header: x-api-key, Content-Type: application/xml (oder multipart, wenn Ihr Client eine Datei sendet).

Body: XML-Rechnung oder -Gutschrift in einem unterstützten Format (z. B. XRechnung UBL, Peppol BIS).

Die Antwort enthält das erstellte Dokument (inkl. id). Das Format wird in der Regel aus dem XML erkannt; manche APIs erlauben die explizite Angabe.

Nächste Schritte