Was kann die REST-API von Belegschmied?

Die sechs Bereiche

Ausgangsrechnungen. Eine fertige PDF übergeben und daraus eine geprüfte E-Rechnung erzeugen lassen, wahlweise mit direktem Versand. Dazu der lesende Zugriff: alle Ausgangsrechnungen listen, nach Status und Zeitraum filtern, eine einzelne im Detail abrufen.

Eingangsrechnungen. Eine empfangene Rechnung zur Verarbeitung einreichen und die extrahierten Daten strukturiert wieder abholen. Der Eingang ist damit genauso automatisierbar wie der Ausgang, siehe Eingangsrechnungen per API verarbeiten.

Dateien. Zu jeder Rechnung die erzeugte XML, die PDF und den Validierungsbericht. Die PDF gibt es auch als variant=original, also das Dokument, wie es eingeliefert wurde.

Stammdaten. Kunden und Lieferanten lesen, inklusive der Zuordnungen, die beim Verarbeiten entstanden sind.

Protokoll. Das Audit-Log, filterbar nach Objektart. Wer nachvollziehen muss, was wann mit welcher Rechnung passiert ist, holt es hier ab, statt es in der Oberfläche zu suchen.

Workspace und Kontingent. Plan, Standardwährung, Freigabe-Einstellung und der verbrauchte Anteil am Monatskontingent. Damit lässt sich überwachen, bevor eine Grenze erreicht wird.

Wie sie sich anfühlt

Basis-URL ist https://belegschmied.de/api/v1, authentifiziert wird mit einem Bearer-Token (bs_live_…), das Sie in der App unter Einstellungen → REST-API selbst erzeugen und widerrufen. Alle Antworten sind JSON mit snake_case-Feldern, Uploads laufen als multipart/form-data bis 15 MB, Downloads kommen als Binärdaten.

Die Verarbeitung ist asynchron: Der Upload antwortet sofort mit einer conversion_id und einer status_url. Sie fragen den Status ab, statt auf eine lange Antwort zu warten. Sechs Verarbeitungsstatus und sieben Rechnungsstatus sagen jederzeit, woran eine Rechnung gerade hängt, bis hin zu validation_failed, wenn die EN-16931-Prüfung sie abgelehnt hat.

Listen-Endpunkte nehmen einheitlich limit (1 bis 100, Default 50) und offset und liefern die Gesamtzahl mit. Datumsfilter erwarten YYYY-MM-DD.

Wo die vollständige Dokumentation steht

Alle Endpunkte mit Beispielaufrufen, Feldern, Statuswerten, Fehlercodes und Rate-Limits stehen offen im Netz, ohne Konto: REST-API-Dokumentation. Wie ein typischer Ablauf aussieht, zeigt E-Rechnung per API aus PDF.