Class: Aws::Invoicing::Types::InvoiceSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-invoicing/types.rb

Overview

The invoice that the API retrieved.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Web Services account ID.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#base_currency_amountTypes::InvoiceCurrencyAmount

The summary with the product and service currency.



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#bill_source_accountsArray<String>

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.

Returns:

  • (Array<String>)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#bill_source_accounts_total_countInteger

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

Returns:

  • (Integer)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#bill_typeString

The type of the bill.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#billing_periodTypes::BillingPeriod

The billing period of the invoice-related document.



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#commercial_invoice_idString

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

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#due_dateTime

The invoice due date.

Returns:

  • (Time)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#einvoice_delivery_statusString

The e-invoice delivery status.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#entityTypes::Entity

The organization name providing Amazon Web Services services.

Returns:



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#invoice_frequencyString

The frequency of the invoice.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#invoice_idString

The invoice ID.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#invoice_typeString

The type of invoice.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#issued_dateTime

The issued date of the invoice.

Returns:

  • (Time)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#original_invoice_idString

The initial or original invoice ID.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#payment_currency_amountTypes::InvoiceCurrencyAmount

The summary with the customer configured currency.



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#purchase_order_numberString

The purchase order number associated to the invoice.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#receiver_roleString

The role of the invoice receiver.

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#tax_authority_statusString

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

Returns:

  • (String)


1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end

#tax_currency_amountTypes::InvoiceCurrencyAmount

The summary with the tax currency.



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/aws-sdk-invoicing/types.rb', line 1010

class InvoiceSummary < Struct.new(
  :account_id,
  :invoice_id,
  :issued_date,
  :due_date,
  :bill_source_accounts,
  :bill_source_accounts_total_count,
  :receiver_role,
  :entity,
  :billing_period,
  :invoice_frequency,
  :bill_type,
  :invoice_type,
  :commercial_invoice_id,
  :original_invoice_id,
  :purchase_order_number,
  :einvoice_delivery_status,
  :tax_authority_status,
  :base_currency_amount,
  :tax_currency_amount,
  :payment_currency_amount)
  SENSITIVE = []
  include Aws::Structure
end