Class InvoiceDetails

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

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

The details of an invoice: the invoice ID that Amazon Web Services Invoicing issued, the billing period that the invoice covers, its due date and due status, its payment terms, and its frequency.

See Also:
  • Method Details

    • invoiceId

      public final String invoiceId()

      The invoice ID that Amazon Web Services Invoicing issued for the invoice: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as InvoiceId. GetFinancialRecord and BatchGetFinancialRecord also accept it, as invoiceIdentifier.

      Returns:
      The invoice ID that Amazon Web Services Invoicing issued for the invoice: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as InvoiceId. GetFinancialRecord and BatchGetFinancialRecord also accept it, as invoiceIdentifier.
    • dueStatus

      public final DueStatus dueStatus()

      Whether the invoice is due or past its due date. This member is present only while the invoice's status is OUTSTANDING. It's absent when the status is PROCESSING, SETTLED, or CANCELED. The following values are valid:

      • DUE – The due date hasn't passed.

      • PAST_DUE – The due date has passed, and the invoice is still outstanding.

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

      Returns:
      Whether the invoice is due or past its due date. This member is present only while the invoice's status is OUTSTANDING. It's absent when the status is PROCESSING, SETTLED, or CANCELED. The following values are valid:

      • DUE – The due date hasn't passed.

      • PAST_DUE – The due date has passed, and the invoice is still outstanding.

      See Also:
    • dueStatusAsString

      public final String dueStatusAsString()

      Whether the invoice is due or past its due date. This member is present only while the invoice's status is OUTSTANDING. It's absent when the status is PROCESSING, SETTLED, or CANCELED. The following values are valid:

      • DUE – The due date hasn't passed.

      • PAST_DUE – The due date has passed, and the invoice is still outstanding.

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

      Returns:
      Whether the invoice is due or past its due date. This member is present only while the invoice's status is OUTSTANDING. It's absent when the status is PROCESSING, SETTLED, or CANCELED. The following values are valid:

      • DUE – The due date hasn't passed.

      • PAST_DUE – The due date has passed, and the invoice is still outstanding.

      See Also:
    • billingPeriod

      public final BillingPeriod billingPeriod()

      The billing period the invoice covers: the period of the usage it bills.

      Returns:
      The billing period the invoice covers: the period of the usage it bills.
    • dueDate

      public final Instant dueDate()

      The calendar date by which the invoice must be paid, as the timestamp of 00:00:00 UTC on that day. The invoice is past due from the following day.

      Returns:
      The calendar date by which the invoice must be paid, as the timestamp of 00:00:00 UTC on that day. The invoice is past due from the following day.
    • paymentTerms

      public final String paymentTerms()

      The payment terms for the invoice, as Amazon Web Services Invoicing issued them, such as Net30. The due date follows from these terms. This member is absent when Amazon Web Services Invoicing didn't issue payment terms for the invoice.

      Returns:
      The payment terms for the invoice, as Amazon Web Services Invoicing issued them, such as Net30. The due date follows from these terms. This member is absent when Amazon Web Services Invoicing didn't issue payment terms for the invoice.
    • invoiceFrequency

      public final InvoiceFrequency invoiceFrequency()

      Whether the invoice was issued once or as part of a billing cycle. The following values are valid:

      • ONE_TIME – A single invoice that isn't part of a billing cycle.

      • RECURRING – One invoice of a billing cycle, such as your monthly invoice.

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

      Returns:
      Whether the invoice was issued once or as part of a billing cycle. The following values are valid:

      • ONE_TIME – A single invoice that isn't part of a billing cycle.

      • RECURRING – One invoice of a billing cycle, such as your monthly invoice.

      See Also:
    • invoiceFrequencyAsString

      public final String invoiceFrequencyAsString()

      Whether the invoice was issued once or as part of a billing cycle. The following values are valid:

      • ONE_TIME – A single invoice that isn't part of a billing cycle.

      • RECURRING – One invoice of a billing cycle, such as your monthly invoice.

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

      Returns:
      Whether the invoice was issued once or as part of a billing cycle. The following values are valid:

      • ONE_TIME – A single invoice that isn't part of a billing cycle.

      • RECURRING – One invoice of a billing cycle, such as your monthly invoice.

      See Also:
    • toBuilder

      public InvoiceDetails.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<InvoiceDetails.Builder,InvoiceDetails>
      Returns:
      a builder for type T
    • builder

      public static InvoiceDetails.Builder builder()
    • serializableBuilderClass

      public static Class<? extends InvoiceDetails.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.