Invoicing / Client / list_invoice_units

list_invoice_units#

Invoicing.Client.list_invoice_units(**kwargs)#

This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.

See also: AWS API Documentation

Request Syntax

response = client.list_invoice_units(
    Filters={
        'Names': [
            'string',
        ],
        'InvoiceReceivers': [
            'string',
        ],
        'Accounts': [
            'string',
        ]
    },
    NextToken='string',
    MaxResults=123,
    AsOf=datetime(2015, 1, 1)
)
Parameters:

  • Filters (dict) –

    An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.

    • Names (list) –

      An optional input to the list API. You can specify a list of invoice unit names inside filters to return invoice units that match only the specified invoice unit names. If multiple names are provided, the result is an OR condition (match any) of the specified invoice unit names.

      • (string) –

    • InvoiceReceivers (list) –

      You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice units.

      • (string) –

    • Accounts (list) –

      You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts in the rules.

      • (string) –

  • NextToken (string) – The next token used to indicate where the returned list should start from.

  • MaxResults (integer) – The maximum number of invoice units that can be returned.

  • AsOf (datetime) – The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

Return type:

dict

Returns:

Response Syntax

{
    'InvoiceUnits': [
        {
            'InvoiceUnitArn': 'string',
            'InvoiceReceiver': 'string',
            'Name': 'string',
            'Description': 'string',
            'TaxInheritanceDisabled': True|False,
            'Rule': {
                'LinkedAccounts': [
                    'string',
                ]
            },
            'LastModified': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InvoiceUnits (list) –

      An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.

      • (dict) –

        An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you separate Amazon Web Services account costs and configures your invoice for each business entity going forward.

        • InvoiceUnitArn (string) –

          ARN to identify an invoice unit. This information can’t be modified or deleted.

        • InvoiceReceiver (string) –

          The account that receives invoices related to the invoice unit.

        • Name (string) –

          A unique name that is distinctive within your Amazon Web Services.

        • Description (string) –

          The assigned description for an invoice unit. This information can’t be modified or deleted.

        • TaxInheritanceDisabled (boolean) –

          Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

        • Rule (dict) –

          An InvoiceUnitRule object used the categorize invoice units.

          • LinkedAccounts (list) –

            The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.

            • (string) –

        • LastModified (datetime) –

          The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration.

    • NextToken (string) –

      The next token used to indicate where the returned list should start from.

Exceptions