Class FinancialRecord
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FinancialRecord.Builder,FinancialRecord>
An invoice or a credit memo on your account, with the details that are specific to its type.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal CurrencyAmountamount()The total amount of the financial record, in the currency that the record was issued in.final Balancesbalances()How much ofamountis outstanding, processing, settled, and canceled.static FinancialRecord.Builderbuilder()final BusinessUnitThe Amazon Web Services business unit that issued the record: its merchant of record and its line of business.final InstantclosedAt()The date and time, in UTC, when the record was last closed, that is, when itsstatuslast becameSETTLEDorCANCELED.final FinancialRecordDetailsdetails()The attributes that exist only for the record's type.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final Stringid()The ID that Amazon Web Services Payments issued for the record, such asINV-5364-6253-7364-1342.final InstantissuedAt()The date and time, in UTC, when this record was issued.static Class<? extends FinancialRecord.Builder> final SettlementStatusWhether the record is open or closed.final StringWhether the record is open or closed.final FinancialRecordStatusstatus()The settlement stage of the record.final StringThe settlement stage of the record.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final FinancialRecordTypetype()The type of the financial record.final StringThe type of the financial record.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID that Amazon Web Services Payments issued for the record, such as
INV-5364-6253-7364-1342. To retrieve the record again, pass this value toGetFinancialRecordorBatchGetFinancialRecordasidentifier.- Returns:
- The ID that Amazon Web Services Payments issued for the record, such as
INV-5364-6253-7364-1342. To retrieve the record again, pass this value toGetFinancialRecordorBatchGetFinancialRecordasidentifier.
-
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 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.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFinancialRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the financial 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.
-
- See Also:
-
-
typeAsString
The type of the financial 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.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFinancialRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the financial 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.
-
- See Also:
-
-
businessUnit
The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.
- Returns:
- The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.
-
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:
- 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.
-
balances
How much of
amountis outstanding, processing, settled, and canceled.- Returns:
- How much of
amountis outstanding, processing, settled, and canceled.
-
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.If the service returns an enum value that is not available in the current SDK version,
settlementStatuswill returnSettlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsettlementStatusAsString().- Returns:
- 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. -
- See Also:
-
-
settlementStatusAsString
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.If the service returns an enum value that is not available in the current SDK version,
settlementStatuswill returnSettlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsettlementStatusAsString().- Returns:
- 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. -
- 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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFinancialRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
-
-
statusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFinancialRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
-
-
issuedAt
The date and time, in UTC, when this record was issued.
- Returns:
- The date and time, in UTC, when this record was issued.
-
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.- Returns:
- 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.
-
details
The attributes that exist only for the record's type. The populated member matches
type:invoiceDetailsfor anINVOICE,creditMemoDetailsfor aCREDIT_MEMO.- Returns:
- The attributes that exist only for the record's type. The populated member matches
type:invoiceDetailsfor anINVOICE,creditMemoDetailsfor aCREDIT_MEMO.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<FinancialRecord.Builder,FinancialRecord> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-