Interface FinancialRecordSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<FinancialRecordSummary.Builder,,FinancialRecordSummary> SdkBuilder<FinancialRecordSummary.Builder,,FinancialRecordSummary> SdkPojo
- Enclosing class:
FinancialRecordSummary
-
Method Summary
Modifier and TypeMethodDescriptiondefault FinancialRecordSummary.Builderamount(Consumer<CurrencyAmount.Builder> amount) The total amount of the financial record, in the currency that the record was issued in.amount(CurrencyAmount amount) The total amount of the financial record, in the currency that the record was issued in.default FinancialRecordSummary.Builderbalances(Consumer<Balances.Builder> balances) How much ofamountis outstanding, processing, settled, and canceled.How much ofamountis outstanding, processing, settled, and canceled.default FinancialRecordSummary.BuilderbusinessUnit(Consumer<BusinessUnit.Builder> businessUnit) The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.businessUnit(BusinessUnit businessUnit) The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.The date and time, in UTC, when the record was last closed, that is, when itsstatuslast becameSETTLEDorCANCELED.The ID that Amazon Web Services Payments issued for the record.The date and time, in UTC, when this record was issued.settlementStatus(String settlementStatus) Whether the record is open or closed.settlementStatus(SettlementStatus settlementStatus) Whether the record is open or closed.The settlement stage of the record.status(FinancialRecordStatus status) The settlement stage of the record.The type of the financial record.type(FinancialRecordType type) The type of the financial record.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
id
The ID that Amazon Web Services Payments issued for the record. To retrieve the full record, pass this value to
GetFinancialRecordorBatchGetFinancialRecordasidentifier.- Parameters:
id- The ID that Amazon Web Services Payments issued for the record. To retrieve the full record, pass this value toGetFinancialRecordorBatchGetFinancialRecordasidentifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of the financial record. On the full record, the populated member of
detailsmatches this type. The following values are valid:-
INVOICE– An invoice: a bill from Amazon Web Services. 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.
- Parameters:
type- The type of the financial record. On the full record, the populated member ofdetailsmatches this type. The following values are valid:-
INVOICE– An invoice: a bill from Amazon Web Services. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
The type of the financial record. On the full record, the populated member of
detailsmatches this type. The following values are valid:-
INVOICE– An invoice: a bill from Amazon Web Services. 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.
- Parameters:
type- The type of the financial record. On the full record, the populated member ofdetailsmatches this type. The following values are valid:-
INVOICE– An invoice: a bill from Amazon Web Services. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
businessUnit
The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.
- Parameters:
businessUnit- The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
businessUnit
The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.
This is a convenience method that creates an instance of theBusinessUnit.Builderavoiding the need to create one manually viaBusinessUnit.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobusinessUnit(BusinessUnit).- Parameters:
businessUnit- a consumer that will call methods onBusinessUnit.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of thebalancesshows how much of it is in each settlement state.CurrencyAmount.Builderavoiding the need to create one manually viaCurrencyAmount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toamount(CurrencyAmount).- Parameters:
amount- a consumer that will call methods onCurrencyAmount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
balances
How much of
amountis outstanding, processing, settled, and canceled.- Parameters:
balances- How much ofamountis outstanding, processing, settled, and canceled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
balances
How much of
This is a convenience method that creates an instance of theamountis outstanding, processing, settled, and canceled.Balances.Builderavoiding the need to create one manually viaBalances.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobalances(Balances).- Parameters:
balances- a consumer that will call methods onBalances.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
settlementStatus- Whether the record is open or closed. If you receive astatusvalue 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.- Parameters:
settlementStatus- Whether the record is open or closed. If you receive astatusvalue 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
issuedAt
The date and time, in UTC, when this record was issued.
- Parameters:
issuedAt- The date and time, in UTC, when this record was issued.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
closedAt- The date and time, in UTC, when the record was last closed, that is, when itsstatuslast becameSETTLEDorCANCELED. This member is absent while thesettlementStatusisOPEN, including after a closed record reopens.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-