Entwickler / API

Name: OrbitCashFlow
Author: OrbitCashFlow

Nur-Lesen-REST-API-Referenz zur Integration von Orbit CashFlow.

Einführung

Die öffentliche Orbit-CashFlow-API ist eine Nur-Lesen-REST-API zum Abrufen der Finanzdaten Ihres Unternehmens für externe Systeme. Jede Anfrage gilt für das Unternehmen/den Mandanten, der dem API-Schlüssel zugeordnet ist.

Base URLhttps://orbitcashflow.com/api/v1

Authentifizierung

Senden Sie Ihren API-Schlüssel bei jedem Request im Header x-api-key .

x-api-key: orbit_live_xxx

Unternehmensadmins können Schlüssel unter Einstellungen → Unternehmen → API-Schlüssel.

Der vollständige Schlüssel wird nur einmal bei der Erstellung angezeigt. Kopieren und bewahren Sie ihn sofort sicher auf.
Aktuelle Schlüssel sind nur lesend (read-Scope).

Beispielschlüssel

orbit_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Endpunkte

Alle Endpunkte sind GET-Requests und geben JSON zurück. Hängen Sie die Pfade unten an die Basis-URL an.

Methode	Pfad	Beschreibung	Query-Parameter
`GET`	`/public-api/accounts`	Konten auflisten	`page`params.accounts.page `limit`params.accounts.limit `sortBy`params.accounts.sortBy `sortOrder`params.accounts.sortOrder `search`params.accounts.search `type`Nach Kontotyp filtern. `isActive`true, um nur aktive Konten zurückzugeben. `currency`Nach Währungscode filtern (z. B. TRY, USD, EUR).
`GET`	`/public-api/categories`	Kategorien auflisten	`page`params.categories.page `limit`params.categories.limit `sortBy`params.categories.sortBy `sortOrder`params.categories.sortOrder `search`params.categories.search `type`Nach Kategorietyp filtern (income oder expense). `parentId`Nach übergeordneter Kategorie-ID filtern. `rootOnly`true, um nur Hauptkategorien zurückzugeben. `isActive`true, um nur aktive Kategorien zurückzugeben. `includeSystem`true, um Systemkategorien einzubeziehen.
`GET`	`/public-api/contacts`	Kontakte auflisten	`page`params.contacts.page `limit`params.contacts.limit `sortBy`params.contacts.sortBy `sortOrder`params.contacts.sortOrder `search`params.contacts.search `type`Nach Kontakttyp filtern (customer oder supplier). `isActive`true, um nur aktive Kontakte zurückzugeben. `city`Nach Stadt filtern.
`GET`	`/public-api/budgets`	Budgets auflisten	`page`params.budgets.page `limit`params.budgets.limit `sortBy`params.budgets.sortBy `sortOrder`params.budgets.sortOrder `search`Nach Budgetname suchen. `periodType`Nach Budgetzeitraum filtern. `status`Nach Budgetstatus filtern. `startDateFrom`Nach Startdatum filtern (von), ISO 8601. `startDateTo`Nach Startdatum filtern (bis), ISO 8601.
`GET`	`/public-api/budget-plans`	Unternehmensbudgetpläne (V2) auflisten	—
`GET`	`/public-api/budget-plans/:planId/lines`	Zeilen eines Budgetplans nach Zeitraum und Abteilung exportieren	`versionId`Eine bestimmte Planversion; ohne Angabe wird die neueste Version verwendet.
`GET`	`/public-api/invoices`	Kundenrechnungen auflisten	`skip`Anzahl der zu überspringenden Datensätze. `take`Maximale Anzahl zurückgegebener Datensätze. `status`Nach Rechnungsstatus filtern.
`GET`	`/public-api/transactions`	Transaktionen auflisten	`page`params.transactions.page `limit`params.transactions.limit `sortBy`params.transactions.sortBy `sortOrder`params.transactions.sortOrder `search`params.transactions.search `accountId`Nach Konto-ID filtern. `categoryId`Nach Kategorie-ID filtern. `contactId`Nach Kontakt-ID filtern. `type`Nach Transaktionstyp filtern. `status`Nach Transaktionsstatus filtern. `statuses`Nach mehreren Status filtern (kommagetrennt). `startDate`Nach Startdatum filtern, ISO 8601. `endDate`Nach Enddatum filtern, ISO 8601. `minAmount`Mindestbetrag. `maxAmount`Höchstbetrag. `tags`Nach Tags filtern (kommagetrennt oder wiederholt). `isRecurring`true, um nur wiederkehrende Transaktionen zurückzugeben. `orgUnitIds`Nach Abteilungs-IDs filtern (kommagetrennt).
`GET`	`/public-api/transactions/:id`	Einzelne Transaktion abrufen	—

Fehlerantworten

Die API gibt standardmäßige HTTP-Statuscodes zurück.

Status	Meaning
`401`	Fehlender, ungültiger oder widerrufener API-Schlüssel.
`403`	API-Schlüssel hat nicht den erforderlichen Scope.
`404`	Ressource im Unternehmen/Mandanten des Schlüssels nicht gefunden.

Beispielanfragen

Kopieren Sie die folgenden Befehle. Ersetzen Sie orbit_live_xxx durch Ihren eigenen API-Schlüssel.

List accounts

curl -H "x-api-key: orbit_live_xxx" https://orbitcashflow.com/api/v1/public-api/accounts

List transactions (paginated)

curl -H "x-api-key: orbit_live_xxx" "https://orbitcashflow.com/api/v1/public-api/transactions?page=1&limit=50"

Get a single transaction

curl -H "x-api-key: orbit_live_xxx" https://orbitcashflow.com/api/v1/public-api/transactions/00000000-0000-0000-0000-000000000000

Webhooks

Webhooks senden Echtzeit-Ereignisbenachrichtigungen an von Ihnen registrierte Endpunkte. Unternehmensadmins können Webhooks unter Einstellungen → Unternehmen → Webhooks erstellen und verwalten.

Ereignistypen

Wählen Sie beim Registrieren eines Webhooks einen oder mehrere der folgenden Ereignistypen:

transaction.created Wird gesendet, wenn eine Transaktion erstellt wird.
invoice.created Wird gesendet, wenn eine Rechnung erstellt wird.
budget.created Wird gesendet, wenn ein Budget erstellt wird.

Payload

Jede Zustellung ist ein JSON-POST mit dieser Struktur:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "event": "transaction.created",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "data": {}
}

Header

Jede Anfrage enthält die folgenden Header:

X-Orbit-Event: transaction.createdX-Orbit-Signature: sha256=...

Signaturprüfung

Verifizieren Sie Zustellungen, indem Sie einen HMAC-SHA256 des Raw-Request-Bodys mit Ihrem Webhook-Secret berechnen.

const crypto = require('crypto');

const signature = crypto
  .createHmac('sha256', secret)
  .update(rawBody)
  .digest('hex');

// Compare signature with the value after "sha256=" in X-Orbit-Signature

Vergleichen Sie den berechneten Hex-Digest mit dem Wert nach sha256= im X-Orbit-Signature-Header.