Développeurs / API

Name: OrbitCashFlow
Author: OrbitCashFlow

Référence de l'API REST en lecture seule pour intégrer Orbit CashFlow.

Introduction

L'API publique d'Orbit CashFlow est une API REST en lecture seule permettant d'extraire les données financières de votre société vers des systèmes externes. Chaque requête est limitée à la société / au locataire associé à la clé API.

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

Authentification

Envoyez votre clé API dans l'en-tête x-api-key à chaque requête.

x-api-key: orbit_live_xxx

Les administrateurs de la société peuvent créer et révoquer des clés dans Paramètres → Société → Clés API.

La clé complète n'est affichée qu'une seule fois, à la création. Copiez-la et conservez-la immédiatement en lieu sûr.
Les clés actuelles sont en lecture seule (portée « read »).

Exemple de clé

orbit_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Points de terminaison

Tous les points de terminaison sont des requêtes GET et renvoient du JSON. Ajoutez les chemins ci-dessous à l'URL de base.

Méthode	Chemin	Description	Paramètres de requête
`GET`	`/public-api/accounts`	Lister les comptes	`page`params.accounts.page `limit`params.accounts.limit `sortBy`params.accounts.sortBy `sortOrder`params.accounts.sortOrder `search`params.accounts.search `type`Filtrer par type de compte. `isActive`true pour ne renvoyer que les comptes actifs. `currency`Filtrer par code devise (ex. TRY, USD, EUR).
`GET`	`/public-api/categories`	Lister les catégories	`page`params.categories.page `limit`params.categories.limit `sortBy`params.categories.sortBy `sortOrder`params.categories.sortOrder `search`params.categories.search `type`Filtrer par type de catégorie (recette ou dépense). `parentId`Filtrer par identifiant de catégorie parente. `rootOnly`true pour ne renvoyer que les catégories de premier niveau. `isActive`true pour ne renvoyer que les catégories actives. `includeSystem`true pour inclure les catégories système.
`GET`	`/public-api/contacts`	Lister les contacts	`page`params.contacts.page `limit`params.contacts.limit `sortBy`params.contacts.sortBy `sortOrder`params.contacts.sortOrder `search`params.contacts.search `type`Filtrer par type de contact (client ou fournisseur). `isActive`true pour ne renvoyer que les contacts actifs. `city`Filtrer par ville.
`GET`	`/public-api/budgets`	Lister les budgets	`page`params.budgets.page `limit`params.budgets.limit `sortBy`params.budgets.sortBy `sortOrder`params.budgets.sortOrder `search`Rechercher par nom de budget. `periodType`Filtrer par type de période budgétaire. `status`Filtrer par statut de budget. `startDateFrom`Filtrer par date de début (à partir de), ISO 8601. `startDateTo`Filtrer par date de début (jusqu'à), ISO 8601.
`GET`	`/public-api/budget-plans`	Lister les plans budgétaires d'entreprise (V2)	—
`GET`	`/public-api/budget-plans/:planId/lines`	Exporter les lignes d'un plan budgétaire par période et par département	`versionId`Une version de plan spécifique ; la dernière version est utilisée si omise.
`GET`	`/public-api/invoices`	Lister les factures clients	`skip`Nombre d'enregistrements à ignorer. `take`Nombre maximal d'enregistrements à renvoyer. `status`Filtrer par statut de facture.
`GET`	`/public-api/transactions`	Lister les opérations	`page`params.transactions.page `limit`params.transactions.limit `sortBy`params.transactions.sortBy `sortOrder`params.transactions.sortOrder `search`params.transactions.search `accountId`Filtrer par identifiant de compte. `categoryId`Filtrer par identifiant de catégorie. `contactId`Filtrer par identifiant de contact. `type`Filtrer par type d'opération. `status`Filtrer par statut d'opération. `statuses`Filtrer par plusieurs statuts (séparés par des virgules). `startDate`Filtrer par date de début, ISO 8601. `endDate`Filtrer par date de fin, ISO 8601. `minAmount`Montant minimum. `maxAmount`Montant maximum. `tags`Filtrer par étiquettes (séparées par des virgules ou répétées). `isRecurring`true pour ne renvoyer que les opérations récurrentes. `orgUnitIds`Filtrer par identifiants de département (séparés par des virgules).
`GET`	`/public-api/transactions/:id`	Obtenir une opération par son identifiant	—

Réponses d'erreur

L'API renvoie les codes de statut HTTP standard.

Status	Meaning
`401`	Clé API manquante, invalide ou révoquée.
`403`	La clé API n'a pas la portée requise.
`404`	Ressource introuvable dans la société / le locataire de la clé.

Exemples de requêtes

Copiez-collez les commandes ci-dessous. Remplacez orbit_live_xxx par votre propre clé API.

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

Les webhooks envoient des notifications d'événements en temps réel aux points de terminaison que vous enregistrez. Les administrateurs de la société peuvent les gérer dans Paramètres → Société → Webhooks.

Types d'événements

Choisissez un ou plusieurs types d'événements lors de l'enregistrement d'un webhook :

transaction.created Envoyé lorsqu'une opération est créée.
invoice.created Envoyé lorsqu'une facture est créée.
budget.created Envoyé lorsqu'un budget est créé.

Charge utile

Chaque livraison est une requête POST JSON de cette forme :

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

En-têtes

Chaque requête comporte les en-têtes suivants :

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

Vérification de la signature

Vérifiez les livraisons en calculant un HMAC-SHA256 du corps brut de la requête avec le secret de votre webhook.

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

Comparez l'empreinte hexadécimale à la valeur qui suit sha256= dans l'en-tête X-Orbit-Signature.