Class FinancialRecordSummary

java.lang.Object
software.amazon.awssdk.services.payments.model.FinancialRecordSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FinancialRecordSummary.Builder,FinancialRecordSummary>

@Generated("software.amazon.awssdk:codegen") public final class FinancialRecordSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FinancialRecordSummary.Builder,FinancialRecordSummary>

A financial record as ListFinancialRecords returns it, without the details that are specific to its type. To get the full record, use GetFinancialRecord or BatchGetFinancialRecord.

See Also:
  • Method Details

    • id

      public final String id()

      The ID that Amazon Web Services Payments issued for the record. To retrieve the full record, pass this value to GetFinancialRecord or BatchGetFinancialRecord as identifier.

      Returns:
      The ID that Amazon Web Services Payments issued for the record. To retrieve the full record, pass this value to GetFinancialRecord or BatchGetFinancialRecord as identifier.
    • type

      public final FinancialRecordType type()

      The type of the financial record. On the full record, the populated member of details matches 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, type will return FinancialRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the financial record. On the full record, the populated member of details matches 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

      public final String typeAsString()

      The type of the financial record. On the full record, the populated member of details matches 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, type will return FinancialRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the financial record. On the full record, the populated member of details matches 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

      public final BusinessUnit 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

      public final CurrencyAmount 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. balances shows 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. balances shows how much of it is in each settlement state.
    • balances

      public final Balances balances()

      How much of amount is outstanding, processing, settled, and canceled.

      Returns:
      How much of amount is outstanding, processing, settled, and canceled.
    • settlementStatus

      public final SettlementStatus settlementStatus()

      Whether the record is open or closed. If you receive a status value 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. The status is OUTSTANDING or PROCESSING.

      • CLOSED – The whole amount is settled or canceled. The status is SETTLED or CANCELED.

      A CLOSED record becomes OPEN again if a payment or credit applied to it is reversed. Its closedAt is then absent until the record closes again.

      If the service returns an enum value that is not available in the current SDK version, settlementStatus will return SettlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from settlementStatusAsString().

      Returns:
      Whether the record is open or closed. If you receive a status value 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. The status is OUTSTANDING or PROCESSING.

      • CLOSED – The whole amount is settled or canceled. The status is SETTLED or CANCELED.

      A CLOSED record becomes OPEN again if a payment or credit applied to it is reversed. Its closedAt is then absent until the record closes again.

      See Also:
    • settlementStatusAsString

      public final String settlementStatusAsString()

      Whether the record is open or closed. If you receive a status value 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. The status is OUTSTANDING or PROCESSING.

      • CLOSED – The whole amount is settled or canceled. The status is SETTLED or CANCELED.

      A CLOSED record becomes OPEN again if a payment or credit applied to it is reversed. Its closedAt is then absent until the record closes again.

      If the service returns an enum value that is not available in the current SDK version, settlementStatus will return SettlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from settlementStatusAsString().

      Returns:
      Whether the record is open or closed. If you receive a status value 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. The status is OUTSTANDING or PROCESSING.

      • CLOSED – The whole amount is settled or canceled. The status is SETTLED or CANCELED.

      A CLOSED record becomes OPEN again if a payment or credit applied to it is reversed. Its closedAt is then absent until the record closes again.

      See Also:
    • status

      public final FinancialRecordStatus 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, dueStatus shows whether it's due or past due. The settlementStatus is OPEN.

      • PROCESSING – A settlement of part or all of the amount is in progress, for example a payment that's submitted but not yet confirmed. PROCESSING takes precedence over OUTSTANDING: while any part of the amount is processing, the status is PROCESSING, even if another part is still outstanding. The settlementStatus is OPEN.

      • SETTLED – The whole amount is settled. The settlementStatus is CLOSED.

      • CANCELED – The record is canceled. The part of the amount that wasn't settled isn't collected or applied. The settlementStatus is CLOSED.

      If the service returns an enum value that is not available in the current SDK version, status will return FinancialRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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, dueStatus shows whether it's due or past due. The settlementStatus is OPEN.

      • PROCESSING – A settlement of part or all of the amount is in progress, for example a payment that's submitted but not yet confirmed. PROCESSING takes precedence over OUTSTANDING: while any part of the amount is processing, the status is PROCESSING, even if another part is still outstanding. The settlementStatus is OPEN.

      • SETTLED – The whole amount is settled. The settlementStatus is CLOSED.

      • CANCELED – The record is canceled. The part of the amount that wasn't settled isn't collected or applied. The settlementStatus is CLOSED.

      See Also:
    • statusAsString

      public final String 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, dueStatus shows whether it's due or past due. The settlementStatus is OPEN.

      • PROCESSING – A settlement of part or all of the amount is in progress, for example a payment that's submitted but not yet confirmed. PROCESSING takes precedence over OUTSTANDING: while any part of the amount is processing, the status is PROCESSING, even if another part is still outstanding. The settlementStatus is OPEN.

      • SETTLED – The whole amount is settled. The settlementStatus is CLOSED.

      • CANCELED – The record is canceled. The part of the amount that wasn't settled isn't collected or applied. The settlementStatus is CLOSED.

      If the service returns an enum value that is not available in the current SDK version, status will return FinancialRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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, dueStatus shows whether it's due or past due. The settlementStatus is OPEN.

      • PROCESSING – A settlement of part or all of the amount is in progress, for example a payment that's submitted but not yet confirmed. PROCESSING takes precedence over OUTSTANDING: while any part of the amount is processing, the status is PROCESSING, even if another part is still outstanding. The settlementStatus is OPEN.

      • SETTLED – The whole amount is settled. The settlementStatus is CLOSED.

      • CANCELED – The record is canceled. The part of the amount that wasn't settled isn't collected or applied. The settlementStatus is CLOSED.

      See Also:
    • issuedAt

      public final Instant 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

      public final Instant closedAt()

      The date and time, in UTC, when the record was last closed, that is, when its status last became SETTLED or CANCELED. This member is absent while the settlementStatus is OPEN, including after a closed record reopens.

      Returns:
      The date and time, in UTC, when the record was last closed, that is, when its status last became SETTLED or CANCELED. This member is absent while the settlementStatus is OPEN, including after a closed record reopens.
    • toBuilder

      public FinancialRecordSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FinancialRecordSummary.Builder,FinancialRecordSummary>
      Returns:
      a builder for type T
    • builder

      public static FinancialRecordSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FinancialRecordSummary.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.