Factures
Exige une clé API — voir Authentification. En lecture seule (GET).
Lister les factures
Section intitulée « Lister les factures »GET /v1/invoicesParamètres de requête
Section intitulée « Paramètres de requête »| Paramètre | Type | Défaut | Notes |
|---|---|---|---|
limit |
integer | 50 |
Max 200. |
offset |
integer | 0 |
|
status |
string | — | Correspondance exacte (p. ex. paid, overdue). Omettez-le pour renvoyer les factures dans n’importe quel statut. |
Les résultats sont triés du plus récent au plus ancien par date de création, mais notez que l’horodatage de création lui-même n’est pas inclus dans les champs de la réponse (voir ci-dessous).
Exemple de requête
Section intitulée « Exemple de requête »curl -H "Authorization: Bearer lk_YOUR_KEY" \ "https://tenant.logistall.cloud/api/v1/invoices?status=overdue&limit=2"Exemple de réponse
Section intitulée « Exemple de réponse »[ { "id": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a", "invoiceNumber": "INV-00214", "status": "overdue", "totalAmount": 48250.5, "paidAmount": 20000, "currencyCode": "MAD", "invoiceDate": "2026-06-12T00:00:00.000Z", "dueDate": "2026-07-02T00:00:00.000Z" }, { "id": "6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b", "invoiceNumber": "INV-00198", "status": "overdue", "totalAmount": 15600, "paidAmount": 0, "currencyCode": "MAD", "invoiceDate": "2026-06-05T00:00:00.000Z", "dueDate": "2026-06-25T00:00:00.000Z" }]status est l’une des valeurs draft, sent, partial, paid, overdue, void, disputed. totalAmount et paidAmount sont des nombres (pas des chaînes), dans la devise de currencyCode — la devise de base de la plateforme est le MAD, même si les enregistrements d’un locataire peuvent en utiliser d’autres.
Champs renvoyés
Section intitulée « Champs renvoyés »| Champ | Notes |
|---|---|
id |
|
invoiceNumber |
|
status |
|
totalAmount |
numérique |
paidAmount |
numérique |
currencyCode |
|
invoiceDate |
|
dueDate |
Il n’y a pas de champ createdAt sur ce point de terminaison (il ne sert en interne qu’à l’ordre de tri), ni de détail des lignes — pour une facture complète avec ses lignes et son PDF, voir la page Finance du Guide utilisateur.
| Statut | Corps | Quand |
|---|---|---|
401 |
voir Authentification | Clé manquante/invalide. |
500 |
{ "error": "Database error" } |
Erreur serveur inattendue. |
Il n’existe pas actuellement de point de terminaison facture individuelle (GET /v1/invoices/:id) — uniquement la liste.