Invoices

Facture client avec cycle de vie, état de règlement et litiges indépendants.

Objet métier

Vue d’ensemble

Les endpoints invoices couvrent la création, les transitions de facture, les documents attachés et les relations avec commandes, lignes et litiges.

Voir aussi la page du modèle métier invoice pour la sémantique, les relations et le cycle de vie fonctionnel.

Contrat JSON

Les réponses utilisent l’identifiant préfixé inv_ et le champ object pour rendre le type explicite.

buyer_idstring

Identifiant de la company de l’acheteur, quand applicable.

statusenum

Cycle de vie du document : draft, issued, sent, received, cancelled ou written_off.

settlement_statusenum

État du règlement : unpaid, partially_paid ou paid.

amount_excluding_tax / amount_tax / amount_including_taxnumber

Montants de facture. amount_including_tax doit égaler amount_excluding_tax + amount_tax.

currencystring

Devise ISO du montant.

due_datedate

Date d’échéance.

documentobject

Document de facture attaché via les endpoints document.

REST

Méthode	Endpoint	Usage
POST	`/v1/invoices`	Créer une facture.
GET	`/v1/invoices`	Lister les factures, avec filtres merchant_id, buyer_id, source_reference, type, status ou settlement_status.
GET	`/v1/invoices/eligible-allocation`	Lister les factures éligibles à une allocation de paiement.
GET	`/v1/invoices/{id}`	Récupérer une facture.
POST	`/v1/invoices/{id}`	Mettre à jour une facture.
POST	`/v1/invoices/{id}/issue`	Émettre une facture.
POST	`/v1/invoices/{id}/send`	Marquer une facture comme envoyée.
POST	`/v1/invoices/{id}/received`	Marquer une facture comme reçue.
POST	`/v1/invoices/{id}/cancel`	Annuler une facture.
POST	`/v1/invoices/{id}/document`	Attacher ou remplacer le document.
GET	`/v1/invoices/{id}/document`	Télécharger ou consulter le document.
GET	`/v1/invoices/{id}/orders`	Lister les commandes liées.
GET	`/v1/invoices/{id}/line-items`	Lister les lignes de facture.
GET	`/v1/invoices/{id}/disputes`	Lister les litiges rattachés.

Événements

Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.

invoice.issuedinvoice.sentinvoice.receivedinvoice.partially_paidinvoice.paidinvoice.disputedinvoice.cancelled

Comportement

Les actions issue, send, received et cancel font évoluer le cycle de vie ; les allocations font évoluer settlement_status sans modifier status.
Les documents sont exposés via des endpoints dédiés afin de garder le contrat JSON de la facture stable.