Invoice balance (invoice_balance)
Computed projection of the amount remaining to be paid on an invoice after payment allocations and credit-note effects.
Role
Computed projection of the amount remaining to be paid on an invoice after payment allocations and credit-note effects.
This page describes the canonical functional concept. Detailed endpoints, HTTP parameters, and response formats belong in the API & events.
Nature in the model
Projection This view is calculated from current state. It has no identifier of its own and must not be treated as an independent persisted resource.
Key fields
The fields below capture the most important functional distinctions of the object.
| Champ | Type | Role |
|---|---|---|
invoice_id | string | Invoice whose balance is calculated. |
buyer_id | string | Invoice buyer. |
merchant_id | string | Issuing merchant. |
invoice_amount_excluding_tax / invoice_amount_including_tax | integer | Face amounts of the invoice. |
payment_applied_amount_excluding_tax / payment_applied_amount_including_tax | integer | Amounts already allocated through payments. |
credit_note_balance_excluding_tax / credit_note_balance_including_tax | integer | Net effect of credit notes applicable to the invoice. |
balance_excluding_tax / balance_including_tax | integer | Current amount remaining to be paid. |
currency | string | Common currency of the amounts. |
computed_at | datetime | Time at which the projection was calculated. |
Relationships
| Objet | Relation | Signification |
|---|---|---|
invoice | Invoice | The balance is calculated for a single invoice. |
payment_allocation | Imputations | Payment allocations reduce the amount remaining to be paid. |
Invariants
- `invoice_balance` is a computed projection, not an independent business resource.
- The amount remaining to be paid includes applied payments and relevant credit notes; it cannot be derived from `amount_including_tax` alone.
- A new allocation or credit note may immediately change the calculated balance.