SDK for PHP 3.x

AWS Invoicing 2024-12-01

Client: Aws\Invoicing\InvoicingClient
Service ID: invoicing
Version: 2024-12-01

This page describes the parameters and results for the operations of the AWS Invoicing (2024-12-01), and shows how to use the Aws\Invoicing\InvoicingClient object to call the described operations. This documentation is specific to the 2024-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchGetInvoiceProfile ( array $params = [] )
This gets the invoice profile associated with a set of accounts.
CreateInvoiceUnit ( array $params = [] )
This creates a new invoice unit with the provided definition.
DeleteInvoiceUnit ( array $params = [] )
This deletes an invoice unit with the provided invoice unit ARN.
GetInvoiceUnit ( array $params = [] )
This retrieves the invoice unit definition.
ListInvoiceSummaries ( array $params = [] )
Retrieves your invoice details programmatically, without line item details.
ListInvoiceUnits ( array $params = [] )
This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.
ListTagsForResource ( array $params = [] )
Lists the tags for a resource.
TagResource ( array $params = [] )
Adds a tag to a resource.
UntagResource ( array $params = [] )
Removes a tag from a resource.
UpdateInvoiceUnit ( array $params = [] )
You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListInvoiceSummaries
ListInvoiceUnits

Operations

BatchGetInvoiceProfile 

$result = $client->batchGetInvoiceProfile([/* ... */]);
$promise = $client->batchGetInvoiceProfileAsync([/* ... */]);

This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.

Parameter Syntax

