API-Referenz

Dieser Einstieg beschreibt ausgewählte vorhandene Lesewege. Die API liegt auf der Domain deiner Firma unter /api/v1. Die öffentliche Startseite hat keinen Mandantenkontext und liefert dort keine Firmendaten.

Vollständige Referenz aller Operationen OpenAPI-Datei als JSON

Zugang und erster Aufruf

Melde dich bei deiner Firma an und öffne Einstellungen → API-Schlüssel. Erstelle für einen lesenden Einstieg einen Schlüssel mit „Nur lesen“. Bewahre ihn sicher auf; er wird nur einmal angezeigt. Deine Benutzerrolle begrenzt die Rechte zusätzlich.

Sende den Schlüssel im Header Authorization: Bearer <API-Schlüssel> an deine Firmendomain. Verwende Accept: application/json und für deutsche Meldungen Accept-Language: de. Schreibe den Schlüssel nicht in die URL. Der erste lesende Aufruf ist GET /api/v1/me.

GET /api/v1/me Liefert die zugehörige Firma und den angemeldeten Benutzer. Ohne gültigen Zugang erhältst du keine Firmendaten.

Diese Seite führt keine API-Aufrufe aus und enthält keinen echten Schlüssel. API-Schlüssel werden in den Einstellungen oder über die Konsole erstellt, nicht über einen schreibenden API-Aufruf. App-Anmeldung und MCP-OAuth sind eigene Anmeldewege.

Belege und Rechnungen lesen

GET /api/v1/documents Listet abgelegte Belege. Das Vorhandensein eines Belegs bedeutet weder OCR-Erkennung noch Festschreibung.

GET /api/v1/documents/{id} Zeigt den Beleg und vorhandene Auslesedaten. Ein abgelegtes Foto oder ein Scan belegt allein noch keine OCR-Erkennung.

GET /api/v1/documents/{id}/file Lädt die gespeicherte Belegdatei herunter.

GET /api/v1/invoices Listet Rechnungen mit ihrem jeweiligen Status; ein Entwurf ist noch keine ausgestellte Rechnung.

GET /api/v1/invoices/{id}/file Lädt die gespeicherte ausgestellte Rechnung. Mit ?format=xml erhältst du den eingebetteten XML-Datensatz. Allgemeines EN-16931-XML ist nicht automatisch XRechnung; PDF/A-Konformität folgt nicht allein aus dem PDF-Format. Maßgeblich ist das geprüfte Ausgabeprofil.

Bank und Auswertungen lesen

GET /api/v1/bank/accounts Listet erfasste Bankkonten. Ein Eintrag ist kein Nachweis eines erfolgreichen Bankabrufs oder der Unterstützung durch FinTS.

GET /api/v1/bank/transactions Listet eingelesene Umsätze. FinTS, Stripe und Dateiimport sind getrennte Wege; Finom ist über FinTS nicht angebunden.

GET /api/v1/reports/month Liefert Kennzahlen des laufenden Monats, keine fertige EÜR oder GuV.

GET /api/v1/reports/trial-balance Liefert Summen und Salden festgeschriebener Buchungen. Optionaler Stichtag: as_of im Format JJJJ-MM-TT.

GET /api/v1/reports/vat Liefert Zahlen zur Umsatzsteuer-Vorbereitung, keine direkte Steuerabgabe. Erforderlich sind from und to im Format JJJJ-MM-TT; to darf nicht vor from liegen.

Sicher schreiben und abgleichen

Wichtige Schreibaktionen gibt es zusätzlich unter /api/v1/idempotent. Dort ist der Header Idempotency-Key Pflicht: Dieselbe Anfrage mit demselben Schlüssel wirkt nur einmal und liefert wieder dieselbe Antwort. Geht eine Antwort verloren, wiederhole die Anfrage mit demselben Schlüssel.

GET /api/v1/sync liefert den Bestand seitenweise. Folge nextCursor, bis windowComplete wahr ist, danach liefert der Cursor nur noch die Änderungen. Speichere ihn zusammen mit den Daten. Eine angefangene Folge von Seiten läuft nach 24 Stunden ab, ein abgeschlossener Stand nach 30 Tagen, dann beginnt der Abgleich neu.

Über /api/v1/webhooks abonnierst du Fachereignisse an eine eigene HTTPS-Adresse. Jede Zustellung trägt die Kopfzeilen Webhook-Id, Webhook-Timestamp und Webhook-Signature. Die Signatur ist v1= und ein hexadezimaler HMAC-SHA256 über Zeitstempel, Punkt, Webhook-Id, Punkt und den unveränderten Inhalt, mit dem Geheimnis, das du beim Anlegen einmal siehst. Weise Zustellungen ab, deren Zeitstempel mehr als 300 Sekunden abweicht.

Schreiben und MCP

Schreibende API-Aufrufe und MCP-Werkzeuge brauchen passende Rechte. Sie können unmittelbar buchen oder ausstellen; die Bestätigung des Webassistenten ist kein allgemeiner Schutz für eigene Integrationen. Dieser Leseeinstieg enthält deshalb keine schreibenden Beispiele.

Der Kontoauszugsimport unterstützt MT940 und CAMT.053 über POST /api/v1/bank/statements oder das MCP-Werkzeug import-statement. Er ist ein Dateiimport und keine Bankanbindung. API- und MCP-Umfang sind nicht mit jeder Webfunktion gleichzusetzen.

MCP erreichst du auf der Firmendomain unter /mcp. Verbindungen richtest du über Einstellungen → MCP-Verbindungen oder mit einem API-Schlüssel ein. Rechte gelten zusätzlich zu deiner Benutzerrolle.

Hilfe und Funktionsumfang Zur Startseite