Class: Aws::Payments::Types::InvoiceDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#billing_period ⇒ Types::BillingPeriod

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



858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end

#due_date ⇒ Time

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:

  • (Time)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end

#due_status ⇒ String

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.

Returns:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end

#invoice_frequency ⇒ String

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.

Returns:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end

#invoice_id ⇒ String

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:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end

#payment_terms ⇒ String

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:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 858

class InvoiceDetails < Struct.new(
  :invoice_id,
  :due_status,
  :billing_period,
  :due_date,
  :payment_terms,
  :invoice_frequency)
  SENSITIVE = []
  include Aws::Structure
end