invoice_summaries

Creates, updates, deletes, gets or lists an invoice_summaries resource.

Overview

Name	invoice_summaries
Type	Resource
Id	aws.invoicing.invoice_summaries

Fields

The following fields are returned by SELECT queries:

list_invoice_summaries

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID. (pattern: <code>\d{12}</code>)
base_currency_amount	object	The summary with the product and service currency.
bill_source_accounts	array	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.
bill_source_accounts_total_count	integer	The total number of accounts that are the bill source of the invoice.
bill_type	string	The type of the bill. (ANNIVERSARY, PURCHASE, REFUND)
billing_period	object	The billing period of the invoice-related document.
commercial_invoice_id	string	The commercial invoice ID. This is only applicable for tax invoices and identifies the associated commercial invoice. (pattern: <code>[\s\S]*</code>)
due_date	string (date-time)	The invoice due date.
einvoice_delivery_status	string	The e-invoice delivery status. (DELIVERED, NOT_DELIVERED)
entity	object	The organization name providing Amazon Web Services services.
invoice_frequency	string	The frequency of the invoice. (ONE_TIME, RECURRING)
invoice_id	string	The invoice ID. (pattern: <code>[\s\S]*</code>)
invoice_type	string	The type of invoice. (INVOICE, CREDIT_MEMO, PAYMENT_RECEIPT)
issued_date	string (date-time)	The issued date of the invoice.
original_invoice_id	string	The initial or original invoice ID. (pattern: <code>[\s\S]*</code>)
payment_currency_amount	object	The summary with the customer configured currency.
purchase_order_number	string	The purchase order number associated to the invoice. (pattern: <code>[\s\S]*</code>)
receiver_role	string	The role of the invoice receiver. (SELLER, RESELLER, BUYER)
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. (ISSUED, CANCELLED)
tax_currency_amount	object	The summary with the tax currency.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_invoice_summaries	select	region		Retrieves your invoice details programmatically, without line item details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_invoice_summaries

Retrieves your invoice details programmatically, without line item details.

SELECT
account_id,
base_currency_amount,
bill_source_accounts,
bill_source_accounts_total_count,
bill_type,
billing_period,
commercial_invoice_id,
due_date,
einvoice_delivery_status,
entity,
invoice_frequency,
invoice_id,
invoice_type,
issued_date,
original_invoice_id,
payment_currency_amount,
purchase_order_number,
receiver_role,
tax_authority_status,
tax_currency_amount
FROM aws.invoicing.invoice_summaries
WHERE region = '{{ region }}' -- required
;