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

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

Overview

The invoice that the API retrieved.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_amount ⇒ Types::InvoiceCurrencyAmount

The summary with the product and service currency.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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 ⇒ Array<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>) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_count ⇒ Integer

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

Returns:

  • (Integer) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_type ⇒ String

The type of the bill.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_period ⇒ Types::BillingPeriod

The billing period of the invoice-related document.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_id ⇒ String

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

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_date ⇒ Time

The invoice due date.

Returns:

  • (Time) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_status ⇒ String

The e-invoice delivery status.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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

#entity ⇒ Types::Entity

The organization name providing Amazon Web Services services.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_frequency ⇒ String

The frequency of the invoice.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_id ⇒ String

The invoice ID.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_type ⇒ String

The type of invoice.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_date ⇒ Time

The issued date of the invoice.

Returns:

  • (Time) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_id ⇒ String

The initial or original invoice ID.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_amount ⇒ Types::InvoiceCurrencyAmount

The summary with the customer configured currency.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_number ⇒ String

The purchase order number associated to the invoice.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_role ⇒ String

The role of the invoice receiver.

Returns:

  • (String) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_status ⇒ String

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) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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_amount ⇒ Types::InvoiceCurrencyAmount

The summary with the tax currency.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/types.rb', line 1083

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