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.
Amazon Web Services Procurement Portal Preferences
You can use Amazon Web Services Procurement Portal Preferences APIs to programmatically create, update, delete, get, and list procurement portal connections and e-invoice delivery settings. You can also programmatically fetch and modify the status of procurement portal configurations. For example, SAP Business Network or Coupa connections, configure e-invoice delivery and purchase order retrieval features.
You can use Amazon Web Services Procurement Portal Preferences to connect e-invoice delivery to your procurement portals based on your organizational needs. By using Amazon Web Services Procurement Portal Preferences, you can configure connections to SAP Business Network and Coupa procurement portals that retrieve purchase orders and deliver Amazon Web Services invoices on the same day they are generated. You can also set up testing environments to validate invoice delivery without affecting live transactions, and manage contact information for portal setup and support.
Administrative users should understand that billing read-only policies will show all procurement portal connection details. Review your IAM policies to ensure appropriate access controls are in place for procurement portal preferences.
Amazon Web Services Invoice Management
You can use Amazon Web Services Invoice Management APIs to programmatically list invoice summaries and get invoice documents. You can also programmatically fetch invoice documents with S3 pre-signed URLs.
You can use Amazon Web Services Invoice Management to access invoice information based on your organizational needs. By using Amazon Web Services Invoice Management, you can retrieve paginated lists of invoice summaries that include invoice metadata such as invoice IDs, amounts, and currencies without downloading documents. You can also download invoice documents in PDF format using S3 pre-signed URLs with built-in expiration. As you manage invoices across your organization using Amazon Web Services Invoice Management APIs, you can create invoice retrieval processes and integrate invoice data into your financial systems.
Service endpoint
You can use the following endpoints for Amazon Web Services Invoice Configuration, Amazon Web Services Procurement Portal Preferences, and Amazon Web Services Invoice Management:
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.
", "CreateProcurementPortalPreference": "Creates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval. This preference defines how invoices are delivered to a procurement portal and how purchase orders are retrieved.
", "DeleteInvoiceUnit": "This deletes an invoice unit with the provided invoice unit ARN.
", "DeleteProcurementPortalPreference": "Deletes an existing procurement portal preference. This action cannot be undone. Active e-invoice delivery and PO retrieval configurations will be terminated.
", "GetInvoicePDF": "Returns a URL to download the invoice document and supplemental documents associated with an invoice. The URLs are pre-signed and have expiration time. For special cases like Brazil, where Amazon Web Services generated invoice identifiers and government provided identifiers do not match, use the Amazon Web Services generated invoice identifier when making API requests. To grant IAM permission to use this operation, the caller needs the invoicing:GetInvoicePDF policy action.
This retrieves the invoice unit definition.
", "GetProcurementPortalPreference": "Retrieves the details of a specific procurement portal preference configuration.
", "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.
Retrieves a list of procurement portal preferences associated with the Amazon Web Services account.
", "ListTagsForResource": "Lists the tags for a resource.
", "PutProcurementPortalPreference": "Updates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.
", "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.
", "UpdateProcurementPortalPreferenceStatus": "Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.
" }, "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.
A list of Amazon Web Services account account IDs used to filter invoice units. These are payer accounts from other Organizations that have delegated their billing responsibility to the receiver account through the billing transfer feature.
" } }, "AccountIdString": { "base": null, "refs": { "AccountIdList$member": null, "CreateInvoiceUnitRequest$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.
", "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.
", "ProcurementPortalPreference$AwsAccountId": "The Amazon Web Services account ID associated with this procurement portal preference.
", "ProcurementPortalPreferenceSummary$AwsAccountId": "The Amazon Web Services account ID associated with this procurement portal preference summary.
", "RuleAccountIdList$member": null } }, "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.
", "ConflictException$message": null, "ConflictException$resourceId": "The identifier of the resource that caused the conflict.
", "ConflictException$resourceType": "The type of resource that caused the conflict.
", "Contact$Name": "The name of the contact person or role.
", "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.
", "ProcurementPortalPreference$EinvoiceDeliveryPreferenceStatusReason": "The reason for the current e-invoice delivery preference status.
", "ProcurementPortalPreference$PurchaseOrderRetrievalPreferenceStatusReason": "The reason for the current purchase order retrieval preference status.
", "ProcurementPortalPreferenceSummary$EinvoiceDeliveryPreferenceStatusReason": "The reason for the current e-invoice delivery preference status in this summary.
", "ProcurementPortalPreferenceSummary$PurchaseOrderRetrievalPreferenceStatusReason": "The reason for the current purchase order retrieval preference status in this summary.
", "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, "UpdateProcurementPortalPreferenceStatusRequest$EinvoiceDeliveryPreferenceStatusReason": "The reason for the e-invoice delivery preference status update, providing context for the change.
", "UpdateProcurementPortalPreferenceStatusRequest$PurchaseOrderRetrievalPreferenceStatusReason": "The reason for the purchase order retrieval preference status update, providing context for the change.
", "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": { "CreateProcurementPortalPreferenceRequest$BuyerIdentifier": "The unique identifier for the buyer in the procurement portal.
", "CreateProcurementPortalPreferenceRequest$SupplierIdentifier": "The unique identifier for the supplier in the procurement portal.
", "CreateProcurementPortalPreferenceRequest$ProcurementPortalInstanceEndpoint": "The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.
", "CreateProcurementPortalPreferenceRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
", "InvoiceProfile$ReceiverName": "The name of the person receiving the invoice profile.
", "InvoiceProfile$Issuer": "This specifies the issuing entity of the invoice.
", "ListProcurementPortalPreferencesRequest$NextToken": "The token for the next set of results. (You received this token from a previous call.)
", "ListProcurementPortalPreferencesResponse$NextToken": "The token to use to retrieve the next set of results, or null if there are no more results.
", "ProcurementPortalPreference$BuyerIdentifier": "The unique identifier for the buyer in the procurement portal.
", "ProcurementPortalPreference$SupplierIdentifier": "The unique identifier for the supplier in the procurement portal.
", "ProcurementPortalPreference$ProcurementPortalSharedSecret": "The shared secret or authentication credential used for secure communication with the procurement portal.
", "ProcurementPortalPreference$ProcurementPortalInstanceEndpoint": "The endpoint URL where e-invoices are delivered to the procurement portal.
", "ProcurementPortalPreference$PurchaseOrderRetrievalEndpoint": "The endpoint URL used for retrieving purchase orders from the procurement portal.
", "ProcurementPortalPreferenceSummary$BuyerIdentifier": "The unique identifier for the buyer in the procurement portal.
", "ProcurementPortalPreferenceSummary$SupplierIdentifier": "The unique identifier for the supplier in the procurement portal.
", "PutProcurementPortalPreferenceRequest$ProcurementPortalInstanceEndpoint": "The updated endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.
", "SellerOfRecords$member": null, "TestEnvPreference$BuyerIdentifier": "The unique identifier for the buyer in the test environment of the procurement portal.
", "TestEnvPreference$SupplierIdentifier": "The unique identifier for the supplier in the test environment of the procurement portal.
", "TestEnvPreference$ProcurementPortalSharedSecret": "The shared secret or authentication credential used for secure communication with the test environment.
", "TestEnvPreference$ProcurementPortalInstanceEndpoint": "The endpoint URL where e-invoices are delivered in the test environment.
", "TestEnvPreference$PurchaseOrderRetrievalEndpoint": "The endpoint URL used for retrieving purchase orders in the test environment.
", "TestEnvPreferenceInput$BuyerIdentifier": "The unique identifier to use for the buyer in the test environment.
", "TestEnvPreferenceInput$SupplierIdentifier": "The unique identifier to use for the supplier in the test environment.
", "TestEnvPreferenceInput$ProcurementPortalSharedSecret": "The shared secret or authentication credential to use for secure communication in the test environment.
", "TestEnvPreferenceInput$ProcurementPortalInstanceEndpoint": "The endpoint URL where e-invoices will be delivered in the test environment.
" } }, "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.
" } }, "Boolean": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$EinvoiceDeliveryEnabled": "Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.
", "CreateProcurementPortalPreferenceRequest$PurchaseOrderRetrievalEnabled": "Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.
", "ProcurementPortalPreference$EinvoiceDeliveryEnabled": "Indicates whether e-invoice delivery is enabled for this procurement portal preference.
", "ProcurementPortalPreference$PurchaseOrderRetrievalEnabled": "Indicates whether purchase order retrieval is enabled for this procurement portal preference.
", "ProcurementPortalPreferenceSummary$EinvoiceDeliveryEnabled": "Indicates whether e-invoice delivery is enabled for this procurement portal preference.
", "ProcurementPortalPreferenceSummary$PurchaseOrderRetrievalEnabled": "Indicates whether purchase order retrieval is enabled for this procurement portal preference.
", "PutProcurementPortalPreferenceRequest$EinvoiceDeliveryEnabled": "Updated flag indicating whether e-invoice delivery is enabled for this procurement portal preference.
", "PutProcurementPortalPreferenceRequest$PurchaseOrderRetrievalEnabled": "Updated flag indicating whether purchase order retrieval is enabled for this procurement portal preference.
" } }, "BuyerDomain": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$BuyerDomain": "The domain identifier for the buyer in the procurement portal.
", "ProcurementPortalPreference$BuyerDomain": "The domain identifier for the buyer in the procurement portal.
", "ProcurementPortalPreferenceSummary$BuyerDomain": "The domain identifier for the buyer in the procurement portal.
", "TestEnvPreference$BuyerDomain": "The domain identifier for the buyer in the test environment of the procurement portal.
", "TestEnvPreferenceInput$BuyerDomain": "The domain identifier to use for the buyer in the test environment.
" } }, "ConflictException": { "base": "The request could not be completed due to a conflict with the current state of the resource. This exception occurs when a concurrent modification is detected during an update operation, or when attempting to create a resource that already exists.
", "refs": {} }, "ConnectionTestingMethod": { "base": null, "refs": { "EinvoiceDeliveryPreference$ConnectionTestingMethod": "The method to use for testing the connection to the procurement portal.
" } }, "Contact": { "base": "Represents contact information for a person or role associated with the procurement portal preference.
", "refs": { "Contacts$member": null } }, "Contacts": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$Contacts": "List of contact information for portal administrators and technical contacts responsible for the e-invoice integration.
", "ProcurementPortalPreference$Contacts": "List of contact information for portal administrators and technical contacts.
", "PutProcurementPortalPreferenceRequest$Contacts": "Updated list of contact information for portal administrators and technical contacts.
" } }, "CreateInvoiceUnitRequest": { "base": null, "refs": {} }, "CreateInvoiceUnitResponse": { "base": null, "refs": {} }, "CreateProcurementPortalPreferenceRequest": { "base": null, "refs": {} }, "CreateProcurementPortalPreferenceResponse": { "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": {} }, "DeleteProcurementPortalPreferenceRequest": { "base": null, "refs": {} }, "DeleteProcurementPortalPreferenceResponse": { "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.
" } }, "EinvoiceDeliveryAttachmentType": { "base": null, "refs": { "EinvoiceDeliveryAttachmentTypes$member": null } }, "EinvoiceDeliveryAttachmentTypes": { "base": null, "refs": { "EinvoiceDeliveryPreference$EinvoiceDeliveryAttachmentTypes": "The types of attachments to include with the e-invoice delivery.
" } }, "EinvoiceDeliveryDocumentType": { "base": null, "refs": { "EinvoiceDeliveryDocumentTypes$member": null, "PurchaseOrderDataSource$EinvoiceDeliveryDocumentType": "The type of e-invoice document that requires purchase order data.
" } }, "EinvoiceDeliveryDocumentTypes": { "base": null, "refs": { "EinvoiceDeliveryPreference$EinvoiceDeliveryDocumentTypes": "The types of e-invoice documents to be delivered.
" } }, "EinvoiceDeliveryPreference": { "base": "Specifies the preferences for e-invoice delivery, including document types, attachment types, and customization settings.
", "refs": { "CreateProcurementPortalPreferenceRequest$EinvoiceDeliveryPreference": "Specifies the e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.
", "ProcurementPortalPreference$EinvoiceDeliveryPreference": "The configuration settings that specify how e-invoices are delivered to the procurement portal.
", "PutProcurementPortalPreferenceRequest$EinvoiceDeliveryPreference": "Updated e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.
" } }, "EmailString": { "base": null, "refs": { "Contact$Email": "The email address of the contact person or role.
" } }, "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.
" } }, "InvoicePDF": { "base": "Invoice document data.
", "refs": { "GetInvoicePDFResponse$InvoicePDF": "The invoice document and supplemental documents associated with the invoice.
" } }, "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.
", "InvoiceUnitArns$member": null, "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.
" } }, "InvoiceUnitArns": { "base": null, "refs": { "ProcurementPortalPreferenceSelector$InvoiceUnitArns": "The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.
" } }, "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 version number of the procurement portal preference configuration.
", "ProcurementPortalPreferenceSummary$Version": "The version number of the procurement portal preference configuration in this summary.
" } }, "MaxResults": { "base": null, "refs": { "ListProcurementPortalPreferencesRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
" } }, "MaxResultsInteger": { "base": null, "refs": { "ListInvoiceUnitsRequest$MaxResults": "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.
" } }, "ProcurementPortalName": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$ProcurementPortalName": "The name of the procurement portal.
", "ProcurementPortalPreference$ProcurementPortalName": "The name of the procurement portal.
", "ProcurementPortalPreferenceSummary$ProcurementPortalName": "The name of the procurement portal.
" } }, "ProcurementPortalPreference": { "base": "Represents the full configuration of a procurement portal preference, including settings for e-invoice delivery and purchase order retrieval.
", "refs": { "GetProcurementPortalPreferenceResponse$ProcurementPortalPreference": "The detailed configuration of the requested procurement portal preference.
" } }, "ProcurementPortalPreferenceArnString": { "base": null, "refs": { "CreateProcurementPortalPreferenceResponse$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the created procurement portal preference.
", "DeleteProcurementPortalPreferenceRequest$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference to delete.
", "DeleteProcurementPortalPreferenceResponse$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the deleted procurement portal preference.
", "GetProcurementPortalPreferenceRequest$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference to retrieve.
", "ProcurementPortalPreference$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference.
", "ProcurementPortalPreferenceSummary$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference.
", "PutProcurementPortalPreferenceRequest$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference to update.
", "PutProcurementPortalPreferenceResponse$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the updated procurement portal preference.
", "UpdateProcurementPortalPreferenceStatusRequest$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference to update.
", "UpdateProcurementPortalPreferenceStatusResponse$ProcurementPortalPreferenceArn": "The Amazon Resource Name (ARN) of the procurement portal preference with updated status.
" } }, "ProcurementPortalPreferenceSelector": { "base": "Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.
", "refs": { "CreateProcurementPortalPreferenceRequest$Selector": null, "ProcurementPortalPreference$Selector": null, "ProcurementPortalPreferenceSummary$Selector": null, "PutProcurementPortalPreferenceRequest$Selector": null } }, "ProcurementPortalPreferenceStatus": { "base": null, "refs": { "ProcurementPortalPreference$EinvoiceDeliveryPreferenceStatus": "The current status of the e-invoice delivery preference.
", "ProcurementPortalPreference$PurchaseOrderRetrievalPreferenceStatus": "The current status of the purchase order retrieval preference.
", "ProcurementPortalPreferenceSummary$EinvoiceDeliveryPreferenceStatus": "The current status of the e-invoice delivery preference in this summary.
", "ProcurementPortalPreferenceSummary$PurchaseOrderRetrievalPreferenceStatus": "The current status of the purchase order retrieval preference in this summary.
", "UpdateProcurementPortalPreferenceStatusRequest$EinvoiceDeliveryPreferenceStatus": "The updated status of the e-invoice delivery preference.
", "UpdateProcurementPortalPreferenceStatusRequest$PurchaseOrderRetrievalPreferenceStatus": "The updated status of the purchase order retrieval preference.
" } }, "ProcurementPortalPreferenceSummaries": { "base": null, "refs": { "ListProcurementPortalPreferencesResponse$ProcurementPortalPreferences": "The list of procurement portal preferences associated with the Amazon Web Services account.
" } }, "ProcurementPortalPreferenceSummary": { "base": "Provides a summary of a procurement portal preference, including key identifiers and status information.
", "refs": { "ProcurementPortalPreferenceSummaries$member": null } }, "ProfileList": { "base": null, "refs": { "BatchGetInvoiceProfileResponse$Profiles": "A list of invoice profiles corresponding to the requested accounts.
" } }, "Protocol": { "base": null, "refs": { "EinvoiceDeliveryPreference$Protocol": "The communication protocol to use for e-invoice delivery.
" } }, "PurchaseOrderDataSource": { "base": "Specifies the source configuration for retrieving purchase order data.
", "refs": { "PurchaseOrderDataSources$member": null } }, "PurchaseOrderDataSourceType": { "base": null, "refs": { "PurchaseOrderDataSource$PurchaseOrderDataSourceType": "The type of source for purchase order data.
" } }, "PurchaseOrderDataSources": { "base": null, "refs": { "EinvoiceDeliveryPreference$PurchaseOrderDataSources": "The sources of purchase order data to use for e-invoice generation and delivery.
" } }, "PutProcurementPortalPreferenceRequest": { "base": null, "refs": {} }, "PutProcurementPortalPreferenceResponse": { "base": null, "refs": {} }, "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.
", "CreateProcurementPortalPreferenceRequest$ResourceTags": "The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional 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.
" } }, "RuleAccountIdList": { "base": null, "refs": { "InvoiceUnitRule$LinkedAccounts": "The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.
A list of Amazon Web Services account account IDs that have delegated their billing responsibility to the receiver account through transfer billing. Unlike linked accounts, these bill source accounts can be payer accounts from other organizations that have authorized billing transfer to this account.
" } }, "SellerOfRecords": { "base": null, "refs": { "ProcurementPortalPreferenceSelector$SellerOfRecords": "The list of seller of record IDs to which this preference applies.
" } }, "SensitiveBasicStringWithoutSpace": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$ProcurementPortalSharedSecret": "The shared secret or authentication credential used to establish secure communication with the procurement portal. This value must be encrypted at rest.
", "InvoiceProfile$ReceiverEmail": "The email address for the invoice profile receiver.
", "InvoiceProfile$TaxRegistrationNumber": "Your Tax Registration Number (TRN) information.
", "PutProcurementPortalPreferenceRequest$ProcurementPortalSharedSecret": "The updated shared secret or authentication credential for the procurement portal. This value must be encrypted at rest.
" } }, "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": { "GetInvoicePDFRequest$InvoiceId": "Your unique invoice ID.
", "InvoicePDF$InvoiceId": "Your unique invoice ID.
", "InvoicePDF$DocumentUrl": "The pre-signed URL to download the invoice document.
", "InvoiceSummariesSelector$Value": "The value of the query identifier.
", "SupplementalDocument$DocumentUrl": "The pre-signed URL to download invoice supplemental document.
" } }, "SupplementalDocument": { "base": "Supplemental document associated with the invoice.
", "refs": { "SupplementalDocuments$member": null } }, "SupplementalDocuments": { "base": null, "refs": { "InvoicePDF$SupplementalDocuments": "List of supplemental documents associated with the invoice.
" } }, "SupplierDomain": { "base": null, "refs": { "CreateProcurementPortalPreferenceRequest$SupplierDomain": "The domain identifier for the supplier in the procurement portal.
", "ProcurementPortalPreference$SupplierDomain": "The domain identifier for the supplier in the procurement portal.
", "ProcurementPortalPreferenceSummary$SupplierDomain": "The domain identifier for the supplier in the procurement portal.
", "TestEnvPreference$SupplierDomain": "The domain identifier for the supplier in the test environment of the procurement portal.
", "TestEnvPreferenceInput$SupplierDomain": "The domain identifier to use for the supplier in the test environment.
" } }, "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.
" } }, "TestEnvPreference": { "base": "Contains configuration settings for testing the procurement portal integration in a non-production environment.
", "refs": { "ProcurementPortalPreference$TestEnvPreference": "Configuration on settings for the test environment of the procurement portal.
" } }, "TestEnvPreferenceInput": { "base": "Input parameters for configuring test environment preferences for a procurement portal.
", "refs": { "CreateProcurementPortalPreferenceRequest$TestEnvPreference": "Configuration settings for the test environment of the procurement portal. Includes test credentials and endpoints that are used for validation before production deployment.
", "PutProcurementPortalPreferenceRequest$TestEnvPreference": "Updated configuration settings for the test environment of the procurement portal.
" } }, "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 date when e-invoice delivery should be activated for this preference.
", "InvoicePDF$DocumentUrlExpirationDate": "The pre-signed URL expiration date of the invoice document.
", "InvoiceSummary$IssuedDate": "The issued date of the invoice.
", "InvoiceSummary$DueDate": "The invoice due date.
", "ProcurementPortalPreference$CreateDate": "The date and time when the procurement portal preference was created.
", "ProcurementPortalPreference$LastUpdateDate": "The date and time when the procurement portal preference was last updated.
", "ProcurementPortalPreferenceSummary$CreateDate": "The date and time when the procurement portal preference was created.
", "ProcurementPortalPreferenceSummary$LastUpdateDate": "The date and time when the procurement portal preference was last updated.
", "SupplementalDocument$DocumentUrlExpirationDate": "The pre-signed URL expiration date of invoice supplemental document.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateInvoiceUnitRequest": { "base": null, "refs": {} }, "UpdateInvoiceUnitResponse": { "base": null, "refs": {} }, "UpdateProcurementPortalPreferenceStatusRequest": { "base": null, "refs": {} }, "UpdateProcurementPortalPreferenceStatusResponse": { "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.
" } } } }