$result = $client->batchGetInvoiceProfile([
    'AccountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AccountIds
Required: Yes
Type: Array of strings

Retrieves the corresponding invoice profile data for these account IDs.

Result Syntax

[
    'Profiles' => [
        [
            'AccountId' => '<string>',
            'Issuer' => '<string>',
            'ReceiverAddress' => [
                'AddressLine1' => '<string>',
                'AddressLine2' => '<string>',
                'AddressLine3' => '<string>',
                'City' => '<string>',
                'CompanyName' => '<string>',
                'CountryCode' => '<string>',
                'DistrictOrCounty' => '<string>',
                'PostalCode' => '<string>',
                'StateOrRegion' => '<string>',
            ],
            'ReceiverEmail' => '<string>',
            'ReceiverName' => '<string>',
            'TaxRegistrationNumber' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Profiles
Type: Array of InvoiceProfile structures

A list of invoice profiles corresponding to the requested accounts.

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: BatchGetInvoiceProfile 
$result = $client->batchGetInvoiceProfile([
    'AccountIds' => [
        '111111111111',
    ],
]);

Result syntax:

[
    'Profiles' => [
        [
            'AccountId' => '111111111111',
            'Issuer' => 'Test',
            'ReceiverAddress' => [
                'AddressLine1' => 'Test',
                'City' => 'Test',
                'CountryCode' => 'LU',
                'PostalCode' => 'Test',
                'StateOrRegion' => 'Test',
            ],
            'ReceiverEmail' => 'test@amazon.com',
            'ReceiverName' => 'TestAccount',
        ],
    ],
]

CreateInvoiceUnit 

$result = $client->createInvoiceUnit([/* ... */]);
$promise = $client->createInvoiceUnitAsync([/* ... */]);

This creates a new invoice unit with the provided definition.

Parameter Syntax

$result = $client->createInvoiceUnit([
    'Description' => '<string>',
    'InvoiceReceiver' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ResourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Rule' => [ // REQUIRED
        'LinkedAccounts' => ['<string>', ...],
    ],
    'TaxInheritanceDisabled' => true || false,
]);

Parameter Details

Members
Description
Type: string

The invoice unit's description. This can be changed at a later time.

InvoiceReceiver
Required: Yes
Type: string

The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

Name
Required: Yes
Type: string

The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate.

ResourceTags
Type: Array of ResourceTag structures

The tag structure that contains a tag key and value.

Rule
Required: Yes
Type: InvoiceUnitRule structure

The InvoiceUnitRule object used to create invoice units.

TaxInheritanceDisabled
Type: boolean

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

Result Syntax

[
    'InvoiceUnitArn' => '<string>',
]

Result Details

Members
InvoiceUnitArn
Type: string

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

Errors

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: CreateInvoiceUnit 
$result = $client->createInvoiceUnit([
    'Description' => 'Example Invoice Unit Description',
    'InvoiceReceiver' => '111111111111',
    'Name' => 'Example Invoice Unit',
    'ResourceTags' => [
        [
            'Key' => 'TagKey',
            'Value' => 'TagValue',
        ],
    ],
    'Rule' => [
        'LinkedAccounts' => [
            '222222222222',
        ],
    ],
    'TaxInheritanceDisabled' => ,
]);

Result syntax:

[
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]

DeleteInvoiceUnit 

$result = $client->deleteInvoiceUnit([/* ... */]);
$promise = $client->deleteInvoiceUnitAsync([/* ... */]);

This deletes an invoice unit with the provided invoice unit ARN.

Parameter Syntax

$result = $client->deleteInvoiceUnit([
    'InvoiceUnitArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
InvoiceUnitArn
Required: Yes
Type: string

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

Result Syntax

[
    'InvoiceUnitArn' => '<string>',
]

Result Details

Members
InvoiceUnitArn
Type: string

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

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: DeleteInvoiceUnit 
$result = $client->deleteInvoiceUnit([
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]);

Result syntax:

[
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]

GetInvoiceUnit 

$result = $client->getInvoiceUnit([/* ... */]);
$promise = $client->getInvoiceUnitAsync([/* ... */]);

This retrieves the invoice unit definition.

Parameter Syntax

$result = $client->getInvoiceUnit([
    'AsOf' => <integer || string || DateTime>,
    'InvoiceUnitArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AsOf
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

InvoiceUnitArn
Required: Yes
Type: string

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

Result Syntax

[
    'Description' => '<string>',
    'InvoiceReceiver' => '<string>',
    'InvoiceUnitArn' => '<string>',
    'LastModified' => <DateTime>,
    'Name' => '<string>',
    'Rule' => [
        'LinkedAccounts' => ['<string>', ...],
    ],
    'TaxInheritanceDisabled' => true || false,
]

Result Details

Members
Description
Type: string

The assigned description for an invoice unit.

InvoiceReceiver
Type: string

The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

InvoiceUnitArn
Type: string

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

LastModified
Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent date the invoice unit response was updated.

Name
Type: string

The unique name of the invoice unit that is shown on the generated invoice.

Rule
Type: InvoiceUnitRule structure

This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT.

TaxInheritanceDisabled
Type: boolean

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

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: GetInvoiceUnit as of current time 
$result = $client->getInvoiceUnit([
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]);

Result syntax:

[
    'Description' => 'Description changed on 1733788800',
    'InvoiceReceiver' => '111111111111',
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
    'LastModified' => ,
    'Name' => 'Example Invoice Unit A',
    'Rule' => [
        'LinkedAccounts' => [
            '222222222222',
        ],
    ],
    'TaxInheritanceDisabled' => ,
]
Example 2: GetInvoiceUnit as of specified time 
$result = $client->getInvoiceUnit([
    'AsOf' => ,
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/87654321',
]);

Result syntax:

[
    'Description' => 'Description changed on 1733011200',
    'InvoiceReceiver' => '333333333333',
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/87654321',
    'LastModified' => ,
    'Name' => 'Example Invoice Unit B',
    'Rule' => [
        'LinkedAccounts' => [
            '333333333333',
        ],
    ],
    'TaxInheritanceDisabled' => ,
]

ListInvoiceSummaries 

$result = $client->listInvoiceSummaries([/* ... */]);
$promise = $client->listInvoiceSummariesAsync([/* ... */]);

Retrieves your invoice details programmatically, without line item details.

Parameter Syntax

$result = $client->listInvoiceSummaries([
    'Filter' => [
        'BillingPeriod' => [
            'Month' => <integer>, // REQUIRED
            'Year' => <integer>, // REQUIRED
        ],
        'InvoicingEntity' => '<string>',
        'TimeInterval' => [
            'EndDate' => <integer || string || DateTime>, // REQUIRED
            'StartDate' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Selector' => [ // REQUIRED
        'ResourceType' => 'ACCOUNT_ID|INVOICE_ID', // REQUIRED
        'Value' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
Filter
Type: InvoiceSummariesFilter structure

Filters you can use to customize your invoice summary.

MaxResults
Type: int

The maximum number of invoice summaries a paginated response can contain.

NextToken
Type: 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.

Selector
Required: Yes
Type: InvoiceSummariesSelector structure

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.

Result Syntax

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '<string>',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'Fees' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'SubTotalAmount' => '<string>',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                ],
                'CurrencyCode' => '<string>',
                'CurrencyExchangeDetails' => [
                    'Rate' => '<string>',
                    'SourceCurrencyCode' => '<string>',
                    'TargetCurrencyCode' => '<string>',
                ],
                'TotalAmount' => '<string>',
                'TotalAmountBeforeTax' => '<string>',
            ],
            'BillingPeriod' => [
                'Month' => <integer>,
                'Year' => <integer>,
            ],
            'DueDate' => <DateTime>,
            'Entity' => [
                'InvoicingEntity' => '<string>',
            ],
            'InvoiceId' => '<string>',
            'InvoiceType' => 'INVOICE|CREDIT_MEMO',
            'IssuedDate' => <DateTime>,
            'OriginalInvoiceId' => '<string>',
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'Fees' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'SubTotalAmount' => '<string>',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                ],
                'CurrencyCode' => '<string>',
                'CurrencyExchangeDetails' => [
                    'Rate' => '<string>',
                    'SourceCurrencyCode' => '<string>',
                    'TargetCurrencyCode' => '<string>',
                ],
                'TotalAmount' => '<string>',
                'TotalAmountBeforeTax' => '<string>',
            ],
            'PurchaseOrderNumber' => '<string>',
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'Fees' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                    'SubTotalAmount' => '<string>',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '<string>',
                                'Description' => '<string>',
                                'Rate' => '<string>',
                            ],
                            // ...
                        ],
                        'TotalAmount' => '<string>',
                    ],
                ],
                'CurrencyCode' => '<string>',
                'CurrencyExchangeDetails' => [
                    'Rate' => '<string>',
                    'SourceCurrencyCode' => '<string>',
                    'TargetCurrencyCode' => '<string>',
                ],
                'TotalAmount' => '<string>',
                'TotalAmountBeforeTax' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
InvoiceSummaries
Required: Yes
Type: Array of InvoiceSummary structures

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

NextToken
Type: 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.

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: ListInvoiceSummaries with InvoiceId as selector 
$result = $client->listInvoiceSummaries([
    'Selector' => [
        'ResourceType' => 'INVOICE_ID',
        'Value' => '1111111111',
    ],
]);

Result syntax:

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '111111111111',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'BillingPeriod' => [
                'Month' => 1,
                'Year' => 2025,
            ],
            'DueDate' => ,
            'Entity' => [
                'InvoicingEntity' => 'Amazon Web Services, Inc.',
            ],
            'InvoiceId' => '1111111111',
            'InvoiceType' => 'INVOICE',
            'IssuedDate' => ,
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
        ],
    ],
]
Example 2: ListInvoiceSummaries with AccountId as selector and billing period 
$result = $client->listInvoiceSummaries([
    'Filter' => [
        'BillingPeriod' => [
            'Month' => 1,
            'Year' => 2025,
        ],
    ],
    'Selector' => [
        'ResourceType' => 'ACCOUNT_ID',
        'Value' => '111111111111',
    ],
]);

Result syntax:

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '111111111111',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'BillingPeriod' => [
                'Month' => 1,
                'Year' => 2025,
            ],
            'DueDate' => ,
            'Entity' => [
                'InvoicingEntity' => 'Amazon Web Services, Inc.',
            ],
            'InvoiceId' => '1111111111',
            'InvoiceType' => 'INVOICE',
            'IssuedDate' => ,
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
        ],
    ],
]
Example 3: ListInvoiceSummaries with AccountId as selector and time interval 
$result = $client->listInvoiceSummaries([
    'Filter' => [
        'TimeInterval' => [
            'EndDate' => ,
            'StartDate' => ,
        ],
    ],
    'Selector' => [
        'ResourceType' => 'ACCOUNT_ID',
        'Value' => '111111111111',
    ],
]);

