Amazon Web Services Invoice Configuration
You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts.
You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
Service endpoint
You can use the following endpoints for Amazon Web Services Invoice Configuration:
https://invoicing.us-east-1.api.aws
This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
", "CreateInvoiceUnit": "This creates a new invoice unit with the provided definition.
", "DeleteInvoiceUnit": "This deletes an invoice unit with the provided invoice unit ARN.
", "GetInvoiceUnit": "This retrieves the invoice unit definition.
", "ListInvoiceSummaries": "Retrieves your invoice details programmatically, without line item details.
", "ListInvoiceUnits": "This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.
Lists the tags for a resource.
", "TagResource": "Adds a tag to a resource.
", "UntagResource": "Removes a tag from a resource.
", "UpdateInvoiceUnit": "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.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have sufficient access to perform this action.
", "refs": { } }, "AccountIdList": { "base": null, "refs": { "BatchGetInvoiceProfileRequest$AccountIds": "Retrieves the corresponding invoice profile data for these account IDs.
", "Filters$InvoiceReceivers": " 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.
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.
The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.
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.
", "GetInvoiceUnitResponse$InvoiceReceiver": "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.
", "InvoiceProfile$AccountId": "The account ID the invoice profile is generated for.
", "InvoiceSummary$AccountId": "The Amazon Web Services account ID.
", "InvoiceUnit$InvoiceReceiver": "The account that receives invoices related to the invoice unit.
" } }, "AmountBreakdown": { "base": "Details about how the total amount was calculated and categorized.
", "refs": { "InvoiceCurrencyAmount$AmountBreakdown": "Details about the invoice currency amount.
" } }, "AsOfTimestamp": { "base": null, "refs": { "GetInvoiceUnitRequest$AsOf": " 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.
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.
The total of a set of the breakdown.
", "CurrencyExchangeDetails$SourceCurrencyCode": "The exchange source currency.
", "CurrencyExchangeDetails$TargetCurrencyCode": "The exchange target currency.
", "CurrencyExchangeDetails$Rate": "The currency exchange rate.
", "DiscountsBreakdown$TotalAmount": "The discount's total amount.
", "DiscountsBreakdownAmount$Description": "The list of discounts information.
", "DiscountsBreakdownAmount$Amount": "The discounted amount.
", "DiscountsBreakdownAmount$Rate": "The details for the discount rate..
", "Entity$InvoicingEntity": "The name of the entity that issues the Amazon Web Services invoice.
", "FeesBreakdown$TotalAmount": "The total amount of fees.
", "FeesBreakdownAmount$Description": "The list of fees information.
", "FeesBreakdownAmount$Amount": "The fee amount.
", "FeesBreakdownAmount$Rate": "Details about the rate amount.
", "InternalServerException$message": null, "InvoiceCurrencyAmount$TotalAmount": "The invoice currency amount.
", "InvoiceCurrencyAmount$TotalAmountBeforeTax": "Details about the invoice total amount before tax.
", "InvoiceSummariesFilter$InvoicingEntity": "The name of the entity that issues the Amazon Web Services invoice.
", "InvoiceSummary$InvoiceId": "The invoice ID.
", "InvoiceSummary$OriginalInvoiceId": "The initial or original invoice ID.
", "InvoiceSummary$PurchaseOrderNumber": "The purchase order number associated to the invoice.
", "ReceiverAddress$AddressLine1": "The first line of the address.
", "ReceiverAddress$AddressLine2": "The second line of the address, if applicable.
", "ReceiverAddress$AddressLine3": "The third line of the address, if applicable.
", "ReceiverAddress$DistrictOrCounty": "The district or country the address is located in.
", "ReceiverAddress$City": "The city that the address is in.
", "ReceiverAddress$StateOrRegion": "The state, region, or province the address is located.
", "ReceiverAddress$CountryCode": "The country code for the country the address is in.
", "ReceiverAddress$CompanyName": "A unique company name.
", "ReceiverAddress$PostalCode": "The postal code associated with the address.
", "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "TaxesBreakdown$TotalAmount": "The total amount for your taxes.
", "TaxesBreakdownAmount$Description": "The details of the taxes.
", "TaxesBreakdownAmount$Amount": "The tax amount.
", "TaxesBreakdownAmount$Rate": "The details of the tax rate.
", "ThrottlingException$message": null, "ValidationException$message": null, "ValidationExceptionField$name": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "ValidationExceptionField$message": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "BasicStringWithoutSpace": { "base": null, "refs": { "InvoiceProfile$ReceiverName": "The name of the person receiving the invoice profile.
", "InvoiceProfile$Issuer": "This specifies the issuing entity of the invoice.
" } }, "BatchGetInvoiceProfileRequest": { "base": null, "refs": { } }, "BatchGetInvoiceProfileResponse": { "base": null, "refs": { } }, "BillingPeriod": { "base": "The billing period for which you want to retrieve invoice-related documents.
", "refs": { "InvoiceSummariesFilter$BillingPeriod": "The billing period associated with the invoice documents.
", "InvoiceSummary$BillingPeriod": "The billing period of the invoice-related document.
" } }, "CreateInvoiceUnitRequest": { "base": null, "refs": { } }, "CreateInvoiceUnitResponse": { "base": null, "refs": { } }, "CurrencyCode": { "base": null, "refs": { "InvoiceCurrencyAmount$CurrencyCode": "The currency dominion of the invoice document.
" } }, "CurrencyExchangeDetails": { "base": "The details of currency exchange.
", "refs": { "InvoiceCurrencyAmount$CurrencyExchangeDetails": "The details of currency exchange.
" } }, "DateInterval": { "base": "The time period that you want invoice-related documents for.
", "refs": { "InvoiceSummariesFilter$TimeInterval": "The date range for invoice summary retrieval.
" } }, "DeleteInvoiceUnitRequest": { "base": null, "refs": { } }, "DeleteInvoiceUnitResponse": { "base": null, "refs": { } }, "DescriptionString": { "base": null, "refs": { "CreateInvoiceUnitRequest$Description": "The invoice unit's description. This can be changed at a later time.
", "GetInvoiceUnitResponse$Description": "The assigned description for an invoice unit.
", "InvoiceUnit$Description": "The assigned description for an invoice unit. This information can't be modified or deleted.
", "UpdateInvoiceUnitRequest$Description": "The assigned description for an invoice unit. This information can't be modified or deleted.
" } }, "DiscountsBreakdown": { "base": "The discounts details.
", "refs": { "AmountBreakdown$Discounts": "The discounted amount.
" } }, "DiscountsBreakdownAmount": { "base": "The discounted amount.
", "refs": { "DiscountsBreakdownAmountList$member": null } }, "DiscountsBreakdownAmountList": { "base": null, "refs": { "DiscountsBreakdown$Breakdown": "The list of discounts information.
" } }, "Entity": { "base": "The organization name providing Amazon Web Services services.
", "refs": { "InvoiceSummary$Entity": "The organization name providing Amazon Web Services services.
" } }, "FeesBreakdown": { "base": "The details of fees.
", "refs": { "AmountBreakdown$Fees": "The fee amount.
" } }, "FeesBreakdownAmount": { "base": "The fee amount.
", "refs": { "FeesBreakdownAmountList$member": null } }, "FeesBreakdownAmountList": { "base": null, "refs": { "FeesBreakdown$Breakdown": "The list of fees information.
" } }, "Filters": { "base": "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.
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.
The processing request failed because of an unknown error, exception, or failure.
" } }, "InternalServerException": { "base": "The processing request failed because of an unknown error, exception, or failure.
", "refs": { } }, "InvoiceCurrencyAmount": { "base": "The amount charged after taxes, in the preferred currency.
", "refs": { "InvoiceSummary$BaseCurrencyAmount": "The summary with the product and service currency.
", "InvoiceSummary$TaxCurrencyAmount": "The summary with the tax currency.
", "InvoiceSummary$PaymentCurrencyAmount": "The summary with the customer configured currency.
" } }, "InvoiceProfile": { "base": "Contains high-level information about the invoice receiver.
", "refs": { "ProfileList$member": null } }, "InvoiceSummaries": { "base": null, "refs": { "ListInvoiceSummariesResponse$InvoiceSummaries": "List of key (summary level) invoice details without line item details.
" } }, "InvoiceSummariesFilter": { "base": "Filters for your invoice summaries.
", "refs": { "ListInvoiceSummariesRequest$Filter": "Filters you can use to customize your invoice summary.
" } }, "InvoiceSummariesMaxResults": { "base": null, "refs": { "ListInvoiceSummariesRequest$MaxResults": "The maximum number of invoice summaries a paginated response can contain.
" } }, "InvoiceSummariesSelector": { "base": "Specifies the invoice summary.
", "refs": { "ListInvoiceSummariesRequest$Selector": "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.
" } }, "InvoiceSummary": { "base": "The invoice that the API retrieved.
", "refs": { "InvoiceSummaries$member": null } }, "InvoiceType": { "base": null, "refs": { "InvoiceSummary$InvoiceType": "The type of invoice.
" } }, "InvoiceUnit": { "base": "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.
", "refs": { "InvoiceUnits$member": null } }, "InvoiceUnitArnString": { "base": null, "refs": { "AccessDeniedException$resourceName": "You don't have sufficient access to perform this action.
", "CreateInvoiceUnitResponse$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "DeleteInvoiceUnitRequest$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "DeleteInvoiceUnitResponse$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "GetInvoiceUnitRequest$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "GetInvoiceUnitResponse$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "InvoiceUnit$InvoiceUnitArn": "ARN to identify an invoice unit. This information can't be modified or deleted.
", "ResourceNotFoundException$resourceName": "The resource could not be found.
", "UpdateInvoiceUnitRequest$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "UpdateInvoiceUnitResponse$InvoiceUnitArn": "The ARN to identify an invoice unit. This information can't be modified or deleted.
", "ValidationException$resourceName": "You don't have sufficient access to perform this action.
" } }, "InvoiceUnitName": { "base": null, "refs": { "CreateInvoiceUnitRequest$Name": "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.
", "GetInvoiceUnitResponse$Name": "The unique name of the invoice unit that is shown on the generated invoice.
", "InvoiceUnit$Name": "A unique name that is distinctive within your Amazon Web Services.
", "InvoiceUnitNames$member": null } }, "InvoiceUnitNames": { "base": null, "refs": { "Filters$Names": " 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.
This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT.
The InvoiceUnitRule object used to create invoice units.
An InvoiceUnitRule object used the categorize invoice units.
The InvoiceUnitRule object used to update invoice units.
An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.
" } }, "LastModifiedTimestamp": { "base": null, "refs": { "GetInvoiceUnitResponse$LastModified": "The most recent date the invoice unit response was updated.
", "InvoiceUnit$LastModified": "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.
" } }, "ListInvoiceSummariesRequest": { "base": null, "refs": { } }, "ListInvoiceSummariesResourceType": { "base": null, "refs": { "InvoiceSummariesSelector$ResourceType": "The query identifier type (INVOICE_ID or ACCOUNT_ID).
The maximum number of invoice units that can be returned.
" } }, "Month": { "base": null, "refs": { "BillingPeriod$Month": "The billing period month.
" } }, "NextTokenString": { "base": null, "refs": { "ListInvoiceSummariesRequest$NextToken": "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.
", "ListInvoiceSummariesResponse$NextToken": "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.
", "ListInvoiceUnitsRequest$NextToken": "The next token used to indicate where the returned list should start from.
", "ListInvoiceUnitsResponse$NextToken": "The next token used to indicate where the returned list should start from.
" } }, "ProfileList": { "base": null, "refs": { "BatchGetInvoiceProfileResponse$Profiles": "A list of invoice profiles corresponding to the requested accounts.
" } }, "ReceiverAddress": { "base": "The details of the address associated with the receiver.
", "refs": { "InvoiceProfile$ReceiverAddress": "The address of the receiver that will be printed on the invoice.
" } }, "ResourceNotFoundException": { "base": "The resource could not be found.
", "refs": { } }, "ResourceTag": { "base": "The tag structure that contains a tag key and value.
", "refs": { "ResourceTagList$member": null } }, "ResourceTagKey": { "base": null, "refs": { "ResourceTag$Key": "The object key of your of your resource tag.
", "ResourceTagKeyList$member": null } }, "ResourceTagKeyList": { "base": null, "refs": { "UntagResourceRequest$ResourceTagKeys": "Keys for the tags to be removed.
" } }, "ResourceTagList": { "base": null, "refs": { "CreateInvoiceUnitRequest$ResourceTags": "The tag structure that contains a tag key and value.
", "ListTagsForResourceResponse$ResourceTags": "Adds a tag to a resource.
", "TagResourceRequest$ResourceTags": "Adds a tag to a resource.
" } }, "ResourceTagValue": { "base": null, "refs": { "ResourceTag$Value": "The specific value of the resource tag.
" } }, "SensitiveBasicStringWithoutSpace": { "base": null, "refs": { "InvoiceProfile$ReceiverEmail": "The email address for the invoice profile receiver.
", "InvoiceProfile$TaxRegistrationNumber": "Your Tax Registration Number (TRN) information.
" } }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { } }, "StringWithoutNewLine": { "base": null, "refs": { "InvoiceSummariesSelector$Value": "The value of the query identifier.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagrisArn": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of tags to list.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the tags.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) to untag.
" } }, "TaxInheritanceDisabledFlag": { "base": null, "refs": { "CreateInvoiceUnitRequest$TaxInheritanceDisabled": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "GetInvoiceUnitResponse$TaxInheritanceDisabled": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "InvoiceUnit$TaxInheritanceDisabled": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "UpdateInvoiceUnitRequest$TaxInheritanceDisabled": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
" } }, "TaxesBreakdown": { "base": "The details of the taxes.
", "refs": { "AmountBreakdown$Taxes": "The tax amount.
" } }, "TaxesBreakdownAmount": { "base": "The tax amount.
", "refs": { "TaxesBreakdownAmountList$member": null } }, "TaxesBreakdownAmountList": { "base": null, "refs": { "TaxesBreakdown$Breakdown": "A list of tax information.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "DateInterval$StartDate": " 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.
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.
The issued date of the invoice.
", "InvoiceSummary$DueDate": "The invoice due date.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateInvoiceUnitRequest": { "base": null, "refs": { } }, "UpdateInvoiceUnitResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": { } }, "ValidationExceptionField": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "You don't have sufficient access to perform this action.
" } }, "Year": { "base": null, "refs": { "BillingPeriod$Year": "The billing period year.
" } } } }