Invoicing / Client / list_invoice_summaries

list_invoice_summaries

Invoicing.Client.list_invoice_summaries(**kwargs)

Retrieves your invoice details programmatically, without line item details.

See also: AWS API Documentation

Request Syntax

response = client.list_invoice_summaries(
    Selector={
        'ResourceType': 'ACCOUNT_ID'|'INVOICE_ID',
        'Value': 'string'
    },
    Filter={
        'TimeInterval': {
            'StartDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1)
        },
        'BillingPeriod': {
            'Month': 123,
            'Year': 123
        },
        'InvoicingEntity': 'string'
    },
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Selector (dict) –

    [REQUIRED]

    The option to retrieve details for a specific invoice by providing its unique ID. Alternatively, access information for all invoices linked to the account by providing an account ID.

    • ResourceType (string) – [REQUIRED]

      The query identifier type ( INVOICE_ID or ACCOUNT_ID).

    • Value (string) – [REQUIRED]

      The value of the query identifier.

  • Filter (dict) –

    Filters you can use to customize your invoice summary.

    • TimeInterval (dict) –

      The date range for invoice summary retrieval.

      • StartDate (datetime) – [REQUIRED]

        The beginning of the time period that you want invoice-related documents for. The start date is inclusive. For example, if start is 2019-01-01, AWS retrieves invoices starting at 2019-01-01 up to the end date.

      • EndDate (datetime) – [REQUIRED]

        The end of the time period that you want invoice-related documents for. The end date is exclusive. For example, if end is 2019-01-10, Amazon Web Services retrieves invoice-related documents from the start date up to, but not including, 2018-01-10.

    • BillingPeriod (dict) –

      The billing period associated with the invoice documents.

      • Month (integer) – [REQUIRED]

        The billing period month.

      • Year (integer) – [REQUIRED]

        The billing period year.

    • InvoicingEntity (string) –

      The name of the entity that issues the Amazon Web Services invoice.

  • NextToken (string) – The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

  • MaxResults (integer) – The maximum number of invoice summaries a paginated response can contain.

Return type:

dict

Returns:

Response Syntax

{
    'InvoiceSummaries': [
        {
            'AccountId': 'string',
            'InvoiceId': 'string',
            'IssuedDate': datetime(2015, 1, 1),
            'DueDate': datetime(2015, 1, 1),
            'Entity': {
                'InvoicingEntity': 'string'
            },
            'BillingPeriod': {
                'Month': 123,
                'Year': 123
            },
            'InvoiceType': 'INVOICE'|'CREDIT_MEMO',
            'OriginalInvoiceId': 'string',
            'PurchaseOrderNumber': 'string',
            'BaseCurrencyAmount': {
                'TotalAmount': 'string',
                'TotalAmountBeforeTax': 'string',
                'CurrencyCode': 'string',
                'AmountBreakdown': {
                    'SubTotalAmount': 'string',
                    'Discounts': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Taxes': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Fees': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    }
                },
                'CurrencyExchangeDetails': {
                    'SourceCurrencyCode': 'string',
                    'TargetCurrencyCode': 'string',
                    'Rate': 'string'
                }
            },
            'TaxCurrencyAmount': {
                'TotalAmount': 'string',
                'TotalAmountBeforeTax': 'string',
                'CurrencyCode': 'string',
                'AmountBreakdown': {
                    'SubTotalAmount': 'string',
                    'Discounts': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Taxes': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Fees': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    }
                },
                'CurrencyExchangeDetails': {
                    'SourceCurrencyCode': 'string',
                    'TargetCurrencyCode': 'string',
                    'Rate': 'string'
                }
            },
            'PaymentCurrencyAmount': {
                'TotalAmount': 'string',
                'TotalAmountBeforeTax': 'string',
                'CurrencyCode': 'string',
                'AmountBreakdown': {
                    'SubTotalAmount': 'string',
                    'Discounts': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Taxes': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    },
                    'Fees': {
                        'Breakdown': [
                            {
                                'Description': 'string',
                                'Amount': 'string',
                                'Rate': 'string'
                            },
                        ],
                        'TotalAmount': 'string'
                    }
                },
                'CurrencyExchangeDetails': {
                    'SourceCurrencyCode': 'string',
                    'TargetCurrencyCode': 'string',
                    'Rate': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InvoiceSummaries (list) –

      List of key (summary level) invoice details without line item details.

      • (dict) –

        The invoice that the API retrieved.

        • AccountId (string) –

          The Amazon Web Services account ID.

        • InvoiceId (string) –

          The invoice ID.

        • IssuedDate (datetime) –

          The issued date of the invoice.

        • DueDate (datetime) –

          The invoice due date.

        • Entity (dict) –

          The organization name providing Amazon Web Services services.

          • InvoicingEntity (string) –

            The name of the entity that issues the Amazon Web Services invoice.

        • BillingPeriod (dict) –

          The billing period of the invoice-related document.

          • Month (integer) –

            The billing period month.

          • Year (integer) –

            The billing period year.

        • InvoiceType (string) –

          The type of invoice.

        • OriginalInvoiceId (string) –

          The initial or original invoice ID.

        • PurchaseOrderNumber (string) –

          The purchase order number associated to the invoice.

        • BaseCurrencyAmount (dict) –

          The summary with the product and service currency.

          • TotalAmount (string) –

            The invoice currency amount.

          • TotalAmountBeforeTax (string) –

            Details about the invoice total amount before tax.

          • CurrencyCode (string) –

            The currency dominion of the invoice document.

          • AmountBreakdown (dict) –

            Details about the invoice currency amount.

            • SubTotalAmount (string) –

              The total of a set of the breakdown.

            • Discounts (dict) –

              The discounted amount.

              • Breakdown (list) –

                The list of discounts information.

                • (dict) –

                  The discounted amount.

                  • Description (string) –

                    The list of discounts information.

                  • Amount (string) –

                    The discounted amount.

                  • Rate (string) –

                    The details for the discount rate..

              • TotalAmount (string) –

                The discount’s total amount.

            • Taxes (dict) –

              The tax amount.

              • Breakdown (list) –

                A list of tax information.

                • (dict) –

                  The tax amount.

                  • Description (string) –

                    The details of the taxes.

                  • Amount (string) –

                    The tax amount.

                  • Rate (string) –

                    The details of the tax rate.

              • TotalAmount (string) –

                The total amount for your taxes.

            • Fees (dict) –

              The fee amount.

              • Breakdown (list) –

                The list of fees information.

                • (dict) –

                  The fee amount.

                  • Description (string) –

                    The list of fees information.

                  • Amount (string) –

                    The fee amount.

                  • Rate (string) –

                    Details about the rate amount.

              • TotalAmount (string) –

                The total amount of fees.

          • CurrencyExchangeDetails (dict) –

            The details of currency exchange.

            • SourceCurrencyCode (string) –

              The exchange source currency.

            • TargetCurrencyCode (string) –

              The exchange target currency.

            • Rate (string) –

              The currency exchange rate.

        • TaxCurrencyAmount (dict) –

          The summary with the tax currency.

          • TotalAmount (string) –

            The invoice currency amount.

          • TotalAmountBeforeTax (string) –

            Details about the invoice total amount before tax.

          • CurrencyCode (string) –

            The currency dominion of the invoice document.

          • AmountBreakdown (dict) –

            Details about the invoice currency amount.

            • SubTotalAmount (string) –

              The total of a set of the breakdown.

            • Discounts (dict) –

              The discounted amount.

              • Breakdown (list) –

                The list of discounts information.

                • (dict) –

                  The discounted amount.

                  • Description (string) –

                    The list of discounts information.

                  • Amount (string) –

                    The discounted amount.

                  • Rate (string) –

                    The details for the discount rate..

              • TotalAmount (string) –

                The discount’s total amount.

            • Taxes (dict) –

              The tax amount.

              • Breakdown (list) –

                A list of tax information.

                • (dict) –

                  The tax amount.

                  • Description (string) –

                    The details of the taxes.

                  • Amount (string) –

                    The tax amount.

                  • Rate (string) –

                    The details of the tax rate.

              • TotalAmount (string) –

                The total amount for your taxes.

            • Fees (dict) –

              The fee amount.

              • Breakdown (list) –

                The list of fees information.

                • (dict) –

                  The fee amount.

                  • Description (string) –

                    The list of fees information.

                  • Amount (string) –

                    The fee amount.

                  • Rate (string) –

                    Details about the rate amount.

              • TotalAmount (string) –

                The total amount of fees.

          • CurrencyExchangeDetails (dict) –

            The details of currency exchange.

            • SourceCurrencyCode (string) –

              The exchange source currency.

            • TargetCurrencyCode (string) –

              The exchange target currency.

            • Rate (string) –

              The currency exchange rate.

        • PaymentCurrencyAmount (dict) –

          The summary with the customer configured currency.

          • TotalAmount (string) –

            The invoice currency amount.

          • TotalAmountBeforeTax (string) –

            Details about the invoice total amount before tax.

          • CurrencyCode (string) –

            The currency dominion of the invoice document.

          • AmountBreakdown (dict) –

            Details about the invoice currency amount.

            • SubTotalAmount (string) –

              The total of a set of the breakdown.

            • Discounts (dict) –

              The discounted amount.

              • Breakdown (list) –

                The list of discounts information.

                • (dict) –

                  The discounted amount.

                  • Description (string) –

                    The list of discounts information.

                  • Amount (string) –

                    The discounted amount.

                  • Rate (string) –

                    The details for the discount rate..

              • TotalAmount (string) –

                The discount’s total amount.

            • Taxes (dict) –

              The tax amount.

              • Breakdown (list) –

                A list of tax information.

                • (dict) –

                  The tax amount.

                  • Description (string) –

                    The details of the taxes.

                  • Amount (string) –

                    The tax amount.

                  • Rate (string) –

                    The details of the tax rate.

              • TotalAmount (string) –

                The total amount for your taxes.

            • Fees (dict) –

              The fee amount.

              • Breakdown (list) –

                The list of fees information.

                • (dict) –

                  The fee amount.

                  • Description (string) –

                    The list of fees information.

                  • Amount (string) –

                    The fee amount.

                  • Rate (string) –

                    Details about the rate amount.

              • TotalAmount (string) –

                The total amount of fees.

          • CurrencyExchangeDetails (dict) –

            The details of currency exchange.

            • SourceCurrencyCode (string) –

              The exchange source currency.

            • TargetCurrencyCode (string) –

              The exchange target currency.

            • Rate (string) –

              The currency exchange rate.

    • NextToken (string) –

      The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions