Solde de facture (invoice_balance)

Projection calculée du reste à payer d’une facture après imputations de paiements et effets des avoirs.

Rôle

Projection calculée du reste à payer d’une facture après imputations de paiements et effets des avoirs.

Cette page décrit le concept fonctionnel canonique. Les endpoints, paramètres HTTP et formats de réponse détaillés appartiennent à la section API & événements.

Nature dans le modèle

Projection Cette vue est calculée à partir de l’état courant. Elle n’a pas d’identifiant propre et ne doit pas être traitée comme une ressource persistante autonome.

Champs clés

Les champs ci-dessous portent les distinctions fonctionnelles les plus importantes de l’objet.

ChampTypeRôle
invoice_idstringFacture dont le solde est calculé.
buyer_idstringAcheteur de la facture.
merchant_idstringMarchand émetteur.
invoice_amount_excluding_tax / invoice_amount_including_taxintegerMontants faciaux de la facture.
payment_applied_amount_excluding_tax / payment_applied_amount_including_taxintegerMontants déjà imputés par des paiements.
credit_note_balance_excluding_tax / credit_note_balance_including_taxintegerEffet net des avoirs applicables à la facture.
balance_excluding_tax / balance_including_taxintegerReste à payer courant.
currencystringDevise commune des montants.
computed_atdatetimeInstant auquel la projection a été calculée.

Relations

ObjetRelationSignification
invoiceFactureLe solde est calculé pour une facture unique.
payment_allocationImputationsLes allocations de paiement réduisent le reste à payer.

Invariants

  • invoice_balance est une projection calculée et non une ressource métier indépendante.
  • Le reste à payer intègre les paiements appliqués et les avoirs pertinents ; il ne se déduit pas du seul amount_including_tax.
  • Une nouvelle imputation ou un nouvel avoir peut modifier immédiatement le solde calculé.