FinancialRecord
An invoice or a credit memo on your account, with the details that are specific to its type.
Contents
- amount
-
The total amount of the financial record, in the currency that the record was issued in. The amount doesn't change as the record is settled.
balancesshows how much of it is in each settlement state.Type: CurrencyAmount object
Required: Yes
- balances
-
How much of
amountis outstanding, processing, settled, and canceled.Type: Balances object
Required: Yes
- businessUnit
-
The AWS business unit that issued the record: its merchant of record and its line of business.
Type: BusinessUnit object
Required: Yes
- details
-
The attributes that exist only for the record's type. The populated member matches
type:invoiceDetailsfor anINVOICE,creditMemoDetailsfor aCREDIT_MEMO.Type: FinancialRecordDetails object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- id
-
The ID that AWS Payments issued for the record, such as
INV-5364-6253-7364-1342. To retrieve the record again, pass this value toGetFinancialRecordorBatchGetFinancialRecordasidentifier.Type: String
Length Constraints: Minimum length of 17. Maximum length of 23.
Pattern:
[A-Z]{2,3}-[0-9]{4}-[0-9]{4}-[0-9]{4}(-[0-9]{4})?Required: Yes
- issuedAt
-
The date and time, in UTC, when this record was issued.
Type: Timestamp
Required: Yes
- settlementStatus
-
Whether the record is open or closed. If you receive a
statusvalue that you don't recognize, use this member to tell open records from closed ones. The following values are valid:-
OPEN– Part of the amount is outstanding or processing. ThestatusisOUTSTANDINGorPROCESSING. -
CLOSED– The whole amount is settled or canceled. ThestatusisSETTLEDorCANCELED.
A
CLOSEDrecord becomesOPENagain if a payment or credit applied to it is reversed. ItsclosedAtis then absent until the record closes again.Type: String
Valid Values:
OPEN | CLOSEDRequired: Yes
-
- status
-
The settlement stage of the record. The following values are valid:
-
OUTSTANDING– Part of the amount isn't settled, and no settlement is in progress on the record. For an invoice,dueStatusshows whether it's due or past due. ThesettlementStatusisOPEN. -
PROCESSING– A settlement of part or all of the amount is in progress, for example a payment that's submitted but not yet confirmed.PROCESSINGtakes precedence overOUTSTANDING: while any part of the amount is processing, the status isPROCESSING, even if another part is still outstanding. ThesettlementStatusisOPEN. -
SETTLED– The whole amount is settled. ThesettlementStatusisCLOSED. -
CANCELED– The record is canceled. The part of the amount that wasn't settled isn't collected or applied. ThesettlementStatusisCLOSED.
Type: String
Valid Values:
OUTSTANDING | PROCESSING | SETTLED | CANCELEDRequired: Yes
-
- type
-
The type of the financial record. The populated member of
detailsmatches this type. The following values are valid:-
INVOICE– An invoice: a bill from AWS. Payments and credit memos applied to the invoice settle it. -
CREDIT_MEMO– A credit memo: a credit issued to your account, for example for a billing correction or a service credit. Applying it to one or more invoices settles it.
Type: String
Valid Values:
INVOICE | CREDIT_MEMORequired: Yes
-
- closedAt
-
The date and time, in UTC, when the record was last closed, that is, when its
statuslast becameSETTLEDorCANCELED. This member is absent while thesettlementStatusisOPEN, including after a closed record reopens.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: