POST/v1/finance/invoices

Rechnungen auflisten

finance_invoices

Gibt die Rechnungen, Gutschriften und Belege der Organisation seitenweise zurück, mit Filtern (Zeitraum, Richtung, Kategorie, Geschäftspartner, Währung, Dokumenttyp, bezahlt, überfällig, Prüfung nötig, Suche nach Nummer und Partei), Sortierung sowie dem Betrag in der Berichtswährung mit dem Umrechnungskurs. Nur für den Benutzer sichtbare Dokumente werden berücksichtigt. Um die nächste Seite zu erhalten, übergeben Sie next_cursor als cursor mit denselben Filtern. Erfordert ein Datenprofil mit Zugriff auf Finanzdaten.

Authentifizierung

Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.

Header-Parameter

X-View-Asstring
Nur für API-Schlüssel mit der Rolle admin. Führt die Anfrage mit dem Datenprofil <profile>[:viewer|verifier|editor] aus, zum Beispiel employee:viewer. Der Installationsschlüssel kann diesen Header nicht verwenden (403).

Cookie-Parameter

kb_view_asstring
Cookie des Modus „Ansicht als“ für eine Sitzung. POST /auth/view-as setzt es, DELETE /auth/view-as entfernt es.

Anfragetext

application/json

Objekt: FinanceListRequest

filtersFinanceFilter
date_basisstring
Zulässige Werte: documentpayment
Standard: "document"
orderstring
Zulässige Werte: date_descdate_ascamount_descamount_asc
Standard: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Standard: 100≥ 1, ≤ 1000
cursorstring
languagestring
Sprache der Kategoriebezeichnungen, en|ru.

Antworten

200Eine Seite mit Rechnungen

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: FinanceInvoicePage

invoicesarray of FinanceInvoiceRowerforderlich
totalintegererforderlich
Gesamtzahl der Rechnungen, die den Filtern entsprechen.
next_cursorstring
Cursor der nächsten Seite. Fehlt das Feld, ist dies die letzte Seite.
currencystring
Berichtswährung der Felder reporting (Modus reporting).
warningsarray of string
Warncodes, dieselben wie in FinanceReport.warnings.
has_moreboolean
Ob es eine nächste Seite gibt. Vorhanden, wenn die Anfrage limit oder cursor übergibt.

400Die Anfrage ist ungültig: Ein Parameterwert oder der Zustand des Objekts lässt die Aktion nicht zu (`detail` ist eine Meldung).

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

401Es wurden keine Anmeldedaten gesendet (weder ein Sitzungscookie noch ein API-Schlüssel), oder der Schlüssel wurde nicht gefunden.

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

403Die Aktion ist nicht erlaubt: Die Rolle reicht nicht aus, es besteht kein Zugriff auf die Sammlung oder Karte, die Anfrage läuft im Modus „Ansicht als“, oder die Organisation ist gesperrt oder gelöscht (`detail` ist ein Objekt mit `code: org_suspended | org_deleted`).

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

429Zu viele Anfragen (`api.rate_limited`), das Kontingent der Organisation für die Minute, den Tag oder den Monat ist aufgebraucht (`api.quota_exceeded`; `error.details` enthält `quota`, `limit` und `reset_at`), das Limit der Organisation ist erreicht, oder der Antwortdienst ist ausgelastet (`answers.engine_busy`). Warten Sie die im Header `Retry-After` angegebene Zeit ab.

Antwort-Header

Retry-After
Anzahl der Sekunden, die Sie warten sollten, bevor Sie die Anfrage wiederholen.
RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

503Ein Dienst, von dem diese Anfrage abhängt, ist vorübergehend nicht verfügbar. Versuchen Sie es später erneut.

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

Fehlercodes

Codes, die dieser Endpunkt in error.code zurückgeben kann, zusätzlich zu den allgemeinen Codes jeder Anfrage.

Sichere Wiederholungen

Senden Sie bei jedem POST und PATCH einen Header Idempotency-Key (zum Beispiel eine UUID). Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden gibt die gespeicherte Antwort zurück, statt die Anfrage erneut auszuführen.

Ratenlimits

Antworten enthalten die Header RateLimit und RateLimit-Policy sowie die älteren X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Eine Antwort 429 enthält Retry-After in Sekunden: Warten Sie und versuchen Sie es dann erneut.

← finance · API-Referenz

curl -X POST 'https://api.sursa.com/v1/finance/invoices' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":{"from":"2026-10-24","to":"2026-10-24","directions":["in"]},"date_basis":"document","order":"date_desc"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Ausprobieren

API-Schlüssel

Der Schlüssel bleibt im Speicher dieses Tabs und wird nur an https://api.sursa.com gesendet.

Anfragen wirken auf die echten Daten Ihrer Organisation.

X-View-As header

Idempotency-Key

Ist das Feld leer, wird für jede Anfrage ein neuer Schlüssel erzeugt.

Anfragetext (JSON)