{ "smithy": "2.0", "shapes": { "com.amazonaws.invoicing#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString" }, "resourceName": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingAccessDenied", "httpResponseCode": 403 }, "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.invoicing#AccountIdList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#AccountIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.invoicing#AccountIdString": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.invoicing#AmountBreakdown": { "type": "structure", "members": { "SubTotalAmount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The total of a set of the breakdown.

" } }, "Discounts": { "target": "com.amazonaws.invoicing#DiscountsBreakdown", "traits": { "smithy.api#documentation": "

The discounted amount.

" } }, "Taxes": { "target": "com.amazonaws.invoicing#TaxesBreakdown", "traits": { "smithy.api#documentation": "

The tax amount.

" } }, "Fees": { "target": "com.amazonaws.invoicing#FeesBreakdown", "traits": { "smithy.api#documentation": "

The fee amount.

" } } }, "traits": { "smithy.api#documentation": "

Details about how the total amount was calculated and categorized.

" } }, "com.amazonaws.invoicing#AsOfTimestamp": { "type": "timestamp" }, "com.amazonaws.invoicing#BasicString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.invoicing#BasicStringWithoutSpace": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.invoicing#BatchGetInvoiceProfile": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#BatchGetInvoiceProfileRequest" }, "output": { "target": "com.amazonaws.invoicing#BatchGetInvoiceProfileResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "BatchGetInvoiceProfile", "input": { "AccountIds": [ "111111111111" ] }, "output": { "Profiles": [ { "AccountId": "111111111111", "Issuer": "Test", "ReceiverAddress": { "AddressLine1": "Test", "City": "Test", "CountryCode": "LU", "PostalCode": "Test", "StateOrRegion": "Test" }, "ReceiverEmail": "test@amazon.com", "ReceiverName": "TestAccount" } ] } } ], "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#BatchGetInvoiceProfileRequest": { "type": "structure", "members": { "AccountIds": { "target": "com.amazonaws.invoicing#AccountIdList", "traits": { "smithy.api#documentation": "

Retrieves the corresponding invoice profile data for these account IDs.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#BatchGetInvoiceProfileResponse": { "type": "structure", "members": { "Profiles": { "target": "com.amazonaws.invoicing#ProfileList", "traits": { "smithy.api#documentation": "

A list of invoice profiles corresponding to the requested accounts.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#BillSourceAccountList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#AccountIdString" } }, "com.amazonaws.invoicing#BillType": { "type": "enum", "members": { "ANNIVERSARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANNIVERSARY" } }, "PURCHASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PURCHASE" } }, "REFUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFUND" } } } }, "com.amazonaws.invoicing#BillingEntity": { "type": "enum", "members": { "AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS" } }, "AWS_MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MARKETPLACE" } } } }, "com.amazonaws.invoicing#BillingPeriod": { "type": "structure", "members": { "Month": { "target": "com.amazonaws.invoicing#Month", "traits": { "smithy.api#documentation": "

The billing period month.

", "smithy.api#required": {} } }, "Year": { "target": "com.amazonaws.invoicing#Year", "traits": { "smithy.api#documentation": "

The billing period year.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.invoicing#BuyerDomain": { "type": "enum", "members": { "NetworkID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkID" } } } }, "com.amazonaws.invoicing#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString" }, "resourceId": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The identifier of the resource that caused the conflict.

" } }, "resourceType": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The type of resource that caused the conflict.

" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingConflict", "httpResponseCode": 409 }, "smithy.api#documentation": "

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.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.invoicing#ConnectionTestingMethod": { "type": "enum", "members": { "PROD_ENV_DOLLAR_TEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROD_ENV_DOLLAR_TEST" } }, "TEST_ENV_REPLAY_TEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_ENV_REPLAY_TEST" } } } }, "com.amazonaws.invoicing#Contact": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The name of the contact person or role.

" } }, "Email": { "target": "com.amazonaws.invoicing#EmailString", "traits": { "smithy.api#documentation": "

The email address of the contact person or role.

" } } }, "traits": { "smithy.api#documentation": "

Represents contact information for a person or role associated with the procurement portal preference.

", "smithy.api#sensitive": {} } }, "com.amazonaws.invoicing#Contacts": { "type": "list", "member": { "target": "com.amazonaws.invoicing#Contact" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.invoicing#CountryCode": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 2 }, "smithy.api#pattern": "^[A-Z]{2}$" } }, "com.amazonaws.invoicing#CreateInvoiceUnit": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#CreateInvoiceUnitRequest" }, "output": { "target": "com.amazonaws.invoicing#CreateInvoiceUnitResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This creates a new invoice unit with the provided definition.

", "smithy.api#examples": [ { "title": "CreateInvoiceUnit", "input": { "Name": "Example Invoice Unit", "InvoiceReceiver": "111111111111", "Description": "Example Invoice Unit Description", "TaxInheritanceDisabled": false, "Rule": { "LinkedAccounts": [ "222222222222" ] }, "ResourceTags": [ { "Key": "TagKey", "Value": "TagValue" } ], "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b42" }, "output": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#CreateInvoiceUnitRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.invoicing#InvoiceUnitName", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "InvoiceReceiver": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.invoicing#DescriptionString", "traits": { "smithy.api#documentation": "

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

" } }, "TaxInheritanceDisabled": { "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

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

" } }, "Rule": { "target": "com.amazonaws.invoicing#InvoiceUnitRule", "traits": { "smithy.api#documentation": "

The InvoiceUnitRule object used to create invoice units.

", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.invoicing#ResourceTagList", "traits": { "smithy.api#documentation": "

The tag structure that contains a tag key and value.

" } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#CreateInvoiceUnitResponse": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#CreateProcurementPortalPreference": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#CreateProcurementPortalPreferenceRequest" }, "output": { "target": "com.amazonaws.invoicing#CreateProcurementPortalPreferenceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

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.

", "smithy.api#examples": [ { "title": "CreateProcurementPortalPreference for Coupa", "input": { "ProcurementPortalName": "COUPA", "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1", "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345678", "arn:aws:invoicing::111111111111:invoice-unit/12345679" ], "SellerOfRecords": [ "AWS_INC", "AWS_EUROPE" ] }, "ProcurementPortalSharedSecret": "Coupa_Secret", "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test", "TestEnvPreference": { "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1_Test", "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1_Test", "ProcurementPortalSharedSecret": "Coupa_Secret_test", "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test" }, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreference": { "EinvoiceDeliveryDocumentTypes": [ "AWS_CLOUD_INVOICE" ], "EinvoiceDeliveryAttachmentTypes": [ "INVOICE_PDF" ], "Protocol": "CXML", "PurchaseOrderDataSources": [ { "EinvoiceDeliveryDocumentType": "AWS_CLOUD_INVOICE", "PurchaseOrderDataSourceType": "ASSOCIATED_PURCHASE_ORDER_REQUIRED" } ], "ConnectionTestingMethod": "PROD_ENV_DOLLAR_TEST", "EinvoiceDeliveryActivationDate": 1750279280.091 }, "PurchaseOrderRetrievalEnabled": true, "MarketplacePunchOutEnabled": true, "MarketplacePunchOutPreference": { "ApprovalRequestRedirectUrl": "https://www.placeholder-domain.test/approvals" }, "Contacts": [ { "Name": "John Doe", "Email": "example-placeholder@amazon.com" } ], "ResourceTags": [ { "Key": "testKey", "Value": "testValue" } ], "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b42" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/a34fd666-7810-4414-9360-aaa4bcab0abd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#CreateProcurementPortalPreferenceRequest": { "type": "structure", "members": { "ProcurementPortalName": { "target": "com.amazonaws.invoicing#ProcurementPortalName", "traits": { "smithy.api#documentation": "

The name of the procurement portal.

", "smithy.api#required": {} } }, "BuyerDomain": { "target": "com.amazonaws.invoicing#BuyerDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "BuyerIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "SupplierDomain": { "target": "com.amazonaws.invoicing#SupplierDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "SupplierIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "Selector": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSelector" }, "ProcurementPortalSharedSecret": { "target": "com.amazonaws.invoicing#SensitiveBasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The shared secret or authentication credential used to establish secure communication with the procurement portal. This value must be encrypted at rest.

" } }, "ProcurementPortalInstanceEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.

" } }, "TestEnvPreference": { "target": "com.amazonaws.invoicing#TestEnvPreferenceInput", "traits": { "smithy.api#documentation": "

Configuration settings for the test environment of the procurement portal. Includes test credentials and endpoints that are used for validation before production deployment.

" } }, "EinvoiceDeliveryEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.

", "smithy.api#required": {} } }, "EinvoiceDeliveryPreference": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryPreference", "traits": { "smithy.api#documentation": "

Specifies the e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.

" } }, "PurchaseOrderRetrievalEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.

", "smithy.api#required": {} } }, "MarketplacePunchOutEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Defaults to false if not provided." } }, "MarketplacePunchOutPreference": { "target": "com.amazonaws.invoicing#MarketplacePunchOutPreference", "traits": { "smithy.api#documentation": "Required for Coupa when MarketplacePunchOutEnabled is true." } }, "Contacts": { "target": "com.amazonaws.invoicing#Contacts", "traits": { "smithy.api#documentation": "

List of contact information for portal administrators and technical contacts responsible for the e-invoice integration.

", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.invoicing#ResourceTagList", "traits": { "smithy.api#documentation": "

The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional value.

" } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#CreateProcurementPortalPreferenceResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created procurement portal preference.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#CurrencyCode": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 3 } } }, "com.amazonaws.invoicing#CurrencyExchangeDetails": { "type": "structure", "members": { "SourceCurrencyCode": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The exchange source currency.

" } }, "TargetCurrencyCode": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The exchange target currency.

" } }, "Rate": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The currency exchange rate.

" } } }, "traits": { "smithy.api#documentation": "

The details of currency exchange.

" } }, "com.amazonaws.invoicing#DateInterval": { "type": "structure", "members": { "StartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "EndDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.invoicing#DeleteInvoiceUnit": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#DeleteInvoiceUnitRequest" }, "output": { "target": "com.amazonaws.invoicing#DeleteInvoiceUnitResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "DeleteInvoiceUnit", "input": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b44" }, "output": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#DeleteInvoiceUnitRequest": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#DeleteInvoiceUnitResponse": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#DeleteProcurementPortalPreference": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#DeleteProcurementPortalPreferenceRequest" }, "output": { "target": "com.amazonaws.invoicing#DeleteProcurementPortalPreferenceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Deletes an existing procurement portal preference. This action cannot be undone. Active e-invoice delivery and PO retrieval configurations will be terminated.

", "smithy.api#examples": [ { "title": "DeleteProcurementPortalPreference call", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd", "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b47" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#DeleteProcurementPortalPreferenceRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to delete.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#DeleteProcurementPortalPreferenceResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted procurement portal preference.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#DescriptionString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.invoicing#DiscountsBreakdown": { "type": "structure", "members": { "Breakdown": { "target": "com.amazonaws.invoicing#DiscountsBreakdownAmountList", "traits": { "smithy.api#documentation": "

The list of discounts information.

" } }, "TotalAmount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The discount's total amount.

" } } }, "traits": { "smithy.api#documentation": "

The discounts details.

" } }, "com.amazonaws.invoicing#DiscountsBreakdownAmount": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The list of discounts information.

" } }, "Amount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The discounted amount.

" } }, "Rate": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The details for the discount rate..

" } } }, "traits": { "smithy.api#documentation": "

The discounted amount.

" } }, "com.amazonaws.invoicing#DiscountsBreakdownAmountList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#DiscountsBreakdownAmount" } }, "com.amazonaws.invoicing#EinvoiceDeliveryAttachmentType": { "type": "enum", "members": { "INVOICE_PDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOICE_PDF" } }, "RFP_PDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RFP_PDF" } } } }, "com.amazonaws.invoicing#EinvoiceDeliveryAttachmentTypes": { "type": "list", "member": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryAttachmentType" } }, "com.amazonaws.invoicing#EinvoiceDeliveryDocumentType": { "type": "enum", "members": { "AWS_CLOUD_INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_CLOUD_INVOICE" } }, "AWS_CLOUD_CREDIT_MEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_CLOUD_CREDIT_MEMO" } }, "AWS_MARKETPLACE_INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MARKETPLACE_INVOICE" } }, "AWS_MARKETPLACE_CREDIT_MEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MARKETPLACE_CREDIT_MEMO" } }, "AWS_REQUEST_FOR_PAYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_REQUEST_FOR_PAYMENT" } } } }, "com.amazonaws.invoicing#EinvoiceDeliveryDocumentTypes": { "type": "list", "member": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryDocumentType" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.invoicing#EinvoiceDeliveryPreference": { "type": "structure", "members": { "EinvoiceDeliveryDocumentTypes": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryDocumentTypes", "traits": { "smithy.api#documentation": "

The types of e-invoice documents to be delivered.

", "smithy.api#required": {} } }, "EinvoiceDeliveryAttachmentTypes": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryAttachmentTypes", "traits": { "smithy.api#documentation": "

The types of attachments to include with the e-invoice delivery.

" } }, "Protocol": { "target": "com.amazonaws.invoicing#Protocol", "traits": { "smithy.api#documentation": "

The communication protocol to use for e-invoice delivery.

", "smithy.api#required": {} } }, "PurchaseOrderDataSources": { "target": "com.amazonaws.invoicing#PurchaseOrderDataSources", "traits": { "smithy.api#documentation": "

The sources of purchase order data to use for e-invoice generation and delivery.

", "smithy.api#required": {} } }, "ConnectionTestingMethod": { "target": "com.amazonaws.invoicing#ConnectionTestingMethod", "traits": { "smithy.api#documentation": "

The method to use for testing the connection to the procurement portal.

", "smithy.api#required": {} } }, "EinvoiceDeliveryActivationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date when e-invoice delivery should be activated for this preference.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the preferences for e-invoice delivery, including document types, attachment types, and customization settings.

" } }, "com.amazonaws.invoicing#EinvoiceDeliveryStatus": { "type": "enum", "members": { "DELIVERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELIVERED" } }, "NOT_DELIVERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_DELIVERED" } } } }, "com.amazonaws.invoicing#EmailString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" } }, "com.amazonaws.invoicing#Entity": { "type": "structure", "members": { "InvoicingEntity": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

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

" } }, "BillingEntity": { "target": "com.amazonaws.invoicing#BillingEntity", "traits": { "smithy.api#documentation": "

Helps you identify whether your invoices are for Amazon Web Services Marketplace or for purchases of other Amazon Web Services services.

" } } }, "traits": { "smithy.api#documentation": "

The organization name providing Amazon Web Services services.

" } }, "com.amazonaws.invoicing#FeatureConfigurations": { "type": "structure", "members": { "InvoiceConfiguration": { "target": "com.amazonaws.invoicing#InvoiceConfiguration", "traits": { "smithy.api#documentation": "

The invoice configuration settings for the procurement portal.

" } } }, "traits": { "smithy.api#documentation": "

Contains the default feature configuration settings for a procurement portal.

" } }, "com.amazonaws.invoicing#FeesBreakdown": { "type": "structure", "members": { "Breakdown": { "target": "com.amazonaws.invoicing#FeesBreakdownAmountList", "traits": { "smithy.api#documentation": "

The list of fees information.

" } }, "TotalAmount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The total amount of fees.

" } } }, "traits": { "smithy.api#documentation": "

The details of fees.

" } }, "com.amazonaws.invoicing#FeesBreakdownAmount": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The list of fees information.

" } }, "Amount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The fee amount.

" } }, "Rate": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

Details about the rate amount.

" } } }, "traits": { "smithy.api#documentation": "

The fee amount.

" } }, "com.amazonaws.invoicing#FeesBreakdownAmountList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#FeesBreakdownAmount" } }, "com.amazonaws.invoicing#Filters": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.invoicing#InvoiceUnitNames", "traits": { "smithy.api#documentation": "

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.

" } }, "InvoiceReceivers": { "target": "com.amazonaws.invoicing#AccountIdList", "traits": { "smithy.api#documentation": "

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.

" } }, "Accounts": { "target": "com.amazonaws.invoicing#AccountIdList", "traits": { "smithy.api#documentation": "

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.

" } }, "BillSourceAccounts": { "target": "com.amazonaws.invoicing#AccountIdList", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services 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.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.invoicing#GetInvoicePDF": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#GetInvoicePDFRequest" }, "output": { "target": "com.amazonaws.invoicing#GetInvoicePDFResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "GetInvoicePDF without supplemental documents", "input": { "InvoiceId": "abc123" }, "output": { "InvoicePDF": { "InvoiceId": "abc123", "DocumentUrl": "https://abcd123.com?securityTokenForDoc", "DocumentUrlExpirationDate": "2025-04-01T01:00:00.000Z", "SupplementalDocuments": [] } } }, { "title": "GetInvoicePDF with supplemental documents", "input": { "InvoiceId": "abc123" }, "output": { "InvoicePDF": { "InvoiceId": "abc123", "DocumentUrl": "https://abcd123.com?securityTokenForDoc", "DocumentUrlExpirationDate": "2025-04-01T01:00:00.000Z", "SupplementalDocuments": [ { "DocumentType": "TAX_E_INVOICE", "DocumentId": "supp-doc-1", "DocumentUrl": "https://abcd123.com?securityTokenForSupplementalDoc", "DocumentUrlExpirationDate": "2025-04-01T01:00:00.000Z" } ] } } } ], "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#GetInvoicePDFRequest": { "type": "structure", "members": { "InvoiceId": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

Your unique invoice ID.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#GetInvoicePDFResponse": { "type": "structure", "members": { "InvoicePDF": { "target": "com.amazonaws.invoicing#InvoicePDF", "traits": { "smithy.api#documentation": "

The invoice document and supplemental documents associated with the invoice.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#GetInvoiceUnit": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#GetInvoiceUnitRequest" }, "output": { "target": "com.amazonaws.invoicing#GetInvoiceUnitResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This retrieves the invoice unit definition.

", "smithy.api#examples": [ { "title": "GetInvoiceUnit as of current time", "input": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" }, "output": { "InvoiceReceiver": "111111111111", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "LastModified": 1733788800, "Name": "Example Invoice Unit A", "Description": "Description changed on 1733788800", "Rule": { "LinkedAccounts": [ "222222222222" ] }, "TaxInheritanceDisabled": false } }, { "title": "GetInvoiceUnit as of specified time", "input": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", "AsOf": 1733097600 }, "output": { "InvoiceReceiver": "333333333333", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", "LastModified": 1733011200, "Name": "Example Invoice Unit B", "Description": "Description changed on 1733011200", "Rule": { "LinkedAccounts": [ "333333333333" ] }, "TaxInheritanceDisabled": false } } ], "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#GetInvoiceUnitRequest": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "AsOf": { "target": "com.amazonaws.invoicing#AsOfTimestamp", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#GetInvoiceUnitResponse": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } }, "InvoiceReceiver": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

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": { "target": "com.amazonaws.invoicing#InvoiceUnitName", "traits": { "smithy.api#documentation": "

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

" } }, "Description": { "target": "com.amazonaws.invoicing#DescriptionString", "traits": { "smithy.api#documentation": "

The assigned description for an invoice unit.

" } }, "TaxInheritanceDisabled": { "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

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

" } }, "Rule": { "target": "com.amazonaws.invoicing#InvoiceUnitRule" }, "LastModified": { "target": "com.amazonaws.invoicing#LastModifiedTimestamp", "traits": { "smithy.api#documentation": "

The most recent date the invoice unit response was updated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#GetProcurementPortalPreference": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#GetProcurementPortalPreferenceRequest" }, "output": { "target": "com.amazonaws.invoicing#GetProcurementPortalPreferenceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Retrieves the details of a specific procurement portal preference configuration.

", "smithy.api#examples": [ { "title": "GetProcurementPortalPreference for Coupa pref", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/a34fd666-7810-4414-9360-aaa4bcab0abd" }, "output": { "ProcurementPortalPreference": { "AwsAccountId": "111111111111", "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345678", "arn:aws:invoicing::111111111111:invoice-unit/12345679" ], "SellerOfRecords": [ "AWS_INC", "AWS_EUROPE" ] }, "Contacts": [ { "Email": "example-placeholder@amazon.com", "Name": "John Doe" } ], "CreateDate": 1750375489.242, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreference": { "ConnectionTestingMethod": "PROD_ENV_DOLLAR_TEST", "EinvoiceDeliveryActivationDate": 1750279280.091, "EinvoiceDeliveryAttachmentTypes": [ "INVOICE_PDF" ], "EinvoiceDeliveryDocumentTypes": [ "AWS_CLOUD_INVOICE" ], "Protocol": "CXML", "PurchaseOrderDataSources": [ { "EinvoiceDeliveryDocumentType": "AWS_CLOUD_INVOICE", "PurchaseOrderDataSourceType": "ASSOCIATED_PURCHASE_ORDER_REQUIRED" } ] }, "EinvoiceDeliveryPreferenceStatus": "PENDING_VERIFICATION", "LastUpdateDate": 1750375489.242, "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test", "ProcurementPortalName": "COUPA", "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/a34fd666-7810-4414-9360-aaa4bcab0abd", "ProcurementPortalSharedSecret": "Coupa_Secret", "PurchaseOrderRetrievalEnabled": true, "PurchaseOrderRetrievalEndpoint": "https://www.placeholder-domain.test", "PurchaseOrderRetrievalPreferenceStatus": "PENDING_VERIFICATION", "MarketplacePunchOutEnabled": true, "MarketplacePunchOutPreference": { "ApprovalRequestRedirectUrl": "https://www.placeholder-domain.test/approvals" }, "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1", "TestEnvPreference": { "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1_Test", "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test", "ProcurementPortalSharedSecret": "Coupa_Secret_test", "PurchaseOrderRetrievalEndpoint": "https://www.placeholder-domain.test", "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1_Test" }, "Version": 1 } } } ] } }, "com.amazonaws.invoicing#GetProcurementPortalPreferenceRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to retrieve.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#GetProcurementPortalPreferenceResponse": { "type": "structure", "members": { "ProcurementPortalPreference": { "target": "com.amazonaws.invoicing#ProcurementPortalPreference", "traits": { "smithy.api#documentation": "

The detailed configuration of the requested procurement portal preference.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#InternalServerException": { "type": "structure", "members": { "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpHeader": "Retry-After" } }, "message": { "target": "com.amazonaws.invoicing#BasicString" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingInternalServer", "httpResponseCode": 500 }, "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.invoicing#InvoiceConfiguration": { "type": "structure", "members": { "DocumentTypes": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryDocumentTypes", "traits": { "smithy.api#documentation": "

The e-invoice document types supported by the procurement portal.

" } }, "AttachmentTypes": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryAttachmentTypes", "traits": { "smithy.api#documentation": "

The attachment types supported by the procurement portal for e-invoice delivery.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the supported document types and attachment types for invoice delivery to a procurement portal.

" } }, "com.amazonaws.invoicing#InvoiceCurrencyAmount": { "type": "structure", "members": { "TotalAmount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The invoice currency amount.

" } }, "TotalAmountBeforeTax": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

Details about the invoice total amount before tax.

" } }, "CurrencyCode": { "target": "com.amazonaws.invoicing#CurrencyCode", "traits": { "smithy.api#documentation": "

The currency dominion of the invoice document.

" } }, "AmountBreakdown": { "target": "com.amazonaws.invoicing#AmountBreakdown", "traits": { "smithy.api#documentation": "

Details about the invoice currency amount.

" } }, "CurrencyExchangeDetails": { "target": "com.amazonaws.invoicing#CurrencyExchangeDetails", "traits": { "smithy.api#documentation": "

The details of currency exchange.

" } } }, "traits": { "smithy.api#documentation": "

The amount charged after taxes, in the preferred currency.

" } }, "com.amazonaws.invoicing#InvoiceFrequency": { "type": "enum", "members": { "ONE_TIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ONE_TIME" } }, "RECURRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECURRING" } } } }, "com.amazonaws.invoicing#InvoicePDF": { "type": "structure", "members": { "InvoiceId": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

Your unique invoice ID.

" } }, "DocumentUrl": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

The pre-signed URL to download the invoice document.

" } }, "DocumentUrlExpirationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The pre-signed URL expiration date of the invoice document.

" } }, "SupplementalDocuments": { "target": "com.amazonaws.invoicing#SupplementalDocuments", "traits": { "smithy.api#documentation": "

List of supplemental documents associated with the invoice.

" } } }, "traits": { "smithy.api#documentation": "

Invoice document data.

" } }, "com.amazonaws.invoicing#InvoiceProfile": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

The account ID the invoice profile is generated for.

" } }, "ReceiverName": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The name of the person receiving the invoice profile.

" } }, "ReceiverAddress": { "target": "com.amazonaws.invoicing#ReceiverAddress", "traits": { "smithy.api#documentation": "

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

" } }, "ReceiverEmail": { "target": "com.amazonaws.invoicing#SensitiveBasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The email address for the invoice profile receiver.

" } }, "Issuer": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

This specifies the issuing entity of the invoice.

" } }, "TaxRegistrationNumber": { "target": "com.amazonaws.invoicing#SensitiveBasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

Your Tax Registration Number (TRN) information.

" } } }, "traits": { "smithy.api#documentation": "

Contains high-level information about the invoice receiver.

" } }, "com.amazonaws.invoicing#InvoiceSummaries": { "type": "list", "member": { "target": "com.amazonaws.invoicing#InvoiceSummary" } }, "com.amazonaws.invoicing#InvoiceSummariesFilter": { "type": "structure", "members": { "TimeInterval": { "target": "com.amazonaws.invoicing#DateInterval", "traits": { "smithy.api#documentation": "

The date range for invoice summary retrieval.

" } }, "BillingPeriod": { "target": "com.amazonaws.invoicing#BillingPeriod", "traits": { "smithy.api#documentation": "

The billing period associated with the invoice documents.

" } }, "InvoicingEntity": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

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

" } }, "ReceiverRole": { "target": "com.amazonaws.invoicing#ReceiverRole", "traits": { "smithy.api#documentation": "

The role of the invoice receiver to filter by.

When ReceiverRole is specified:

" } } }, "traits": { "smithy.api#documentation": "

Filters for your invoice summaries.

" } }, "com.amazonaws.invoicing#InvoiceSummariesMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.invoicing#InvoiceSummariesSelector": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.invoicing#ListInvoiceSummariesResourceType", "traits": { "smithy.api#documentation": "

The query identifier type (INVOICE_ID or ACCOUNT_ID).

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

The value of the query identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the invoice summary.

" } }, "com.amazonaws.invoicing#InvoiceSummary": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID.

" } }, "InvoiceId": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The invoice ID.

" } }, "IssuedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The issued date of the invoice.

" } }, "DueDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The invoice due date.

" } }, "BillSourceAccounts": { "target": "com.amazonaws.invoicing#BillSourceAccountList", "traits": { "smithy.api#documentation": "

The list of Amazon Web Services account IDs that are the bill source of the invoice. Currently, only a single bill source account is returned.

" } }, "BillSourceAccountsTotalCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The total number of accounts that are the bill source of the invoice.

" } }, "ReceiverRole": { "target": "com.amazonaws.invoicing#ReceiverRole", "traits": { "smithy.api#documentation": "

The role of the invoice receiver.

" } }, "Entity": { "target": "com.amazonaws.invoicing#Entity", "traits": { "smithy.api#documentation": "

The organization name providing Amazon Web Services services.

" } }, "BillingPeriod": { "target": "com.amazonaws.invoicing#BillingPeriod", "traits": { "smithy.api#documentation": "

The billing period of the invoice-related document.

" } }, "InvoiceFrequency": { "target": "com.amazonaws.invoicing#InvoiceFrequency", "traits": { "smithy.api#documentation": "

The frequency of the invoice.

" } }, "BillType": { "target": "com.amazonaws.invoicing#BillType", "traits": { "smithy.api#documentation": "

The type of the bill.

" } }, "InvoiceType": { "target": "com.amazonaws.invoicing#InvoiceType", "traits": { "smithy.api#documentation": "

The type of invoice.

" } }, "CommercialInvoiceId": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The commercial invoice ID. This is only applicable for tax invoices and identifies the associated commercial invoice.

" } }, "OriginalInvoiceId": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The initial or original invoice ID.

" } }, "PurchaseOrderNumber": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The purchase order number associated to the invoice.

" } }, "EinvoiceDeliveryStatus": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryStatus", "traits": { "smithy.api#documentation": "

The e-invoice delivery status.

" } }, "TaxAuthorityStatus": { "target": "com.amazonaws.invoicing#TaxAuthorityStatus", "traits": { "smithy.api#documentation": "

The current status of an invoice as reported to the tax authority. This captures scenarios where an invoice may be cancelled after issuance.

" } }, "BaseCurrencyAmount": { "target": "com.amazonaws.invoicing#InvoiceCurrencyAmount", "traits": { "smithy.api#documentation": "

The summary with the product and service currency.

" } }, "TaxCurrencyAmount": { "target": "com.amazonaws.invoicing#InvoiceCurrencyAmount", "traits": { "smithy.api#documentation": "

The summary with the tax currency.

" } }, "PaymentCurrencyAmount": { "target": "com.amazonaws.invoicing#InvoiceCurrencyAmount", "traits": { "smithy.api#documentation": "

The summary with the customer configured currency.

" } } }, "traits": { "smithy.api#documentation": "

The invoice that the API retrieved.

" } }, "com.amazonaws.invoicing#InvoiceType": { "type": "enum", "members": { "INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOICE" } }, "CREDIT_MEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDIT_MEMO" } }, "PAYMENT_RECEIPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENT_RECEIPT" } } } }, "com.amazonaws.invoicing#InvoiceUnit": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } }, "InvoiceReceiver": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

The account that receives invoices related to the invoice unit.

" } }, "Name": { "target": "com.amazonaws.invoicing#InvoiceUnitName", "traits": { "smithy.api#documentation": "

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

" } }, "Description": { "target": "com.amazonaws.invoicing#DescriptionString", "traits": { "smithy.api#documentation": "

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

" } }, "TaxInheritanceDisabled": { "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

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

" } }, "Rule": { "target": "com.amazonaws.invoicing#InvoiceUnitRule", "traits": { "smithy.api#documentation": "

An InvoiceUnitRule object used the categorize invoice units.

" } }, "LastModified": { "target": "com.amazonaws.invoicing#LastModifiedTimestamp", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.invoicing#InvoiceUnitArnString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$" } }, "com.amazonaws.invoicing#InvoiceUnitArns": { "type": "list", "member": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString" }, "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.invoicing#InvoiceUnitName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.

" } }, "BillSourceAccounts": { "target": "com.amazonaws.invoicing#RuleAccountIdList", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services 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.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.invoicing#InvoiceUnits": { "type": "list", "member": { "target": "com.amazonaws.invoicing#InvoiceUnit" } }, "com.amazonaws.invoicing#Invoicing": { "type": "service", "version": "2024-12-01", "operations": [ { "target": "com.amazonaws.invoicing#BatchGetInvoiceProfile" }, { "target": "com.amazonaws.invoicing#CreateInvoiceUnit" }, { "target": "com.amazonaws.invoicing#CreateProcurementPortalPreference" }, { "target": "com.amazonaws.invoicing#DeleteInvoiceUnit" }, { "target": "com.amazonaws.invoicing#DeleteProcurementPortalPreference" }, { "target": "com.amazonaws.invoicing#GetInvoicePDF" }, { "target": "com.amazonaws.invoicing#GetInvoiceUnit" }, { "target": "com.amazonaws.invoicing#GetProcurementPortalPreference" }, { "target": "com.amazonaws.invoicing#ListInvoiceSummaries" }, { "target": "com.amazonaws.invoicing#ListInvoiceUnits" }, { "target": "com.amazonaws.invoicing#ListProcurementPortalPreferences" }, { "target": "com.amazonaws.invoicing#ListProcurementPortals" }, { "target": "com.amazonaws.invoicing#ListProcurementPortalSuppliers" }, { "target": "com.amazonaws.invoicing#ListTagsForResource" }, { "target": "com.amazonaws.invoicing#PutProcurementPortalPreference" }, { "target": "com.amazonaws.invoicing#SendProcurementPortalValidation" }, { "target": "com.amazonaws.invoicing#TagResource" }, { "target": "com.amazonaws.invoicing#UntagResource" }, { "target": "com.amazonaws.invoicing#UpdateInvoiceUnit" }, { "target": "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatus" }, { "target": "com.amazonaws.invoicing#VerifyProcurementPortalValidation" } ], "traits": { "aws.api#service": { "sdkId": "Invoicing", "arnNamespace": "invoicing", "endpointPrefix": "invoicing", "docId": "invoicing-2024-12-01", "cloudTrailEventSource": "invoicing.amazonaws.com" }, "aws.auth#sigv4": { "name": "invoicing" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardPartitionalEndpoints": { "endpointPatternType": "service_region_dnsSuffix" }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "

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:

", "smithy.api#title": "AWS Invoicing", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://invoicing-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://invoicing.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://invoicing-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://invoicing.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://invoicing-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://invoicing.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://invoicing-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://invoicing.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://invoicing-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://invoicing.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.invoicing#LastModifiedTimestamp": { "type": "timestamp" }, "com.amazonaws.invoicing#ListInvoiceSummaries": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListInvoiceSummariesRequest" }, "output": { "target": "com.amazonaws.invoicing#ListInvoiceSummariesResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves your invoice details programmatically, without line item details.

", "smithy.api#examples": [ { "title": "ListInvoiceSummaries with InvoiceId as selector", "input": { "Selector": { "ResourceType": "INVOICE_ID", "Value": "1111111111" } }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-04-01T01:00:00.000Z", "DueDate": "2025-04-01T01:00:00.000Z", "BillSourceAccounts": [ "111111111111" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "BUYER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS" }, "BillingPeriod": { "Month": 1, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "CommercialInvoiceId": "2222222222", "OriginalInvoiceId": "1111111111", "PurchaseOrderNumber": "PO-12345", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ] } }, { "title": "ListInvoiceSummaries with AccountId as selector and billing period", "input": { "Selector": { "ResourceType": "ACCOUNT_ID", "Value": "111111111111" }, "Filter": { "BillingPeriod": { "Month": 1, "Year": 2025 } } }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-04-01T01:00:00.000Z", "DueDate": "2025-04-01T01:00:00.000Z", "BillSourceAccounts": [ "111111111111" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "BUYER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS" }, "BillingPeriod": { "Month": 1, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ] } }, { "title": "ListInvoiceSummaries with AccountId as selector and time interval", "input": { "Selector": { "ResourceType": "ACCOUNT_ID", "Value": "111111111111" }, "Filter": { "TimeInterval": { "StartDate": 1590997407, "EndDate": 1592639007 } } }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-04-01T01:00:00.000Z", "DueDate": "2025-04-01T01:00:00.000Z", "BillSourceAccounts": [ "111111111111" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "BUYER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS" }, "BillingPeriod": { "Month": 1, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ] } }, { "title": "ListInvoiceSummaries filtered by ReceiverRole", "input": { "Selector": { "ResourceType": "ACCOUNT_ID", "Value": "111111111111" }, "Filter": { "TimeInterval": { "StartDate": 1748736000, "EndDate": 1751328000 }, "ReceiverRole": "SELLER" } }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-06-15T01:00:00.000Z", "DueDate": "2025-07-15T01:00:00.000Z", "BillSourceAccounts": [ "222222222222" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "SELLER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS_MARKETPLACE" }, "BillingPeriod": { "Month": 6, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ] } }, { "title": "ListInvoiceSummaries with AccountId as selector and a billing period and max results", "input": { "Selector": { "ResourceType": "ACCOUNT_ID", "Value": "111111111111" }, "Filter": { "BillingPeriod": { "Month": 1, "Year": 2025 } }, "MaxResults": 1 }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-04-01T01:00:00.000Z", "DueDate": "2025-04-01T01:00:00.000Z", "BillSourceAccounts": [ "111111111111" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "BUYER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS" }, "BillingPeriod": { "Month": 1, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ], "NextToken": "abcde12345" } }, { "title": "ListInvoiceSummaries with AccountId as selector and a billing period and next token", "input": { "Selector": { "ResourceType": "ACCOUNT_ID", "Value": "111111111111" }, "Filter": { "BillingPeriod": { "Month": 1, "Year": 2025 } }, "NextToken": "abcde12345" }, "output": { "InvoiceSummaries": [ { "AccountId": "111111111111", "InvoiceId": "1111111111", "IssuedDate": "2025-04-01T01:00:00.000Z", "DueDate": "2025-04-01T01:00:00.000Z", "BillSourceAccounts": [ "111111111111" ], "BillSourceAccountsTotalCount": 1, "ReceiverRole": "BUYER", "Entity": { "InvoicingEntity": "Amazon Web Services, Inc.", "BillingEntity": "AWS" }, "BillingPeriod": { "Month": 1, "Year": 2025 }, "InvoiceFrequency": "RECURRING", "BillType": "ANNIVERSARY", "InvoiceType": "INVOICE", "EinvoiceDeliveryStatus": "DELIVERED", "TaxAuthorityStatus": "ISSUED", "BaseCurrencyAmount": { "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00" } }, "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD" }, "PaymentCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } }, "TaxCurrencyAmount": { "TotalAmount": "1.00", "TotalAmountBeforeTax": "1.00", "CurrencyCode": "USD", "AmountBreakdown": { "Discounts": { "TotalAmount": "1.00" }, "SubTotalAmount": "1.00", "Taxes": { "TotalAmount": "1.00", "Breakdown": [ { "Amount": "1", "Description": "VAT", "Rate": "1.0" } ] } }, "CurrencyExchangeDetails": { "SourceCurrencyCode": "USD", "TargetCurrencyCode": "USD", "Rate": "1.0" } } } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "InvoiceSummaries" } } }, "com.amazonaws.invoicing#ListInvoiceSummariesRequest": { "type": "structure", "members": { "Selector": { "target": "com.amazonaws.invoicing#InvoiceSummariesSelector", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.invoicing#InvoiceSummariesFilter", "traits": { "smithy.api#documentation": "

Filters you can use to customize your invoice summary.

" } }, "NextToken": { "target": "com.amazonaws.invoicing#NextTokenString", "traits": { "smithy.api#documentation": "

The token for the next set of results. (You received this token from a previous call.)

" } }, "MaxResults": { "target": "com.amazonaws.invoicing#InvoiceSummariesMaxResults", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListInvoiceSummariesResourceType": { "type": "enum", "members": { "ACCOUNT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_ID" } }, "INVOICE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOICE_ID" } } } }, "com.amazonaws.invoicing#ListInvoiceSummariesResponse": { "type": "structure", "members": { "InvoiceSummaries": { "target": "com.amazonaws.invoicing#InvoiceSummaries", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.invoicing#NextTokenString", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results, or null if there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ListInvoiceUnits": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListInvoiceUnitsRequest" }, "output": { "target": "com.amazonaws.invoicing#ListInvoiceUnitsResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "ListInvoiceUnits without filters as of current time", "input": {}, "output": { "InvoiceUnits": [ { "InvoiceReceiver": "111111111111", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "LastModified": 1733788800, "Name": "Example Invoice Unit A", "Description": "Description changed on 1733788800", "Rule": { "LinkedAccounts": [ "222222222222" ] }, "TaxInheritanceDisabled": false }, { "InvoiceReceiver": "333333333333", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", "LastModified": 1733788800, "Name": "Example Invoice Unit B", "Description": "Description changed on 1733788800", "Rule": { "LinkedAccounts": [ "333333333333" ] }, "TaxInheritanceDisabled": true } ] } }, { "title": "ListInvoiceUnits with filters as of specified time", "input": { "AsOf": 1733097600, "Filters": { "InvoiceReceivers": [ "333333333333" ] } }, "output": { "InvoiceUnits": [ { "InvoiceReceiver": "333333333333", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", "LastModified": 1733011200, "Name": "Example Invoice Unit B", "Description": "Description changed on 1733011200", "Rule": { "LinkedAccounts": [ "333333333333" ] }, "TaxInheritanceDisabled": false } ] } }, { "title": "ListInvoiceUnits with pagination - first page", "input": { "MaxResults": 1 }, "output": { "InvoiceUnits": [ { "InvoiceReceiver": "111111111111", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "LastModified": 1733788800, "Name": "Example Invoice Unit A", "Description": "Description changed on 1733788800", "Rule": { "LinkedAccounts": [ "222222222222" ] }, "TaxInheritanceDisabled": false } ], "NextToken": "nextTokenExample" } }, { "title": "ListInvoiceUnits with pagination - second page", "input": { "MaxResults": 1, "NextToken": "nextTokenExample" }, "output": { "InvoiceUnits": [ { "InvoiceReceiver": "333333333333", "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", "LastModified": 1733788800, "Name": "Example Invoice Unit B", "Description": "Description changed on 1733788800", "Rule": { "LinkedAccounts": [ "333333333333" ] }, "TaxInheritanceDisabled": true } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "InvoiceUnits" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListInvoiceUnitsSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.invoicing#ListInvoiceUnitsRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.invoicing#Filters", "traits": { "smithy.api#documentation": "

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.

" } }, "NextToken": { "target": "com.amazonaws.invoicing#NextTokenString", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.invoicing#MaxResultsInteger", "traits": { "smithy.api#default": 500, "smithy.api#documentation": "

The maximum number of invoice units that can be returned.

" } }, "AsOf": { "target": "com.amazonaws.invoicing#AsOfTimestamp", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListInvoiceUnitsResponse": { "type": "structure", "members": { "InvoiceUnits": { "target": "com.amazonaws.invoicing#InvoiceUnits", "traits": { "smithy.api#documentation": "

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

" } }, "NextToken": { "target": "com.amazonaws.invoicing#NextTokenString", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ListProcurementPortalPreferences": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListProcurementPortalPreferencesRequest" }, "output": { "target": "com.amazonaws.invoicing#ListProcurementPortalPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Retrieves a list of procurement portal preferences associated with the Amazon Web Services account.

", "smithy.api#examples": [ { "title": "ListProcurementPortalPreferences for Coupa prefs. First Call with following pages", "input": { "MaxResults": 2 }, "output": { "NextToken": "AAQA-EFRSURBSGpkVFU5MVNUVWNXTzNoUEptWEFGcEt0QzBBeHZaZmRUU2w3L0hRQmdDeEx3R0NuSnF2NjM5NGNmM1I5KzNIQzNnT0FBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVhPSnhEQ04rWk1idnAyb1RBZ0VRZ0RzbFJBeFlXMk9RRGFtTU8vdFc0MUJlTFFNU2hPR1E5bDM3MHcyS05mSjIzbU93MG1aVXk1MzBiWWVsZ3FaZzhjMndhTjZtNzNYTWd3bnpsZz09E8JRNUKK1r2-b9X8Qd1RAOSKHZOCy-UCpOQjJdSfZHcUefTH0YmlIW8ykllegYUWB1D1NjDjC3u2z2e4cLBTmQhrQewSBW-I_i8okXup9RWN60eMOnB6dl5jUiinJ-FjY_jGjbOkiWuJhXteDKP16RfVRW7mxp2-v1-B8gPPxGLolXHBHrb8gt18P8eWs8RcvRRmmbGUy5qa6nFH5WiCq9Bx2fTUTy9Iz_xZooNuiqC6y119EGQqJ9WsWsIUa8MbWHFXtn9-Uriz7osYocbFm1Evv_NCn3YK-wFy9rUlUskcM2n9AqvPYhOyf0reV7E8cErZFR_Ev8l008QcxQfaqK19-gKR9clddwoDzMVfVuyiW3vbzUXz7fzQLr-UMLCGdE3yHf1oz2SEbcxhHZ2eh7-9wEYDv0v92wXg7m7xaYvaKuVBPKqBaq66GdpS1HTfakkjRGvsoBStXWVgPahISglPO__-Ym5NnXOw2wENBVXZ7RsVe6nJ1X15bB1RDkqLV8xJD0L83snuCEBtM9pyUUQOPvfGHzC4yRusMgBav_y1kq0wjqsbJV5EhHV_SIwf-WZa_A==", "ProcurementPortalPreferences": [ { "AwsAccountId": "111111111111", "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_2", "CreateDate": 1750375489.242, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreferenceStatus": "PENDING_VERIFICATION", "LastUpdateDate": 1750375489.242, "ProcurementPortalName": "COUPA", "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/1c7c6d71-fbc1-45bd-a18c-40cb61810679", "PurchaseOrderRetrievalEnabled": true, "PurchaseOrderRetrievalPreferenceStatus": "PENDING_VERIFICATION", "MarketplacePunchOutEnabled": false, "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345679" ], "SellerOfRecords": [ "AWS_INC" ] }, "Version": 1 }, { "AwsAccountId": "111111111111", "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_4", "CreateDate": 1750375489.242, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreferenceStatus": "PENDING_VERIFICATION", "LastUpdateDate": 1750375489.242, "ProcurementPortalName": "COUPA", "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/ae467ebd-ec8c-4089-b904-a7cd9e76f970", "PurchaseOrderRetrievalEnabled": true, "PurchaseOrderRetrievalPreferenceStatus": "PENDING_VERIFICATION", "MarketplacePunchOutEnabled": false, "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345678" ], "SellerOfRecords": [ "AWS_INC" ] }, "Version": 1 } ] } }, { "title": "ListProcurementPortalPreferences for Coupa prefs. Second Call with the last page", "input": { "NextToken": "AAQA-EFRSURBSGpkVFU5MVNUVWNXTzNoUEptWEFGcEt0QzBBeHZaZmRUU2w3L0hRQmdDeEx3R0NuSnF2NjM5NGNmM1I5KzNIQzNnT0FBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVhPSnhEQ04rWk1idnAyb1RBZ0VRZ0RzbFJBeFlXMk9RRGFtTU8vdFc0MUJlTFFNU2hPR1E5bDM3MHcyS05mSjIzbU93MG1aVXk1MzBiWWVsZ3FaZzhjMndhTjZtNzNYTWd3bnpsZz09E8JRNUKK1r2-b9X8Qd1RAOSKHZOCy-UCpOQjJdSfZHcUefTH0YmlIW8ykllegYUWB1D1NjDjC3u2z2e4cLBTmQhrQewSBW-I_i8okXup9RWN60eMOnB6dl5jUiinJ-FjY_jGjbOkiWuJhXteDKP16RfVRW7mxp2-v1-B8gPPxGLolXHBHrb8gt18P8eWs8RcvRRmmbGUy5qa6nFH5WiCq9Bx2fTUTy9Iz_xZooNuiqC6y119EGQqJ9WsWsIUa8MbWHFXtn9-Uriz7osYocbFm1Evv_NCn3YK-wFy9rUlUskcM2n9AqvPYhOyf0reV7E8cErZFR_Ev8l008QcxQfaqK19-gKR9clddwoDzMVfVuyiW3vbzUXz7fzQLr-UMLCGdE3yHf1oz2SEbcxhHZ2eh7-9wEYDv0v92wXg7m7xaYvaKuVBPKqBaq66GdpS1HTfakkjRGvsoBStXWVgPahISglPO__-Ym5NnXOw2wENBVXZ7RsVe6nJ1X15bB1RDkqLV8xJD0L83snuCEBtM9pyUUQOPvfGHzC4yRusMgBav_y1kq0wjqsbJV5EhHV_SIwf-WZa_A==", "MaxResults": 2 }, "output": { "ProcurementPortalPreferences": [ { "AwsAccountId": "111111111111", "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1", "CreateDate": 1750375489.242, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreferenceStatus": "TEST_INITIALIZED", "EinvoiceDeliveryPreferenceStatusReason": "test initialized example reason", "LastUpdateDate": 1750375489.242, "ProcurementPortalName": "COUPA", "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd", "PurchaseOrderRetrievalEnabled": true, "PurchaseOrderRetrievalPreferenceStatus": "TEST_INITIALIZED", "PurchaseOrderRetrievalPreferenceStatusReason": "test initialized example reason", "MarketplacePunchOutEnabled": true, "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345678" ], "SellerOfRecords": [ "AWS_INC" ] }, "Version": 3 } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ProcurementPortalPreferences" } } }, "com.amazonaws.invoicing#ListProcurementPortalPreferencesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token for the next set of results. (You received this token from a previous call.)

" } }, "MaxResults": { "target": "com.amazonaws.invoicing#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListProcurementPortalPreferencesResponse": { "type": "structure", "members": { "ProcurementPortalPreferences": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSummaries", "traits": { "smithy.api#documentation": "

The list of procurement portal preferences associated with the Amazon Web Services account.

" } }, "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results, or null if there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ListProcurementPortalSuppliers": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListProcurementPortalSuppliersRequest" }, "output": { "target": "com.amazonaws.invoicing#ListProcurementPortalSuppliersResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the suppliers configured for a specified procurement portal, including supplier identifiers and associated metadata. For faster, more reliable responses, use pagination.

", "smithy.api#examples": [ { "title": "ListProcurementPortalSuppliers", "input": { "PortalIdentifier": "KXMJQWBRNP" }, "output": { "ProcurementPortalSuppliers": [ { "SupplierIdentifier": "AN01010639538", "SellerOfRecord": "AWS_INC", "Environment": "PROD" }, { "SupplierIdentifier": "AN01401912735", "SellerOfRecord": "AWS_EUROPE", "CountryCode": "DE", "Environment": "PROD" }, { "SupplierIdentifier": "AN01010639538-T", "SellerOfRecord": "AWS_INC", "Environment": "TEST" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ProcurementPortalSuppliers" }, "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#ListProcurementPortalSuppliersRequest": { "type": "structure", "members": { "PortalIdentifier": { "target": "com.amazonaws.invoicing#ProcurementPortalIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the procurement portal for which to list suppliers. Use the PortalIdentifier value returned by ListProcurementPortals.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token for the next set of results. You received this token from a previous call.

" } }, "MaxResults": { "target": "com.amazonaws.invoicing#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListProcurementPortalSuppliersResponse": { "type": "structure", "members": { "ProcurementPortalSuppliers": { "target": "com.amazonaws.invoicing#ProcurementPortalSuppliers", "traits": { "smithy.api#documentation": "

The list of suppliers configured for the specified procurement portal.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results, or null if there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ListProcurementPortals": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListProcurementPortalsRequest" }, "output": { "target": "com.amazonaws.invoicing#ListProcurementPortalsResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the Amazon Web Services-supported procurement portals for e-invoice delivery and purchase order retrieval. Each entry includes the portal identifier, name, and default feature configurations, which define the supported document and attachment types. For faster, more reliable responses, use pagination.

", "smithy.api#examples": [ { "title": "ListProcurementPortals", "input": {}, "output": { "ProcurementPortals": [ { "PortalIdentifier": "KXMJQWBRNP", "PortalName": "SAP_BUSINESS_NETWORK", "PortalDisplayName": "SAP Business Network", "DefaultFeatureConfigurations": { "InvoiceConfiguration": { "DocumentTypes": [ "AWS_CLOUD_INVOICE", "AWS_CLOUD_CREDIT_MEMO", "AWS_MARKETPLACE_INVOICE", "AWS_MARKETPLACE_CREDIT_MEMO", "AWS_REQUEST_FOR_PAYMENT" ], "AttachmentTypes": [ "INVOICE_PDF", "RFP_PDF" ] } } }, { "PortalIdentifier": "THZVCGFLDY", "PortalName": "COUPA", "PortalDisplayName": "Coupa", "DefaultFeatureConfigurations": { "InvoiceConfiguration": { "DocumentTypes": [ "AWS_CLOUD_INVOICE", "AWS_CLOUD_CREDIT_MEMO", "AWS_MARKETPLACE_INVOICE", "AWS_MARKETPLACE_CREDIT_MEMO", "AWS_REQUEST_FOR_PAYMENT" ], "AttachmentTypes": [ "INVOICE_PDF", "RFP_PDF" ] } } } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ProcurementPortals" }, "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#ListProcurementPortalsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token for the next set of results. You received this token from a previous call.

" } }, "MaxResults": { "target": "com.amazonaws.invoicing#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListProcurementPortalsResponse": { "type": "structure", "members": { "ProcurementPortals": { "target": "com.amazonaws.invoicing#ProcurementPortals", "traits": { "smithy.api#documentation": "

The list of procurement portals available for configuration.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results, or null if there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.invoicing#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the tags for a resource.

", "smithy.api#examples": [ { "title": "ListTagsForResource", "input": { "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" }, "output": { "ResourceTags": [ { "Key": "TagKey", "Value": "TagValue" } ] } } ], "smithy.api#readonly": {} } }, "com.amazonaws.invoicing#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.invoicing#TagrisArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#ListTagsForResourceResponse": { "type": "structure", "members": { "ResourceTags": { "target": "com.amazonaws.invoicing#ResourceTagList", "traits": { "smithy.api#documentation": "

Adds a tag to a resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#MarketplacePunchOutPreference": { "type": "structure", "members": { "ApprovalRequestRedirectUrl": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The URL that buyers are redirected to for approval requests in the procurement portal. This is only supported for Coupa. When provided together with the procurement portal instance endpoint, its host must match the host of that endpoint.

" } } }, "traits": { "smithy.api#documentation": "

Represents the Marketplace PunchOut configuration for a procurement portal preference.

" } }, "com.amazonaws.invoicing#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 100, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.invoicing#MaxResultsInteger": { "type": "integer", "traits": { "smithy.api#default": 500, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.invoicing#Month": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 12 } } }, "com.amazonaws.invoicing#NextTokenString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.invoicing#ProcurementPortal": { "type": "structure", "members": { "PortalIdentifier": { "target": "com.amazonaws.invoicing#ProcurementPortalIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the procurement portal.

", "smithy.api#required": {} } }, "PortalName": { "target": "com.amazonaws.invoicing#ProcurementPortalName", "traits": { "smithy.api#documentation": "

The name of the procurement portal.

", "smithy.api#required": {} } }, "PortalDisplayName": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The display name of the procurement portal.

" } }, "DefaultFeatureConfigurations": { "target": "com.amazonaws.invoicing#FeatureConfigurations", "traits": { "smithy.api#documentation": "

The default feature configurations for the procurement portal.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata for a procurement portal, including the portal identifier, name, and default feature configurations.

" } }, "com.amazonaws.invoicing#ProcurementPortalEnv": { "type": "enum", "members": { "PROD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

The production environment.

", "smithy.api#enumValue": "PROD" } }, "TEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

The sandbox or test environment.

", "smithy.api#enumValue": "TEST" } } }, "traits": { "smithy.api#documentation": "

The environment of a procurement portal supplier. PROD indicates the production environment. TEST indicates the sandbox or test environment.

" } }, "com.amazonaws.invoicing#ProcurementPortalIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.invoicing#ProcurementPortalName": { "type": "enum", "members": { "SAP_BUSINESS_NETWORK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAP_BUSINESS_NETWORK" } }, "COUPA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COUPA" } } } }, "com.amazonaws.invoicing#ProcurementPortalPreference": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID associated with this procurement portal preference.

", "smithy.api#required": {} } }, "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference.

", "smithy.api#required": {} } }, "ProcurementPortalName": { "target": "com.amazonaws.invoicing#ProcurementPortalName", "traits": { "smithy.api#documentation": "

The name of the procurement portal.

", "smithy.api#required": {} } }, "BuyerDomain": { "target": "com.amazonaws.invoicing#BuyerDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "BuyerIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "SupplierDomain": { "target": "com.amazonaws.invoicing#SupplierDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "SupplierIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "Selector": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSelector" }, "ProcurementPortalSharedSecret": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The shared secret or authentication credential used for secure communication with the procurement portal.

" } }, "ProcurementPortalInstanceEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL where e-invoices are delivered to the procurement portal.

" } }, "PurchaseOrderRetrievalEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL used for retrieving purchase orders from the procurement portal.

" } }, "TestEnvPreference": { "target": "com.amazonaws.invoicing#TestEnvPreference", "traits": { "smithy.api#documentation": "

Configuration on settings for the test environment of the procurement portal.

" } }, "EinvoiceDeliveryEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether e-invoice delivery is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "EinvoiceDeliveryPreference": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryPreference", "traits": { "smithy.api#documentation": "

The e-invoice delivery configuration including document types, attachment types, and customization settings.

" } }, "PurchaseOrderRetrievalEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether purchase order retrieval is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "MarketplacePunchOutEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether Marketplace PunchOut is enabled for this procurement portal preference. Defaults to false.

" } }, "MarketplacePunchOutPreference": { "target": "com.amazonaws.invoicing#MarketplacePunchOutPreference", "traits": { "smithy.api#documentation": "

The Marketplace PunchOut configuration for this procurement portal preference. This is present when MarketplacePunchOutEnabled is true.

" } }, "Contacts": { "target": "com.amazonaws.invoicing#Contacts", "traits": { "smithy.api#documentation": "

List of contact information for portal administrators and technical contacts.

" } }, "EinvoiceDeliveryPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The current status of the e-invoice delivery preference.

" } }, "EinvoiceDeliveryPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the current e-invoice delivery preference status.

" } }, "PurchaseOrderRetrievalPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The current status of the purchase order retrieval preference.

" } }, "PurchaseOrderRetrievalPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the current purchase order retrieval preference status.

" } }, "Version": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The version number of the procurement portal preference configuration.

", "smithy.api#required": {} } }, "CreateDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the procurement portal preference was created.

", "smithy.api#required": {} } }, "LastUpdateDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the procurement portal preference was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents the full configuration of a procurement portal preference, including settings for e-invoice delivery and purchase order retrieval.

" } }, "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+$" } }, "com.amazonaws.invoicing#ProcurementPortalPreferenceSelector": { "type": "structure", "members": { "InvoiceUnitArns": { "target": "com.amazonaws.invoicing#InvoiceUnitArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.

" } }, "SellerOfRecords": { "target": "com.amazonaws.invoicing#SellerOfRecords", "traits": { "smithy.api#documentation": "

The list of seller of record IDs to which this preference applies.

" } } }, "traits": { "smithy.api#documentation": "

Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.

" } }, "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus": { "type": "enum", "members": { "PENDING_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VERIFICATION" } }, "VALIDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATED" } }, "TEST_INITIALIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_INITIALIZED" } }, "TEST_INITIALIZATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_INITIALIZATION_FAILED" } }, "TEST_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_FAILED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDED" } } } }, "com.amazonaws.invoicing#ProcurementPortalPreferenceSummaries": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSummary" } }, "com.amazonaws.invoicing#ProcurementPortalPreferenceSummary": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.invoicing#AccountIdString", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID associated with this procurement portal preference summary.

", "smithy.api#required": {} } }, "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference.

", "smithy.api#required": {} } }, "ProcurementPortalName": { "target": "com.amazonaws.invoicing#ProcurementPortalName", "traits": { "smithy.api#documentation": "

The name of the procurement portal.

", "smithy.api#required": {} } }, "BuyerDomain": { "target": "com.amazonaws.invoicing#BuyerDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "BuyerIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the buyer in the procurement portal.

", "smithy.api#required": {} } }, "SupplierDomain": { "target": "com.amazonaws.invoicing#SupplierDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "SupplierIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the supplier in the procurement portal.

", "smithy.api#required": {} } }, "Selector": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSelector" }, "EinvoiceDeliveryEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether e-invoice delivery is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "PurchaseOrderRetrievalEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether purchase order retrieval is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "MarketplacePunchOutEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether Marketplace PunchOut is enabled for this procurement portal preference. Defaults to false.

" } }, "EinvoiceDeliveryPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The current status of the e-invoice delivery preference in this summary.

" } }, "EinvoiceDeliveryPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the current e-invoice delivery preference status in this summary.

" } }, "PurchaseOrderRetrievalPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The current status of the purchase order retrieval preference in this summary.

" } }, "PurchaseOrderRetrievalPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the current purchase order retrieval preference status in this summary.

" } }, "Version": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The version number of the procurement portal preference configuration in this summary.

", "smithy.api#required": {} } }, "CreateDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the procurement portal preference was created.

", "smithy.api#required": {} } }, "LastUpdateDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the procurement portal preference was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Provides a summary of a procurement portal preference, including key identifiers and status information.

" } }, "com.amazonaws.invoicing#ProcurementPortalSupplier": { "type": "structure", "members": { "SupplierIdentifier": { "target": "com.amazonaws.invoicing#SupplierIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the supplier within the procurement portal.

", "smithy.api#required": {} } }, "SellerOfRecord": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The Amazon Web Services seller of record associated with the supplier\u2014the Amazon Web Services legal entity that issues invoices for the account (for example, AWS_INC or AWS_EUROPE).

" } }, "CountryCode": { "target": "com.amazonaws.invoicing#CountryCode", "traits": { "smithy.api#documentation": "

The two-letter ISO 3166-1 alpha-2 country code associated with the supplier.

" } }, "Environment": { "target": "com.amazonaws.invoicing#ProcurementPortalEnv", "traits": { "smithy.api#documentation": "

The environment identifier for the supplier in the procurement portal. PROD for production env, or TEST for sandbox/test env.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata for a supplier configured within a procurement portal.

" } }, "com.amazonaws.invoicing#ProcurementPortalSuppliers": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ProcurementPortalSupplier" } }, "com.amazonaws.invoicing#ProcurementPortals": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ProcurementPortal" } }, "com.amazonaws.invoicing#ProfileList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#InvoiceProfile" } }, "com.amazonaws.invoicing#Protocol": { "type": "enum", "members": { "CXML": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CXML" } } } }, "com.amazonaws.invoicing#PurchaseOrderDataSource": { "type": "structure", "members": { "EinvoiceDeliveryDocumentType": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryDocumentType", "traits": { "smithy.api#documentation": "

The type of e-invoice document that requires purchase order data.

" } }, "PurchaseOrderDataSourceType": { "target": "com.amazonaws.invoicing#PurchaseOrderDataSourceType", "traits": { "smithy.api#documentation": "

The type of source for purchase order data.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the source configuration for retrieving purchase order data.

" } }, "com.amazonaws.invoicing#PurchaseOrderDataSourceType": { "type": "enum", "members": { "ASSOCIATED_PURCHASE_ORDER_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATED_PURCHASE_ORDER_REQUIRED" } }, "PURCHASE_ORDER_NOT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PURCHASE_ORDER_NOT_REQUIRED" } } } }, "com.amazonaws.invoicing#PurchaseOrderDataSources": { "type": "list", "member": { "target": "com.amazonaws.invoicing#PurchaseOrderDataSource" } }, "com.amazonaws.invoicing#PutProcurementPortalPreference": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#PutProcurementPortalPreferenceRequest" }, "output": { "target": "com.amazonaws.invoicing#PutProcurementPortalPreferenceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Updates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.

", "smithy.api#examples": [ { "title": "PutProcurementPortalPreference for Coupa pref", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd", "ProcurementPortalSharedSecret": "Coupa_Secret_2", "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test", "Selector": { "InvoiceUnitArns": [ "arn:aws:invoicing::111111111111:invoice-unit/12345679" ], "SellerOfRecords": [ "AWS_INC" ] }, "TestEnvPreference": { "BuyerDomain": "NetworkID", "BuyerIdentifier": "BuyerId_1_Test", "SupplierDomain": "NetworkID", "SupplierIdentifier": "SupplierId_1_Test", "ProcurementPortalSharedSecret": "Coupa_Secret_test_2", "ProcurementPortalInstanceEndpoint": "https://www.placeholder-domain.test" }, "EinvoiceDeliveryEnabled": true, "EinvoiceDeliveryPreference": { "EinvoiceDeliveryDocumentTypes": [ "AWS_CLOUD_INVOICE" ], "EinvoiceDeliveryAttachmentTypes": [ "INVOICE_PDF" ], "Protocol": "CXML", "PurchaseOrderDataSources": [ { "EinvoiceDeliveryDocumentType": "AWS_CLOUD_INVOICE", "PurchaseOrderDataSourceType": "ASSOCIATED_PURCHASE_ORDER_REQUIRED" } ], "ConnectionTestingMethod": "PROD_ENV_DOLLAR_TEST", "EinvoiceDeliveryActivationDate": 1750279280.091 }, "PurchaseOrderRetrievalEnabled": true, "MarketplacePunchOutEnabled": true, "Contacts": [ { "Name": "John Doe2", "Email": "example-placeholder2@amazon.com" } ], "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b45" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#PutProcurementPortalPreferenceRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to update.

", "smithy.api#required": {} } }, "Selector": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceSelector" }, "ProcurementPortalSharedSecret": { "target": "com.amazonaws.invoicing#SensitiveBasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The updated shared secret or authentication credential for the procurement portal. This value must be encrypted at rest.

" } }, "ProcurementPortalInstanceEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The updated endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.

" } }, "TestEnvPreference": { "target": "com.amazonaws.invoicing#TestEnvPreferenceInput", "traits": { "smithy.api#documentation": "

Updated configuration settings for the test environment of the procurement portal.

" } }, "EinvoiceDeliveryEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Updated flag indicating whether e-invoice delivery is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "EinvoiceDeliveryPreference": { "target": "com.amazonaws.invoicing#EinvoiceDeliveryPreference", "traits": { "smithy.api#documentation": "

Updated e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.

" } }, "PurchaseOrderRetrievalEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Updated flag indicating whether purchase order retrieval is enabled for this procurement portal preference.

", "smithy.api#required": {} } }, "MarketplacePunchOutEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether Marketplace PunchOut is enabled for this connection. Defaults to false if not provided." } }, "MarketplacePunchOutPreference": { "target": "com.amazonaws.invoicing#MarketplacePunchOutPreference", "traits": { "smithy.api#documentation": "Configuration for Marketplace PunchOut. Required when MarketplacePunchOutEnabled is true." } }, "Contacts": { "target": "com.amazonaws.invoicing#Contacts", "traits": { "smithy.api#documentation": "

Updated list of contact information for portal administrators and technical contacts.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#PutProcurementPortalPreferenceResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated procurement portal preference.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ReceiverAddress": { "type": "structure", "members": { "AddressLine1": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The first line of the address.

" } }, "AddressLine2": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The second line of the address, if applicable.

" } }, "AddressLine3": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The third line of the address, if applicable.

" } }, "DistrictOrCounty": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The district or country the address is located in.

" } }, "City": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The city that the address is in.

" } }, "StateOrRegion": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

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

" } }, "CountryCode": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The country code for the country the address is in.

" } }, "CompanyName": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

A unique company name.

" } }, "PostalCode": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The postal code associated with the address.

" } } }, "traits": { "smithy.api#documentation": "

The details of the address associated with the receiver.

", "smithy.api#sensitive": {} } }, "com.amazonaws.invoicing#ReceiverRole": { "type": "enum", "members": { "SELLER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELLER" } }, "RESELLER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESELLER" } }, "BUYER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUYER" } } } }, "com.amazonaws.invoicing#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString" }, "resourceName": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

The resource could not be found.

" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingResourceNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "

The resource could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.invoicing#ResourceTag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.invoicing#ResourceTagKey", "traits": { "smithy.api#documentation": "

The object key of your of your resource tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.invoicing#ResourceTagValue", "traits": { "smithy.api#documentation": "

The specific value of the resource tag.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The tag structure that contains a tag key and value.

" } }, "com.amazonaws.invoicing#ResourceTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.invoicing#ResourceTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ResourceTagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.invoicing#ResourceTagList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ResourceTag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.invoicing#ResourceTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.invoicing#RuleAccountIdList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#AccountIdString" }, "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.invoicing#SellerOfRecords": { "type": "list", "member": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.invoicing#SendProcurementPortalValidation": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#SendProcurementPortalValidationRequest" }, "output": { "target": "com.amazonaws.invoicing#SendProcurementPortalValidationResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Sends a validation request for a procurement portal preference. This operation initiates the validation process by issuing a validation code that confirms ownership and connectivity of the configured procurement portal endpoint. Use VerifyProcurementPortalValidation to submit the received code and complete validation.

", "smithy.api#examples": [ { "title": "SendProcurementPortalValidation call", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#SendProcurementPortalValidationRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to validate.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#SendProcurementPortalValidationResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference for which the validation request was sent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#SensitiveBasicStringWithoutSpace": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^\\S+$", "smithy.api#sensitive": {} } }, "com.amazonaws.invoicing#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingServiceQuotaExceeded", "httpResponseCode": 402 }, "smithy.api#documentation": "

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.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.invoicing#StringWithoutNewLine": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^.*$" } }, "com.amazonaws.invoicing#SupplementalDocument": { "type": "structure", "members": { "DocumentType": { "target": "com.amazonaws.invoicing#SupplementalDocumentType", "traits": { "smithy.api#documentation": "

The type of supplemental document.

" } }, "DocumentId": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

The ID of the supplemental document.

" } }, "DocumentUrl": { "target": "com.amazonaws.invoicing#StringWithoutNewLine", "traits": { "smithy.api#documentation": "

The pre-signed URL to download invoice supplemental document.

" } }, "DocumentUrlExpirationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The pre-signed URL expiration date of invoice supplemental document.

" } } }, "traits": { "smithy.api#documentation": "

Supplemental document associated with the invoice.

" } }, "com.amazonaws.invoicing#SupplementalDocumentType": { "type": "enum", "members": { "GOVERNMENT_INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GOVERNMENT_INVOICE" } }, "TAX_E_INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAX_E_INVOICE" } }, "PAYMENT_RECEIPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENT_RECEIPT" } }, "SUPPLEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPPLEMENT" } } } }, "com.amazonaws.invoicing#SupplementalDocuments": { "type": "list", "member": { "target": "com.amazonaws.invoicing#SupplementalDocument" } }, "com.amazonaws.invoicing#SupplierDomain": { "type": "enum", "members": { "NetworkID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkID" } } } }, "com.amazonaws.invoicing#SupplierIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.invoicing#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#TagResourceRequest" }, "output": { "target": "com.amazonaws.invoicing#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds a tag to a resource.

", "smithy.api#examples": [ { "title": "TagResource", "input": { "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "ResourceTags": [ { "Key": "TagKey", "Value": "TagValue" } ] }, "output": {} } ] } }, "com.amazonaws.invoicing#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.invoicing#TagrisArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tags.

", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.invoicing#ResourceTagList", "traits": { "smithy.api#documentation": "

Adds a tag to a resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#TagrisArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:(invoicing)::[0-9]{12}:[-a-zA-Z0-9/:_]+$" } }, "com.amazonaws.invoicing#TaxAuthorityStatus": { "type": "enum", "members": { "ISSUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISSUED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } } } }, "com.amazonaws.invoicing#TaxInheritanceDisabledFlag": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.invoicing#TaxesBreakdown": { "type": "structure", "members": { "Breakdown": { "target": "com.amazonaws.invoicing#TaxesBreakdownAmountList", "traits": { "smithy.api#documentation": "

A list of tax information.

" } }, "TotalAmount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The total amount for your taxes.

" } } }, "traits": { "smithy.api#documentation": "

The details of the taxes.

" } }, "com.amazonaws.invoicing#TaxesBreakdownAmount": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The details of the taxes.

" } }, "Amount": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The tax amount.

" } }, "Rate": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The details of the tax rate.

" } } }, "traits": { "smithy.api#documentation": "

The tax amount.

" } }, "com.amazonaws.invoicing#TaxesBreakdownAmountList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#TaxesBreakdownAmount" } }, "com.amazonaws.invoicing#TestEnvPreference": { "type": "structure", "members": { "BuyerDomain": { "target": "com.amazonaws.invoicing#BuyerDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the buyer in the test environment of the procurement portal.

", "smithy.api#required": {} } }, "BuyerIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the buyer in the test environment of the procurement portal.

", "smithy.api#required": {} } }, "SupplierDomain": { "target": "com.amazonaws.invoicing#SupplierDomain", "traits": { "smithy.api#documentation": "

The domain identifier for the supplier in the test environment of the procurement portal.

", "smithy.api#required": {} } }, "SupplierIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier for the supplier in the test environment of the procurement portal.

", "smithy.api#required": {} } }, "ProcurementPortalSharedSecret": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The shared secret or authentication credential used for secure communication with the test environment.

" } }, "ProcurementPortalInstanceEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL where e-invoices are delivered in the test environment.

" } }, "PurchaseOrderRetrievalEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL used for retrieving purchase orders in the test environment.

" } } }, "traits": { "smithy.api#documentation": "

Contains configuration settings for testing the procurement portal integration in a non-production environment.

" } }, "com.amazonaws.invoicing#TestEnvPreferenceInput": { "type": "structure", "members": { "BuyerDomain": { "target": "com.amazonaws.invoicing#BuyerDomain", "traits": { "smithy.api#documentation": "

The domain identifier to use for the buyer in the test environment.

", "smithy.api#required": {} } }, "BuyerIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier to use for the buyer in the test environment.

", "smithy.api#required": {} } }, "SupplierDomain": { "target": "com.amazonaws.invoicing#SupplierDomain", "traits": { "smithy.api#documentation": "

The domain identifier to use for the supplier in the test environment.

", "smithy.api#required": {} } }, "SupplierIdentifier": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The unique identifier to use for the supplier in the test environment.

", "smithy.api#required": {} } }, "ProcurementPortalSharedSecret": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The shared secret or authentication credential to use for secure communication in the test environment.

" } }, "ProcurementPortalInstanceEndpoint": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The endpoint URL where e-invoices will be delivered in the test environment.

" } } }, "traits": { "smithy.api#documentation": "

Input parameters for configuring test environment preferences for a procurement portal.

" } }, "com.amazonaws.invoicing#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingThrottling", "httpResponseCode": 429 }, "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.invoicing#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#UntagResourceRequest" }, "output": { "target": "com.amazonaws.invoicing#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes a tag from a resource.

", "smithy.api#examples": [ { "title": "UntagResource", "input": { "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "ResourceTagKeys": [ "TagKey" ] }, "output": {} } ] } }, "com.amazonaws.invoicing#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.invoicing#TagrisArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) to untag.

", "smithy.api#required": {} } }, "ResourceTagKeys": { "target": "com.amazonaws.invoicing#ResourceTagKeyList", "traits": { "smithy.api#documentation": "

Keys for the tags to be removed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#UpdateInvoiceUnit": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#UpdateInvoiceUnitRequest" }, "output": { "target": "com.amazonaws.invoicing#UpdateInvoiceUnitResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "UpdateInvoiceUnit with all updatable fields", "input": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "Description": "Updated IU description", "TaxInheritanceDisabled": false, "Rule": { "LinkedAccounts": [ "111111111111", "222222222222" ] }, "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b42" }, "output": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" } }, { "title": "UpdateInvoiceUnit with specific fields", "input": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", "Description": "Updated IU description. All other fields remain unchanged", "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b43" }, "output": { "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#UpdateInvoiceUnitRequest": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.invoicing#DescriptionString", "traits": { "smithy.api#documentation": "

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

" } }, "TaxInheritanceDisabled": { "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

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

" } }, "Rule": { "target": "com.amazonaws.invoicing#InvoiceUnitRule", "traits": { "smithy.api#documentation": "

The InvoiceUnitRule object used to update invoice units.

" } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#UpdateInvoiceUnitResponse": { "type": "structure", "members": { "InvoiceUnitArn": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatus": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatusRequest" }, "output": { "target": "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatusResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#ConflictException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.

", "smithy.api#examples": [ { "title": "UpdateProcurementPortalPreference for EinvoiceDeliveryPreferenceStatus and PurchaseOrderRetrievalPreferenceStatus", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd", "EinvoiceDeliveryPreferenceStatus": "SUSPENDED", "EinvoiceDeliveryPreferenceStatusReason": "suspended example reason", "PurchaseOrderRetrievalPreferenceStatus": "SUSPENDED", "PurchaseOrderRetrievalPreferenceStatusReason": "suspended example reason", "ClientToken": "e362c68e-4e74-48d7-9228-0bc5aa447b46" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatusRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to update.

", "smithy.api#required": {} } }, "EinvoiceDeliveryPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The updated status of the e-invoice delivery preference.

" } }, "EinvoiceDeliveryPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the e-invoice delivery preference status update, providing context for the change.

" } }, "PurchaseOrderRetrievalPreferenceStatus": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceStatus", "traits": { "smithy.api#documentation": "

The updated status of the purchase order retrieval preference.

" } }, "PurchaseOrderRetrievalPreferenceStatusReason": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

The reason for the purchase order retrieval preference status update, providing context for the change.

" } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#UpdateProcurementPortalPreferenceStatusResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference with updated status.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.invoicing#BasicString" }, "resourceName": { "target": "com.amazonaws.invoicing#InvoiceUnitArnString", "traits": { "smithy.api#documentation": "

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

" } }, "reason": { "target": "com.amazonaws.invoicing#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

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

" } }, "fieldList": { "target": "com.amazonaws.invoicing#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvoicingValidation", "httpResponseCode": 400 }, "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.invoicing#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.invoicing#BasicString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.invoicing#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.invoicing#ValidationExceptionField" } }, "com.amazonaws.invoicing#ValidationExceptionReason": { "type": "enum", "members": { "NON_MEMBERS_PRESENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "nonMemberPresent" } }, "MAX_ACCOUNTS_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "maxAccountsExceeded" } }, "MAX_INVOICE_UNITS_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "maxInvoiceUnitsExceeded" } }, "DUPLICATE_INVOICE_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "duplicateInvoiceUnit" } }, "MUTUAL_EXCLUSION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "mutualExclusionError" } }, "ACCOUNT_MEMBERSHIP_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "accountMembershipError" } }, "TAX_SETTINGS_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "taxSettingsError" } }, "EXPIRED_NEXT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "expiredNextToken" } }, "INVALID_NEXT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalidNextToken" } }, "INVALID_INPUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalidInput" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } } } }, "com.amazonaws.invoicing#VerifyProcurementPortalValidation": { "type": "operation", "input": { "target": "com.amazonaws.invoicing#VerifyProcurementPortalValidationRequest" }, "output": { "target": "com.amazonaws.invoicing#VerifyProcurementPortalValidationResponse" }, "errors": [ { "target": "com.amazonaws.invoicing#AccessDeniedException" }, { "target": "com.amazonaws.invoicing#InternalServerException" }, { "target": "com.amazonaws.invoicing#ResourceNotFoundException" }, { "target": "com.amazonaws.invoicing#ThrottlingException" }, { "target": "com.amazonaws.invoicing#ValidationException" } ], "traits": { "smithy.api#documentation": "

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews).

Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling SendProcurementPortalValidation to confirm ownership and connectivity of the configured procurement portal endpoint.

", "smithy.api#examples": [ { "title": "VerifyProcurementPortalValidation call", "input": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd", "Code": "validation-code-123" }, "output": { "ProcurementPortalPreferenceArn": "arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.invoicing#VerifyProcurementPortalValidationRequest": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference to validate.

", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

The validation code received from the procurement portal in response to a previous SendProcurementPortalValidation request.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.invoicing#BasicStringWithoutSpace", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.invoicing#VerifyProcurementPortalValidationResponse": { "type": "structure", "members": { "ProcurementPortalPreferenceArn": { "target": "com.amazonaws.invoicing#ProcurementPortalPreferenceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the procurement portal preference for which validation was completed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.invoicing#Year": { "type": "integer", "traits": { "smithy.api#range": { "min": 2005, "max": 2050 } } } } }