Result syntax:

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '111111111111',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'BillingPeriod' => [
                'Month' => 1,
                'Year' => 2025,
            ],
            'DueDate' => ,
            'Entity' => [
                'InvoicingEntity' => 'Amazon Web Services, Inc.',
            ],
            'InvoiceId' => '1111111111',
            'InvoiceType' => 'INVOICE',
            'IssuedDate' => ,
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
        ],
    ],
]
Example 4: ListInvoiceSummaries with AccountId as selector and a billing period and max results 
$result = $client->listInvoiceSummaries([
    'Filter' => [
        'BillingPeriod' => [
            'Month' => 1,
            'Year' => 2025,
        ],
    ],
    'MaxResults' => 1,
    'Selector' => [
        'ResourceType' => 'ACCOUNT_ID',
        'Value' => '111111111111',
    ],
]);

Result syntax:

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '111111111111',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'BillingPeriod' => [
                'Month' => 1,
                'Year' => 2025,
            ],
            'DueDate' => ,
            'Entity' => [
                'InvoicingEntity' => 'Amazon Web Services, Inc.',
            ],
            'InvoiceId' => '1111111111',
            'InvoiceType' => 'INVOICE',
            'IssuedDate' => ,
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
        ],
    ],
    'NextToken' => 'abcde12345',
]
Example 5: ListInvoiceSummaries with AccountId as selector and a billing period and next token 
$result = $client->listInvoiceSummaries([
    'Filter' => [
        'BillingPeriod' => [
            'Month' => 1,
            'Year' => 2025,
        ],
    ],
    'NextToken' => 'abcde12345',
    'Selector' => [
        'ResourceType' => 'ACCOUNT_ID',
        'Value' => '111111111111',
    ],
]);

Result syntax:

[
    'InvoiceSummaries' => [
        [
            'AccountId' => '111111111111',
            'BaseCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'BillingPeriod' => [
                'Month' => 1,
                'Year' => 2025,
            ],
            'DueDate' => ,
            'Entity' => [
                'InvoicingEntity' => 'Amazon Web Services, Inc.',
            ],
            'InvoiceId' => '1111111111',
            'InvoiceType' => 'INVOICE',
            'IssuedDate' => ,
            'PaymentCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
            'TaxCurrencyAmount' => [
                'AmountBreakdown' => [
                    'Discounts' => [
                        'TotalAmount' => '1.00',
                    ],
                    'SubTotalAmount' => '1.00',
                    'Taxes' => [
                        'Breakdown' => [
                            [
                                'Amount' => '1',
                                'Description' => 'VAT',
                                'Rate' => '1.0',
                            ],
                        ],
                        'TotalAmount' => '1.00',
                    ],
                ],
                'CurrencyCode' => 'USD',
                'CurrencyExchangeDetails' => [
                    'Rate' => '1.0',
                    'SourceCurrencyCode' => 'USD',
                    'TargetCurrencyCode' => 'USD',
                ],
                'TotalAmount' => '1.00',
                'TotalAmountBeforeTax' => '1.00',
            ],
        ],
    ],
]

ListInvoiceUnits 

