Balances
How much of the record's amount is outstanding, processing, settled, and canceled. The four balances add up to amount. Each balance is in the currency of amount, and a balance with nothing in it is 0.
Contents
- canceled
-
The part of the amount that was canceled and isn't settled, for example when an invoice is voided. When a partly settled record is canceled, it keeps its
settledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.Type: CurrencyAmount object
Required: Yes
- outstanding
-
The part of the amount that isn't settled and has no settlement in progress. For an invoice, this is what remains to pay. For a credit memo, this is the credit that isn't yet applied. This balance doesn't include
processing.Type: CurrencyAmount object
Required: Yes
- processing
-
The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed. It moves to
settledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.Type: CurrencyAmount object
Required: Yes
- settled
-
The part of the amount that is settled. For an invoice, this is the amount paid or covered by credit memos. For a credit memo, this is the amount applied to invoices. This balance is 0 when nothing is settled yet.
Type: CurrencyAmount object
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: