Class InvoiceSummary

java.lang.Object
software.amazon.awssdk.services.invoicing.model.InvoiceSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InvoiceSummary.Builder,InvoiceSummary>
@Generated("software.amazon.awssdk:codegen") public final class InvoiceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InvoiceSummary.Builder,InvoiceSummary>

The invoice that the API retrieved.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The Amazon Web Services account ID.

      Returns:
      The Amazon Web Services account ID.

    • invoiceId

      public final String invoiceId()

      The invoice ID.

      Returns:
      The invoice ID.

    • issuedDate

      public final Instant issuedDate()

      The issued date of the invoice.

      Returns:
      The issued date of the invoice.

    • dueDate

      public final Instant dueDate()

      The invoice due date.

      Returns:
      The invoice due date.

    • hasBillSourceAccounts

      public final boolean hasBillSourceAccounts()
      For responses, this returns true if the service returned a value for the BillSourceAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • billSourceAccounts

      public final List<String> billSourceAccounts()

      The list of Amazon Web Services account IDs that are the bill source of the invoice. Currently, only a single bill source account is returned.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBillSourceAccounts() method.

      Returns:
      The list of Amazon Web Services account IDs that are the bill source of the invoice. Currently, only a single bill source account is returned.

    • billSourceAccountsTotalCount

      public final Integer billSourceAccountsTotalCount()

      The total number of accounts that are the bill source of the invoice.

      Returns:
      The total number of accounts that are the bill source of the invoice.

    • receiverRole

      public final ReceiverRole receiverRole()

      The role of the invoice receiver.

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

      Returns:
      The role of the invoice receiver.
      See Also:

    • receiverRoleAsString

      public final String receiverRoleAsString()

      The role of the invoice receiver.

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

      Returns:
      The role of the invoice receiver.
      See Also:

    • entity

      public final Entity entity()

      The organization name providing Amazon Web Services services.

      Returns:
      The organization name providing Amazon Web Services services.

    • billingPeriod

      public final BillingPeriod billingPeriod()

      The billing period of the invoice-related document.

      Returns:
      The billing period of the invoice-related document.

    • invoiceFrequency

      public final InvoiceFrequency invoiceFrequency()

      The frequency of the 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:
      The frequency of the invoice.
      See Also:

    • invoiceFrequencyAsString

      public final String invoiceFrequencyAsString()

      The frequency of the 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:
      The frequency of the invoice.
      See Also:

    • billType

      public final BillType billType()

      The type of the bill.

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

      Returns:
      The type of the bill.
      See Also:

    • billTypeAsString

      public final String billTypeAsString()

      The type of the bill.

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

      Returns:
      The type of the bill.
      See Also:

    • invoiceType

      public final InvoiceType invoiceType()

      The type of invoice.

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

      Returns:
      The type of invoice.
      See Also:

    • invoiceTypeAsString

      public final String invoiceTypeAsString()

      The type of invoice.

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

      Returns:
      The type of invoice.
      See Also:

    • commercialInvoiceId

      public final String commercialInvoiceId()

      The commercial invoice ID. This is only applicable for tax invoices and identifies the associated commercial invoice.

      Returns:
      The commercial invoice ID. This is only applicable for tax invoices and identifies the associated commercial invoice.

    • originalInvoiceId

      public final String originalInvoiceId()

      The initial or original invoice ID.

      Returns:
      The initial or original invoice ID.

    • purchaseOrderNumber

      public final String purchaseOrderNumber()

      The purchase order number associated to the invoice.

      Returns:
      The purchase order number associated to the invoice.

    • einvoiceDeliveryStatus

      public final EinvoiceDeliveryStatus einvoiceDeliveryStatus()

      The e-invoice delivery status.

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

      Returns:
      The e-invoice delivery status.
      See Also:

    • einvoiceDeliveryStatusAsString

      public final String einvoiceDeliveryStatusAsString()

      The e-invoice delivery status.

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

      Returns:
      The e-invoice delivery status.
      See Also:

    • taxAuthorityStatus

      public final TaxAuthorityStatus taxAuthorityStatus()

      The current status of an invoice as reported to the tax authority. This captures scenarios where an invoice may be cancelled after issuance.

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

      Returns:
      The current status of an invoice as reported to the tax authority. This captures scenarios where an invoice may be cancelled after issuance.
      See Also:

    • taxAuthorityStatusAsString

      public final String taxAuthorityStatusAsString()

      The current status of an invoice as reported to the tax authority. This captures scenarios where an invoice may be cancelled after issuance.

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

      Returns:
      The current status of an invoice as reported to the tax authority. This captures scenarios where an invoice may be cancelled after issuance.
      See Also:

    • baseCurrencyAmount

      public final InvoiceCurrencyAmount baseCurrencyAmount()

      The summary with the product and service currency.

      Returns:
      The summary with the product and service currency.

    • taxCurrencyAmount

      public final InvoiceCurrencyAmount taxCurrencyAmount()

      The summary with the tax currency.

      Returns:
      The summary with the tax currency.

    • paymentCurrencyAmount

      public final InvoiceCurrencyAmount paymentCurrencyAmount()

      The summary with the customer configured currency.

      Returns:
      The summary with the customer configured currency.

    • toBuilder

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

    • builder

      public static InvoiceSummary.Builder builder()

    • serializableBuilderClass

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