$result = $client->listInvoiceUnits([/* ... */]);
$promise = $client->listInvoiceUnitsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listInvoiceUnits([
    'AsOf' => <integer || string || DateTime>,
    'Filters' => [
        'Accounts' => ['<string>', ...],
        'InvoiceReceivers' => ['<string>', ...],
        'Names' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
AsOf
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Filters
Type: Filters structure

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.

MaxResults
Type: int

The maximum number of invoice units that can be returned.

NextToken
Type: string

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

Result Syntax

[
    'InvoiceUnits' => [
        [
            'Description' => '<string>',
            'InvoiceReceiver' => '<string>',
            'InvoiceUnitArn' => '<string>',
            'LastModified' => <DateTime>,
            'Name' => '<string>',
            'Rule' => [
                'LinkedAccounts' => ['<string>', ...],
            ],
            'TaxInheritanceDisabled' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
InvoiceUnits
Type: Array of InvoiceUnit structures

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

NextToken
Type: string

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

Errors

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: ListInvoiceUnits without filters as of current time 
$result = $client->listInvoiceUnits([
]);

Result syntax:

[
    'InvoiceUnits' => [
        [
            'Description' => 'Description changed on 1733788800',
            'InvoiceReceiver' => '111111111111',
            'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
            'LastModified' => ,
            'Name' => 'Example Invoice Unit A',
            'Rule' => [
                'LinkedAccounts' => [
                    '222222222222',
                ],
            ],
            'TaxInheritanceDisabled' => ,
        ],
        [
            'Description' => 'Description changed on 1733788800',
            'InvoiceReceiver' => '333333333333',
            'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/87654321',
            'LastModified' => ,
            'Name' => 'Example Invoice Unit B',
            'Rule' => [
                'LinkedAccounts' => [
                    '333333333333',
                ],
            ],
            'TaxInheritanceDisabled' => 1,
        ],
    ],
]
Example 2: ListInvoiceUnits with filters as of specified time 
$result = $client->listInvoiceUnits([
    'AsOf' => ,
    'Filters' => [
        'InvoiceReceivers' => [
            '333333333333',
        ],
    ],
]);

Result syntax:

[
    'InvoiceUnits' => [
        [
            'Description' => 'Description changed on 1733011200',
            'InvoiceReceiver' => '333333333333',
            'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/87654321',
            'LastModified' => ,
            'Name' => 'Example Invoice Unit B',
            'Rule' => [
                'LinkedAccounts' => [
                    '333333333333',
                ],
            ],
            'TaxInheritanceDisabled' => ,
        ],
    ],
]
Example 3: ListInvoiceUnits with pagination - first page 
$result = $client->listInvoiceUnits([
    'MaxResults' => 1,
]);

Result syntax:

[
    'InvoiceUnits' => [
        [
            'Description' => 'Description changed on 1733788800',
            'InvoiceReceiver' => '111111111111',
            'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
            'LastModified' => ,
            'Name' => 'Example Invoice Unit A',
            'Rule' => [
                'LinkedAccounts' => [
                    '222222222222',
                ],
            ],
            'TaxInheritanceDisabled' => ,
        ],
    ],
    'NextToken' => 'nextTokenExample',
]
Example 4: ListInvoiceUnits with pagination - second page 
$result = $client->listInvoiceUnits([
    'MaxResults' => 1,
    'NextToken' => 'nextTokenExample',
]);

Result syntax:

[
    'InvoiceUnits' => [
        [
            'Description' => 'Description changed on 1733788800',
            'InvoiceReceiver' => '333333333333',
            'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/87654321',
            'LastModified' => ,
            'Name' => 'Example Invoice Unit B',
            'Rule' => [
                'LinkedAccounts' => [
                    '333333333333',
                ],
            ],
            'TaxInheritanceDisabled' => 1,
        ],
    ],
]

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of tags to list.

Result Syntax

[
    'ResourceTags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ResourceTags
Type: Array of ResourceTag structures

Adds a tag to a resource.

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: ListTagsForResource 
$result = $client->listTagsForResource([
    'ResourceArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]);

Result syntax:

[
    'ResourceTags' => [
        [
            'Key' => 'TagKey',
            'Value' => 'TagValue',
        ],
    ],
]

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a tag to a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'ResourceTags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the tags.

ResourceTags
Required: Yes
Type: Array of ResourceTag structures

Adds a tag to a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ServiceQuotaExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: TagResource 
$result = $client->tagResource([
    'ResourceArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
    'ResourceTags' => [
        [
            'Key' => 'TagKey',
            'Value' => 'TagValue',
        ],
    ],
]);

Result syntax:

[
]

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'ResourceTagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) to untag.

ResourceTagKeys
Required: Yes
Type: Array of strings

Keys for the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: UntagResource 
$result = $client->untagResource([
    'ResourceArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
    'ResourceTagKeys' => [
        'TagKey',
    ],
]);

Result syntax:

[
]

UpdateInvoiceUnit 

$result = $client->updateInvoiceUnit([/* ... */]);
$promise = $client->updateInvoiceUnitAsync([/* ... */]);

You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

Parameter Syntax

$result = $client->updateInvoiceUnit([
    'Description' => '<string>',
    'InvoiceUnitArn' => '<string>', // REQUIRED
    'Rule' => [
        'LinkedAccounts' => ['<string>', ...],
    ],
    'TaxInheritanceDisabled' => true || false,
]);

Parameter Details

Members
Description
Type: string

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

InvoiceUnitArn
Required: Yes
Type: string

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

Rule
Type: InvoiceUnitRule structure

The InvoiceUnitRule object used to update invoice units.

TaxInheritanceDisabled
Type: boolean

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

Result Syntax

[
    'InvoiceUnitArn' => '<string>',
]

Result Details

Members
InvoiceUnitArn
Type: string

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

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The processing request failed because of an unknown error, exception, or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

Examples

Example 1: UpdateInvoiceUnit with all updatable fields 
$result = $client->updateInvoiceUnit([
    'Description' => 'Updated IU description',
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
    'Rule' => [
        'LinkedAccounts' => [
            '111111111111',
            '222222222222',
        ],
    ],
    'TaxInheritanceDisabled' => ,
]);

Result syntax:

[
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]
Example 2: UpdateInvoiceUnit with specific fields 
$result = $client->updateInvoiceUnit([
    'Description' => 'Updated IU description. All other fields remain unchanged',
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]);

Result syntax:

[
    'InvoiceUnitArn' => 'arn:aws:invoicing::000000000000:invoice-unit/12345678',
]

Shapes

AccessDeniedException

Description

You don't have sufficient access to perform this action.

Members
message
Type: string
resourceName
Type: string

You don't have sufficient access to perform this action.

AmountBreakdown

Description

Details about how the total amount was calculated and categorized.

Members
Discounts
Type: DiscountsBreakdown structure

The discounted amount.

Fees
Type: FeesBreakdown structure

The fee amount.

SubTotalAmount
Type: string

The total of a set of the breakdown.

Taxes
Type: TaxesBreakdown structure

The tax amount.

BillingPeriod

Description

The billing period for which you want to retrieve invoice-related documents.

Members
Month
Required: Yes
Type: int

The billing period month.

Year
Required: Yes
Type: int

The billing period year.

CurrencyExchangeDetails

Description

The details of currency exchange.

Members
Rate
Type: string

The currency exchange rate.

SourceCurrencyCode
Type: string

The exchange source currency.

TargetCurrencyCode
Type: string

The exchange target currency.

DateInterval

Description

The time period that you want invoice-related documents for.

Members
EndDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

StartDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

DiscountsBreakdown

Description

The discounts details.

Members
Breakdown
Type: Array of DiscountsBreakdownAmount structures

The list of discounts information.

TotalAmount
Type: string

The discount's total amount.

DiscountsBreakdownAmount

Description

The discounted amount.

Members
Amount
Type: string

The discounted amount.

Description
Type: string

The list of discounts information.

Rate
Type: string

The details for the discount rate..

Entity

Description

The organization name providing Amazon Web Services services.

Members
InvoicingEntity
Type: string

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

FeesBreakdown

Description

The details of fees.

Members
Breakdown
Type: Array of FeesBreakdownAmount structures

The list of fees information.

TotalAmount
Type: string

The total amount of fees.

FeesBreakdownAmount

Description

The fee amount.

Members
Amount
Type: string

The fee amount.

Description
Type: string

The list of fees information.

Rate
Type: string

Details about the rate amount.

Filters

Description

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.

Members
Accounts
Type: Array of strings

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.

InvoiceReceivers
Type: Array of strings

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.

Names
Type: Array of strings

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.

InternalServerException

Description

The processing request failed because of an unknown error, exception, or failure.

Members
message
Type: string
retryAfterSeconds
Type: int

The processing request failed because of an unknown error, exception, or failure.

InvoiceCurrencyAmount

Description

The amount charged after taxes, in the preferred currency.

Members
AmountBreakdown
Type: AmountBreakdown structure

Details about the invoice currency amount.

CurrencyCode
Type: string

The currency dominion of the invoice document.

CurrencyExchangeDetails
Type: CurrencyExchangeDetails structure

The details of currency exchange.

TotalAmount
Type: string

The invoice currency amount.

TotalAmountBeforeTax
Type: string

Details about the invoice total amount before tax.

InvoiceProfile

Description

Contains high-level information about the invoice receiver.

Members
AccountId
Type: string

The account ID the invoice profile is generated for.

Issuer
Type: string

This specifies the issuing entity of the invoice.

ReceiverAddress
Type: ReceiverAddress structure

The address of the receiver that will be printed on the invoice.

ReceiverEmail
Type: string

The email address for the invoice profile receiver.

ReceiverName
Type: string

The name of the person receiving the invoice profile.

TaxRegistrationNumber
Type: string

Your Tax Registration Number (TRN) information.

InvoiceSummariesFilter

Description

Filters for your invoice summaries.

Members
BillingPeriod
Type: BillingPeriod structure

The billing period associated with the invoice documents.

InvoicingEntity
Type: string

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

TimeInterval
Type: DateInterval structure

The date range for invoice summary retrieval.

InvoiceSummariesSelector

Description

Specifies the invoice summary.

Members
ResourceType
Required: Yes
Type: string

The query identifier type (INVOICE_ID or ACCOUNT_ID).

Value
Required: Yes
Type: string

The value of the query identifier.

InvoiceSummary

Description

The invoice that the API retrieved.

Members
AccountId
Type: string

The Amazon Web Services account ID.

BaseCurrencyAmount
Type: InvoiceCurrencyAmount structure

The summary with the product and service currency.

BillingPeriod
Type: BillingPeriod structure

The billing period of the invoice-related document.

DueDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The invoice due date.

Entity
Type: Entity structure

The organization name providing Amazon Web Services services.

InvoiceId
Type: string

The invoice ID.

InvoiceType
Type: string

The type of invoice.

IssuedDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The issued date of the invoice.

OriginalInvoiceId
Type: string

The initial or original invoice ID.

PaymentCurrencyAmount
Type: InvoiceCurrencyAmount structure

The summary with the customer configured currency.

PurchaseOrderNumber
Type: string

The purchase order number associated to the invoice.

TaxCurrencyAmount
Type: InvoiceCurrencyAmount structure

The summary with the tax currency.

InvoiceUnit

Description

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.

Members
Description
Type: string

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

InvoiceReceiver
Type: string

The account that receives invoices related to the invoice unit.

InvoiceUnitArn
Type: string

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

LastModified
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Name
Type: string

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

Rule
Type: InvoiceUnitRule structure

An InvoiceUnitRule object used the categorize invoice units.

TaxInheritanceDisabled
Type: boolean

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

InvoiceUnitRule

Description

This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT.

Members
LinkedAccounts
Type: Array of strings

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

ReceiverAddress

Description

The details of the address associated with the receiver.

Members
AddressLine1
Type: string

The first line of the address.

AddressLine2
Type: string

The second line of the address, if applicable.

AddressLine3
Type: string

The third line of the address, if applicable.

City
Type: string

The city that the address is in.

CompanyName
Type: string

A unique company name.

CountryCode
Type: string

The country code for the country the address is in.

DistrictOrCounty
Type: string

The district or country the address is located in.

PostalCode
Type: string

The postal code associated with the address.

StateOrRegion
Type: string

The state, region, or province the address is located.

ResourceNotFoundException

Description

The resource could not be found.

Members
message
Type: string
resourceName
Type: string

The resource could not be found.

ResourceTag

Description

The tag structure that contains a tag key and value.

Members
Key
Required: Yes
Type: string

The object key of your of your resource tag.

Value
Required: Yes
Type: string

The specific value of the resource tag.

ServiceQuotaExceededException

Description

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Members
message
Required: Yes
Type: string

TaxesBreakdown

Description

The details of the taxes.

Members
Breakdown
Type: Array of TaxesBreakdownAmount structures

A list of tax information.

TotalAmount
Type: string

The total amount for your taxes.

TaxesBreakdownAmount

Description

The tax amount.

Members
Amount
Type: string

The tax amount.

Description
Type: string

The details of the taxes.

Rate
Type: string

The details of the tax rate.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
fieldList
Type: Array of ValidationExceptionField structures

The input fails to satisfy the constraints specified by an Amazon Web Services service.

message
Type: string
reason
Type: string

You don't have sufficient access to perform this action.

resourceName
Type: string

You don't have sufficient access to perform this action.

ValidationExceptionField

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
message
Required: Yes
Type: string

The input fails to satisfy the constraints specified by an Amazon Web Services service.

name
Required: Yes
Type: string

The input fails to satisfy the constraints specified by an Amazon Web Services service.