Tax Settings 2018-05-10
- Client: Aws\TaxSettings\TaxSettingsClient
- Service ID: taxsettings
- Version: 2018-05-10
This page describes the parameters and results for the operations of the Tax Settings (2018-05-10), and shows how to use the Aws\TaxSettings\TaxSettingsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchDeleteTaxRegistration ( array $params = [] )
- Deletes tax registration for multiple accounts in batch.
- BatchGetTaxExemptions ( array $params = [] )
- Get the active tax exemptions for a given list of accounts.
- BatchPutTaxRegistration ( array $params = [] )
- Adds or updates tax registration for multiple accounts in batch.
- DeleteSupplementalTaxRegistration ( array $params = [] )
- Deletes a supplemental tax registration for a single account.
- DeleteTaxRegistration ( array $params = [] )
- Deletes tax registration for a single account.
- GetTaxExemptionTypes ( array $params = [] )
- Get supported tax exemption types.
- GetTaxInheritance ( array $params = [] )
- The get account tax inheritance status.
- GetTaxRegistration ( array $params = [] )
- Retrieves tax registration for a single account.
- GetTaxRegistrationDocument ( array $params = [] )
- Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
- ListSupplementalTaxRegistrations ( array $params = [] )
- Retrieves supplemental tax registrations for a single account.
- ListTaxExemptions ( array $params = [] )
- Retrieves the tax exemption of accounts listed in a consolidated billing family.
- ListTaxRegistrations ( array $params = [] )
- Retrieves the tax registration of accounts listed in a consolidated billing family.
- PutSupplementalTaxRegistration ( array $params = [] )
- Stores supplemental tax registration for a single account.
- PutTaxExemption ( array $params = [] )
- Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.
- PutTaxInheritance ( array $params = [] )
- The updated tax inheritance status.
- PutTaxRegistration ( array $params = [] )
- Adds or updates tax registration for a single account.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchDeleteTaxRegistration
$result = $client->batchDeleteTaxRegistration
([/* ... */]); $promise = $client->batchDeleteTaxRegistrationAsync
([/* ... */]);
Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
Parameter Syntax
$result = $client->batchDeleteTaxRegistration([ 'accountIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- accountIds
-
- Required: Yes
- Type: Array of strings
List of unique account identifiers.
Result Syntax
[ 'errors' => [ [ 'accountId' => '<string>', 'code' => '<string>', 'message' => '<string>', ], // ... ], ]
Result Details
Members
- errors
-
- Required: Yes
- Type: Array of BatchDeleteTaxRegistrationError structures
The list of errors for the accounts the TRN information could not be deleted for.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
BatchGetTaxExemptions
$result = $client->batchGetTaxExemptions
([/* ... */]); $promise = $client->batchGetTaxExemptionsAsync
([/* ... */]);
Get the active tax exemptions for a given list of accounts.
Parameter Syntax
$result = $client->batchGetTaxExemptions([ 'accountIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- accountIds
-
- Required: Yes
- Type: Array of strings
List of unique account identifiers.
Result Syntax
[ 'failedAccounts' => ['<string>', ...], 'taxExemptionDetailsMap' => [ '<AccountId>' => [ 'heritageObtainedDetails' => true || false, 'heritageObtainedParentEntity' => '<string>', 'heritageObtainedReason' => '<string>', 'taxExemptions' => [ [ 'authority' => [ 'country' => '<string>', 'state' => '<string>', ], 'effectiveDate' => <DateTime>, 'expirationDate' => <DateTime>, 'status' => 'None|Valid|Expired|Pending', 'systemEffectiveDate' => <DateTime>, 'taxExemptionType' => [ 'applicableJurisdictions' => [ [ 'country' => '<string>', 'state' => '<string>', ], // ... ], 'description' => '<string>', 'displayName' => '<string>', ], ], // ... ], ], // ... ], ]
Result Details
Members
- failedAccounts
-
- Type: Array of strings
The list of accounts that failed to get tax exemptions.
- taxExemptionDetailsMap
-
- Type: Associative array of custom strings keys (AccountId) to TaxExemptionDetails structures
The tax exemption details map of accountId and tax exemption details.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
BatchPutTaxRegistration
$result = $client->batchPutTaxRegistration
([/* ... */]); $promise = $client->batchPutTaxRegistrationAsync
([/* ... */]);
Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocuments
field of theVerificationDetails
object.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personType
values arePhysical Person
andBusiness
.
Kenya
-
You must specify the
personType
in thekenyaAdditionalInfo
field of theadditionalTaxInformation
object. -
If the
personType
isPhysical Person
, you must specify the tax registration certificate document in thetaxRegistrationDocuments
field of theVerificationDetails
object.
Malaysia
-
The sector valid values are
Business
andIndividual
. -
RegistrationType
valid values areNRIC
for individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumber
inMalaysiaAdditionalInfo
with NRIC type, and a validMyKad
or NRIC number. -
For business, you must specify a
businessRegistrationNumber
inMalaysiaAdditionalInfo
with a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumber
andtaxInformationNumber
inMalaysiaAdditionalInfo
with a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber
,taxInformationNumber
, and distinctserviceTaxCodes
inMalaysiaAdditionalInfo
with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. -
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
Business
andIndividual
.
Saudi Arabia
-
For
address
, you must specifyaddressLine3
.
South Korea
-
You must specify the
certifiedEmailId
andlegalName
in theTaxRegistrationEntry
object. Use Korean characters forlegalName
. -
You must specify the
businessRepresentativeName
,itemOfBusiness
, andlineOfBusiness
in thesouthKoreaAdditionalInfo
field of theadditionalTaxInformation
object. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocuments
field of theVerificationDetails
object. -
For the
address
object, use Korean characters foraddressLine1
,addressLine2
city
,postalCode
, andstateOrRegion
.
Spain
-
You must specify the
registrationType
in thespainAdditionalInfo
field of theadditionalTaxInformation
object. -
If the
registrationType
isLocal
, you must specify the tax registration certificate document in thetaxRegistrationDocuments
field of theVerificationDetails
object.
Turkey
-
You must specify the
sector
in thetaxRegistrationEntry
object. -
If your
sector
isBusiness
,Individual
, orGovernment
:-
Specify the
taxOffice
. If yoursector
isIndividual
, don't enter this value. -
(Optional) Specify the
kepEmailId
. If yoursector
isIndividual
, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Government
appears as Public institutions
-
-
If your
sector
isBusiness
and you're subject to KDV tax, you must specify your industry in theindustries
field. -
For
address
, you must specifydistrictOrCounty
.
Ukraine
-
The sector valid values are
Business
andIndividual
.
Parameter Syntax
$result = $client->batchPutTaxRegistration([ 'accountIds' => ['<string>', ...], // REQUIRED 'taxRegistrationEntry' => [ // REQUIRED 'additionalTaxInformation' => [ 'canadaAdditionalInfo' => [ 'canadaQuebecSalesTaxNumber' => '<string>', 'canadaRetailSalesTaxNumber' => '<string>', 'isResellerAccount' => true || false, 'provincialSalesTaxId' => '<string>', ], 'estoniaAdditionalInfo' => [ 'registryCommercialCode' => '<string>', // REQUIRED ], 'georgiaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', // REQUIRED ], 'israelAdditionalInfo' => [ 'customerType' => 'Business|Individual', // REQUIRED 'dealerType' => 'Authorized|Non-authorized', // REQUIRED ], 'italyAdditionalInfo' => [ 'cigNumber' => '<string>', 'cupNumber' => '<string>', 'sdiAccountId' => '<string>', 'taxCode' => '<string>', ], 'kenyaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', // REQUIRED ], 'malaysiaAdditionalInfo' => [ 'businessRegistrationNumber' => '<string>', 'serviceTaxCodes' => ['<string>', ...], 'taxInformationNumber' => '<string>', ], 'polandAdditionalInfo' => [ 'individualRegistrationNumber' => '<string>', 'isGroupVatEnabled' => true || false, ], 'romaniaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', // REQUIRED ], 'saudiArabiaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber', ], 'southKoreaAdditionalInfo' => [ 'businessRepresentativeName' => '<string>', // REQUIRED 'itemOfBusiness' => '<string>', // REQUIRED 'lineOfBusiness' => '<string>', // REQUIRED ], 'spainAdditionalInfo' => [ 'registrationType' => 'Intra-EU|Local', // REQUIRED ], 'turkeyAdditionalInfo' => [ 'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies', 'kepEmailId' => '<string>', 'secondaryTaxId' => '<string>', 'taxOffice' => '<string>', ], 'ukraineAdditionalInfo' => [ 'ukraineTrnType' => 'Business|Individual', // REQUIRED ], ], 'certifiedEmailId' => '<string>', 'legalAddress' => [ 'addressLine1' => '<string>', // REQUIRED 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', // REQUIRED 'countryCode' => '<string>', // REQUIRED 'districtOrCounty' => '<string>', 'postalCode' => '<string>', // REQUIRED 'stateOrRegion' => '<string>', ], 'legalName' => '<string>', 'registrationId' => '<string>', // REQUIRED 'registrationType' => 'VAT|GST|CPF|CNPJ|SST|TIN|NRIC', // REQUIRED 'sector' => 'Business|Individual|Government', 'verificationDetails' => [ 'dateOfBirth' => '<string>', 'taxRegistrationDocuments' => [ [ 'file' => [ 'fileContent' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'fileName' => '<string>', // REQUIRED ], 's3Location' => [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED ], ], // ... ], ], ], ]);
Parameter Details
Members
- accountIds
-
- Required: Yes
- Type: Array of strings
List of unique account identifiers.
- taxRegistrationEntry
-
- Required: Yes
- Type: TaxRegistrationEntry structure
Your TRN information that will be stored to the accounts mentioned in
putEntries
.
Result Syntax
[ 'errors' => [ [ 'accountId' => '<string>', 'code' => '<string>', 'message' => '<string>', ], // ... ], 'status' => 'Verified|Pending|Deleted|Rejected', ]
Result Details
Members
- errors
-
- Required: Yes
- Type: Array of BatchPutTaxRegistrationError structures
List of errors for the accounts the TRN information could not be added or updated to.
- status
-
- Type: string
The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be
Verified
,Pending
orRejected
.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
DeleteSupplementalTaxRegistration
$result = $client->deleteSupplementalTaxRegistration
([/* ... */]); $promise = $client->deleteSupplementalTaxRegistrationAsync
([/* ... */]);
Deletes a supplemental tax registration for a single account.
Parameter Syntax
$result = $client->deleteSupplementalTaxRegistration([ 'authorityId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- authorityId
-
- Required: Yes
- Type: string
The unique authority Id for the supplemental TRN information that needs to be deleted.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
DeleteTaxRegistration
$result = $client->deleteTaxRegistration
([/* ... */]); $promise = $client->deleteTaxRegistrationAsync
([/* ... */]);
Deletes tax registration for a single account.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
Parameter Syntax
$result = $client->deleteTaxRegistration([ 'accountId' => '<string>', ]);
Parameter Details
Members
- accountId
-
- Type: string
Unique account identifier for the TRN information that needs to be deleted. If this isn't passed, the account ID corresponding to the credentials of the API caller will be used for this parameter.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
GetTaxExemptionTypes
$result = $client->getTaxExemptionTypes
([/* ... */]); $promise = $client->getTaxExemptionTypesAsync
([/* ... */]);
Get supported tax exemption types.
Parameter Syntax
$result = $client->getTaxExemptionTypes([ ]);
Parameter Details
Members
Result Syntax
[ 'taxExemptionTypes' => [ [ 'applicableJurisdictions' => [ [ 'country' => '<string>', 'state' => '<string>', ], // ... ], 'description' => '<string>', 'displayName' => '<string>', ], // ... ], ]
Result Details
Members
- taxExemptionTypes
-
- Type: Array of TaxExemptionType structures
The supported types of tax exemptions.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
GetTaxInheritance
$result = $client->getTaxInheritance
([/* ... */]); $promise = $client->getTaxInheritanceAsync
([/* ... */]);
The get account tax inheritance status.
Parameter Syntax
$result = $client->getTaxInheritance([ ]);
Parameter Details
Members
Result Syntax
[ 'heritageStatus' => 'OptIn|OptOut', ]
Result Details
Members
- heritageStatus
-
- Type: string
The tax inheritance status.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
GetTaxRegistration
$result = $client->getTaxRegistration
([/* ... */]); $promise = $client->getTaxRegistrationAsync
([/* ... */]);
Retrieves tax registration for a single account.
Parameter Syntax
$result = $client->getTaxRegistration([ 'accountId' => '<string>', ]);
Parameter Details
Members
- accountId
-
- Type: string
Your unique account identifier.
Result Syntax
[ 'taxRegistration' => [ 'additionalTaxInformation' => [ 'brazilAdditionalInfo' => [ 'ccmCode' => '<string>', 'legalNatureCode' => '<string>', ], 'canadaAdditionalInfo' => [ 'canadaQuebecSalesTaxNumber' => '<string>', 'canadaRetailSalesTaxNumber' => '<string>', 'isResellerAccount' => true || false, 'provincialSalesTaxId' => '<string>', ], 'estoniaAdditionalInfo' => [ 'registryCommercialCode' => '<string>', ], 'georgiaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', ], 'indiaAdditionalInfo' => [ 'pan' => '<string>', ], 'israelAdditionalInfo' => [ 'customerType' => 'Business|Individual', 'dealerType' => 'Authorized|Non-authorized', ], 'italyAdditionalInfo' => [ 'cigNumber' => '<string>', 'cupNumber' => '<string>', 'sdiAccountId' => '<string>', 'taxCode' => '<string>', ], 'kenyaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', ], 'malaysiaAdditionalInfo' => [ 'businessRegistrationNumber' => '<string>', 'serviceTaxCodes' => ['<string>', ...], 'taxInformationNumber' => '<string>', ], 'polandAdditionalInfo' => [ 'individualRegistrationNumber' => '<string>', 'isGroupVatEnabled' => true || false, ], 'romaniaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', ], 'saudiArabiaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber', ], 'southKoreaAdditionalInfo' => [ 'businessRepresentativeName' => '<string>', 'itemOfBusiness' => '<string>', 'lineOfBusiness' => '<string>', ], 'spainAdditionalInfo' => [ 'registrationType' => 'Intra-EU|Local', ], 'turkeyAdditionalInfo' => [ 'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies', 'kepEmailId' => '<string>', 'secondaryTaxId' => '<string>', 'taxOffice' => '<string>', ], 'ukraineAdditionalInfo' => [ 'ukraineTrnType' => 'Business|Individual', ], ], 'certifiedEmailId' => '<string>', 'legalAddress' => [ 'addressLine1' => '<string>', 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', 'countryCode' => '<string>', 'districtOrCounty' => '<string>', 'postalCode' => '<string>', 'stateOrRegion' => '<string>', ], 'legalName' => '<string>', 'registrationId' => '<string>', 'registrationType' => 'VAT|GST|CPF|CNPJ|SST|TIN|NRIC', 'sector' => 'Business|Individual|Government', 'status' => 'Verified|Pending|Deleted|Rejected', 'taxDocumentMetadatas' => [ [ 'taxDocumentAccessToken' => '<string>', 'taxDocumentName' => '<string>', ], // ... ], ], ]
Result Details
Members
- taxRegistration
-
- Type: TaxRegistration structure
TRN information of the account mentioned in the request.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
GetTaxRegistrationDocument
$result = $client->getTaxRegistrationDocument
([/* ... */]); $promise = $client->getTaxRegistrationDocumentAsync
([/* ... */]);
Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
Parameter Syntax
$result = $client->getTaxRegistrationDocument([ 'destinationS3Location' => [ 'bucket' => '<string>', // REQUIRED 'prefix' => '<string>', ], 'taxDocumentMetadata' => [ // REQUIRED 'taxDocumentAccessToken' => '<string>', // REQUIRED 'taxDocumentName' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- destinationS3Location
-
- Type: DestinationS3Location structure
The Amazon S3 bucket that you specify to download your tax documents to.
- taxDocumentMetadata
-
- Required: Yes
- Type: TaxDocumentMetadata structure
The metadata for your tax document.
Result Syntax
[ 'destinationFilePath' => '<string>', 'presignedS3Url' => '<string>', ]
Result Details
Members
- destinationFilePath
-
- Type: string
The file path of the Amazon S3 bucket where you want to download your tax document to.
- presignedS3Url
-
- Type: string
The Amazon S3 presigned URL of the tax registration document.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
ListSupplementalTaxRegistrations
$result = $client->listSupplementalTaxRegistrations
([/* ... */]); $promise = $client->listSupplementalTaxRegistrationsAsync
([/* ... */]);
Retrieves supplemental tax registrations for a single account.
Parameter Syntax
$result = $client->listSupplementalTaxRegistrations([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The number of
taxRegistrations
results you want in one response. - nextToken
-
- Type: string
The token to retrieve the next set of results.
Result Syntax
[ 'nextToken' => '<string>', 'taxRegistrations' => [ [ 'address' => [ 'addressLine1' => '<string>', 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', 'countryCode' => '<string>', 'districtOrCounty' => '<string>', 'postalCode' => '<string>', 'stateOrRegion' => '<string>', ], 'authorityId' => '<string>', 'legalName' => '<string>', 'registrationId' => '<string>', 'registrationType' => 'VAT', 'status' => 'Verified|Pending|Deleted|Rejected', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token to retrieve the next set of results.
- taxRegistrations
-
- Required: Yes
- Type: Array of SupplementalTaxRegistration structures
The list of supplemental tax registrations.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
ListTaxExemptions
$result = $client->listTaxExemptions
([/* ... */]); $promise = $client->listTaxExemptionsAsync
([/* ... */]);
Retrieves the tax exemption of accounts listed in a consolidated billing family.
Parameter Syntax
$result = $client->listTaxExemptions([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The number of results you want in one response.
- nextToken
-
- Type: string
The token to retrieve the next set of results.
Result Syntax
[ 'nextToken' => '<string>', 'taxExemptionDetailsMap' => [ '<AccountId>' => [ 'heritageObtainedDetails' => true || false, 'heritageObtainedParentEntity' => '<string>', 'heritageObtainedReason' => '<string>', 'taxExemptions' => [ [ 'authority' => [ 'country' => '<string>', 'state' => '<string>', ], 'effectiveDate' => <DateTime>, 'expirationDate' => <DateTime>, 'status' => 'None|Valid|Expired|Pending', 'systemEffectiveDate' => <DateTime>, 'taxExemptionType' => [ 'applicableJurisdictions' => [ [ 'country' => '<string>', 'state' => '<string>', ], // ... ], 'description' => '<string>', 'displayName' => '<string>', ], ], // ... ], ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token to retrieve the next set of results.
- taxExemptionDetailsMap
-
- Type: Associative array of custom strings keys (AccountId) to TaxExemptionDetails structures
The tax exemption details map of
accountId
and tax exemption details.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
ListTaxRegistrations
$result = $client->listTaxRegistrations
([/* ... */]); $promise = $client->listTaxRegistrationsAsync
([/* ... */]);
Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).
Parameter Syntax
$result = $client->listTaxRegistrations([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
Number of
accountDetails
results you want in one response. - nextToken
-
- Type: string
The token to retrieve the next set of results.
Result Syntax
[ 'accountDetails' => [ [ 'accountId' => '<string>', 'accountMetaData' => [ 'accountName' => '<string>', 'address' => [ 'addressLine1' => '<string>', 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', 'countryCode' => '<string>', 'districtOrCounty' => '<string>', 'postalCode' => '<string>', 'stateOrRegion' => '<string>', ], 'addressRoleMap' => [ '<AddressRoleType>' => [ 'countryCode' => '<string>', 'stateOrRegion' => '<string>', ], // ... ], 'addressType' => 'TaxAddress|BillingAddress|ContactAddress', 'seller' => '<string>', ], 'taxInheritanceDetails' => [ 'inheritanceObtainedReason' => '<string>', 'parentEntityId' => '<string>', ], 'taxRegistration' => [ 'additionalTaxInformation' => [ 'brazilAdditionalInfo' => [ 'ccmCode' => '<string>', 'legalNatureCode' => '<string>', ], 'canadaAdditionalInfo' => [ 'canadaQuebecSalesTaxNumber' => '<string>', 'canadaRetailSalesTaxNumber' => '<string>', 'isResellerAccount' => true || false, 'provincialSalesTaxId' => '<string>', ], 'estoniaAdditionalInfo' => [ 'registryCommercialCode' => '<string>', ], 'georgiaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', ], 'indiaAdditionalInfo' => [ 'pan' => '<string>', ], 'israelAdditionalInfo' => [ 'customerType' => 'Business|Individual', 'dealerType' => 'Authorized|Non-authorized', ], 'italyAdditionalInfo' => [ 'cigNumber' => '<string>', 'cupNumber' => '<string>', 'sdiAccountId' => '<string>', 'taxCode' => '<string>', ], 'kenyaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', ], 'malaysiaAdditionalInfo' => [ 'businessRegistrationNumber' => '<string>', 'serviceTaxCodes' => ['<string>', ...], 'taxInformationNumber' => '<string>', ], 'polandAdditionalInfo' => [ 'individualRegistrationNumber' => '<string>', 'isGroupVatEnabled' => true || false, ], 'romaniaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', ], 'saudiArabiaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber', ], 'southKoreaAdditionalInfo' => [ 'businessRepresentativeName' => '<string>', 'itemOfBusiness' => '<string>', 'lineOfBusiness' => '<string>', ], 'spainAdditionalInfo' => [ 'registrationType' => 'Intra-EU|Local', ], 'turkeyAdditionalInfo' => [ 'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies', 'kepEmailId' => '<string>', 'secondaryTaxId' => '<string>', 'taxOffice' => '<string>', ], 'ukraineAdditionalInfo' => [ 'ukraineTrnType' => 'Business|Individual', ], ], 'certifiedEmailId' => '<string>', 'jurisdiction' => [ 'countryCode' => '<string>', 'stateOrRegion' => '<string>', ], 'legalName' => '<string>', 'registrationId' => '<string>', 'registrationType' => 'VAT|GST|CPF|CNPJ|SST|TIN|NRIC', 'sector' => 'Business|Individual|Government', 'status' => 'Verified|Pending|Deleted|Rejected', 'taxDocumentMetadatas' => [ [ 'taxDocumentAccessToken' => '<string>', 'taxDocumentName' => '<string>', ], // ... ], ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- accountDetails
-
- Required: Yes
- Type: Array of AccountDetails structures
The list of account details. This contains account Ids and TRN Information for each of the linked accounts.
- nextToken
-
- Type: string
The token to retrieve the next set of results.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
PutSupplementalTaxRegistration
$result = $client->putSupplementalTaxRegistration
([/* ... */]); $promise = $client->putSupplementalTaxRegistrationAsync
([/* ... */]);
Stores supplemental tax registration for a single account.
Parameter Syntax
$result = $client->putSupplementalTaxRegistration([ 'taxRegistrationEntry' => [ // REQUIRED 'address' => [ // REQUIRED 'addressLine1' => '<string>', // REQUIRED 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', // REQUIRED 'countryCode' => '<string>', // REQUIRED 'districtOrCounty' => '<string>', 'postalCode' => '<string>', // REQUIRED 'stateOrRegion' => '<string>', ], 'legalName' => '<string>', // REQUIRED 'registrationId' => '<string>', // REQUIRED 'registrationType' => 'VAT', // REQUIRED ], ]);
Parameter Details
Members
- taxRegistrationEntry
-
- Required: Yes
- Type: SupplementalTaxRegistrationEntry structure
The supplemental TRN information that will be stored for the caller account ID.
Result Syntax
[ 'authorityId' => '<string>', 'status' => 'Verified|Pending|Deleted|Rejected', ]
Result Details
Members
- authorityId
-
- Required: Yes
- Type: string
Unique authority ID for the supplemental TRN information that was stored.
- status
-
- Required: Yes
- Type: string
The status of the supplemental TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be
Verified
,Pending
,Rejected
, orDeleted
.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
PutTaxExemption
$result = $client->putTaxExemption
([/* ... */]); $promise = $client->putTaxExemptionAsync
([/* ... */]);
Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.
Parameter Syntax
$result = $client->putTaxExemption([ 'accountIds' => ['<string>', ...], // REQUIRED 'authority' => [ // REQUIRED 'country' => '<string>', // REQUIRED 'state' => '<string>', ], 'exemptionCertificate' => [ // REQUIRED 'documentFile' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'documentName' => '<string>', // REQUIRED ], 'exemptionType' => '<string>', // REQUIRED ]);
Parameter Details
Members
- accountIds
-
- Required: Yes
- Type: Array of strings
The list of unique account identifiers.
- authority
-
- Required: Yes
- Type: Authority structure
The address domain associate with the tax information.
- exemptionCertificate
-
- Required: Yes
- Type: ExemptionCertificate structure
The exemption certificate.
- exemptionType
-
- Required: Yes
- Type: string
The exemption type.
Result Syntax
[ 'caseId' => '<string>', ]
Result Details
Members
- caseId
-
- Type: string
The customer support case ID.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- AccessDeniedException:
The access is denied for the Amazon Web Services Support API.
- CaseCreationLimitExceededException:
You've exceeded the Amazon Web Services Support case creation limit for your account.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- AttachmentUploadException:
Failed to upload the tax exemption document to Amazon Web Services Support case.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
PutTaxInheritance
$result = $client->putTaxInheritance
([/* ... */]); $promise = $client->putTaxInheritanceAsync
([/* ... */]);
The updated tax inheritance status.
Parameter Syntax
$result = $client->putTaxInheritance([ 'heritageStatus' => 'OptIn|OptOut', ]);
Parameter Details
Members
- heritageStatus
-
- Type: string
The tax inheritance status.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- ResourceNotFoundException:
The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
PutTaxRegistration
$result = $client->putTaxRegistration
([/* ... */]); $promise = $client->putTaxRegistrationAsync
([/* ... */]);
Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocuments
field of theVerificationDetails
object.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personType
values arePhysical Person
andBusiness
.
Kenya
-
You must specify the
personType
in thekenyaAdditionalInfo
field of theadditionalTaxInformation
object. -
If the
personType
isPhysical Person
, you must specify the tax registration certificate document in thetaxRegistrationDocuments
field of theVerificationDetails
object.
Malaysia
-
The sector valid values are
Business
andIndividual
. -
RegistrationType
valid values areNRIC
for individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumber
inMalaysiaAdditionalInfo
with NRIC type, and a validMyKad
or NRIC number. -
For business, you must specify a
businessRegistrationNumber
inMalaysiaAdditionalInfo
with a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumber
andtaxInformationNumber
inMalaysiaAdditionalInfo
with a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber
,taxInformationNumber
, and distinctserviceTaxCodes
inMalaysiaAdditionalInfo
with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. -
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
Business
andIndividual
.
Saudi Arabia
-
For
address
, you must specifyaddressLine3
.
South Korea
-
You must specify the
certifiedEmailId
andlegalName
in theTaxRegistrationEntry
object. Use Korean characters forlegalName
. -
You must specify the
businessRepresentativeName
,itemOfBusiness
, andlineOfBusiness
in thesouthKoreaAdditionalInfo
field of theadditionalTaxInformation
object. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocuments
field of theVerificationDetails
object. -
For the
address
object, use Korean characters foraddressLine1
,addressLine2
city
,postalCode
, andstateOrRegion
.
Spain
-
You must specify the
registrationType
in thespainAdditionalInfo
field of theadditionalTaxInformation
object. -
If the
registrationType
isLocal
, you must specify the tax registration certificate document in thetaxRegistrationDocuments
field of theVerificationDetails
object.
Turkey
-
You must specify the
sector
in thetaxRegistrationEntry
object. -
If your
sector
isBusiness
,Individual
, orGovernment
:-
Specify the
taxOffice
. If yoursector
isIndividual
, don't enter this value. -
(Optional) Specify the
kepEmailId
. If yoursector
isIndividual
, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Government
appears as Public institutions
-
-
If your
sector
isBusiness
and you're subject to KDV tax, you must specify your industry in theindustries
field. -
For
address
, you must specifydistrictOrCounty
.
Ukraine
-
The sector valid values are
Business
andIndividual
.
Parameter Syntax
$result = $client->putTaxRegistration([ 'accountId' => '<string>', 'taxRegistrationEntry' => [ // REQUIRED 'additionalTaxInformation' => [ 'canadaAdditionalInfo' => [ 'canadaQuebecSalesTaxNumber' => '<string>', 'canadaRetailSalesTaxNumber' => '<string>', 'isResellerAccount' => true || false, 'provincialSalesTaxId' => '<string>', ], 'estoniaAdditionalInfo' => [ 'registryCommercialCode' => '<string>', // REQUIRED ], 'georgiaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', // REQUIRED ], 'israelAdditionalInfo' => [ 'customerType' => 'Business|Individual', // REQUIRED 'dealerType' => 'Authorized|Non-authorized', // REQUIRED ], 'italyAdditionalInfo' => [ 'cigNumber' => '<string>', 'cupNumber' => '<string>', 'sdiAccountId' => '<string>', 'taxCode' => '<string>', ], 'kenyaAdditionalInfo' => [ 'personType' => 'Legal Person|Physical Person|Business', // REQUIRED ], 'malaysiaAdditionalInfo' => [ 'businessRegistrationNumber' => '<string>', 'serviceTaxCodes' => ['<string>', ...], 'taxInformationNumber' => '<string>', ], 'polandAdditionalInfo' => [ 'individualRegistrationNumber' => '<string>', 'isGroupVatEnabled' => true || false, ], 'romaniaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', // REQUIRED ], 'saudiArabiaAdditionalInfo' => [ 'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber', ], 'southKoreaAdditionalInfo' => [ 'businessRepresentativeName' => '<string>', // REQUIRED 'itemOfBusiness' => '<string>', // REQUIRED 'lineOfBusiness' => '<string>', // REQUIRED ], 'spainAdditionalInfo' => [ 'registrationType' => 'Intra-EU|Local', // REQUIRED ], 'turkeyAdditionalInfo' => [ 'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies', 'kepEmailId' => '<string>', 'secondaryTaxId' => '<string>', 'taxOffice' => '<string>', ], 'ukraineAdditionalInfo' => [ 'ukraineTrnType' => 'Business|Individual', // REQUIRED ], ], 'certifiedEmailId' => '<string>', 'legalAddress' => [ 'addressLine1' => '<string>', // REQUIRED 'addressLine2' => '<string>', 'addressLine3' => '<string>', 'city' => '<string>', // REQUIRED 'countryCode' => '<string>', // REQUIRED 'districtOrCounty' => '<string>', 'postalCode' => '<string>', // REQUIRED 'stateOrRegion' => '<string>', ], 'legalName' => '<string>', 'registrationId' => '<string>', // REQUIRED 'registrationType' => 'VAT|GST|CPF|CNPJ|SST|TIN|NRIC', // REQUIRED 'sector' => 'Business|Individual|Government', 'verificationDetails' => [ 'dateOfBirth' => '<string>', 'taxRegistrationDocuments' => [ [ 'file' => [ 'fileContent' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'fileName' => '<string>', // REQUIRED ], 's3Location' => [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED ], ], // ... ], ], ], ]);
Parameter Details
Members
- accountId
-
- Type: string
Your unique account identifier.
- taxRegistrationEntry
-
- Required: Yes
- Type: TaxRegistrationEntry structure
Your TRN information that will be stored to the account mentioned in
accountId
.
Result Syntax
[ 'status' => 'Verified|Pending|Deleted|Rejected', ]
Result Details
Members
- status
-
- Type: string
The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be
Verified
,Pending
orRejected
.
Errors
- ValidationException:
The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException:
The exception when the input is creating conflict with the given state.
- InternalServerException:
The exception thrown when an unexpected error occurs when processing a request.
Shapes
AccessDeniedException
Description
The access is denied for the Amazon Web Services Support API.
Members
- message
-
- Required: Yes
- Type: string
AccountDetails
Description
An object with your accountId
and TRN information.
Members
- accountId
-
- Type: string
List of unique account identifiers.
- accountMetaData
-
- Type: AccountMetaData structure
The meta data information associated with the account.
- taxInheritanceDetails
-
- Type: TaxInheritanceDetails structure
Tax inheritance information associated with the account.
- taxRegistration
-
- Type: TaxRegistrationWithJurisdiction structure
Your TRN information. Instead of having full legal address, here TRN information will have jurisdiction details (for example, country code and state/region/province if applicable).
AccountMetaData
Description
The meta data information associated with the account.
Members
- accountName
-
- Type: string
The Amazon Web Services accounts name.
- address
-
- Type: Address structure
The details of the address associated with the TRN information.
- addressRoleMap
-
- Type: Associative array of custom strings keys (AddressRoleType) to Jurisdiction structures
Address roles associated with the account containing country code information.
- addressType
-
- Type: string
The type of address associated with the legal profile.
- seller
-
- Type: string
Seller information associated with the account.
AdditionalInfoRequest
Description
Additional tax information associated with your tax registration number (TRN). Depending on the TRN for a specific country, you might need to specify this information when you set your TRN.
You can only specify one of the following parameters and the value can't be empty.
The parameter that you specify must match the country for the TRN, if available. For example, if you set a TRN in Canada for specific provinces, you must also specify the canadaAdditionalInfo
parameter.
Members
- canadaAdditionalInfo
-
- Type: CanadaAdditionalInfo structure
Additional tax information associated with your TRN in Canada.
- estoniaAdditionalInfo
-
- Type: EstoniaAdditionalInfo structure
Additional tax information to specify for a TRN in Estonia.
- georgiaAdditionalInfo
-
- Type: GeorgiaAdditionalInfo structure
Additional tax information to specify for a TRN in Georgia.
- israelAdditionalInfo
-
- Type: IsraelAdditionalInfo structure
Additional tax information to specify for a TRN in Israel.
- italyAdditionalInfo
-
- Type: ItalyAdditionalInfo structure
Additional tax information to specify for a TRN in Italy.
- kenyaAdditionalInfo
-
- Type: KenyaAdditionalInfo structure
Additional tax information to specify for a TRN in Kenya.
- malaysiaAdditionalInfo
-
- Type: MalaysiaAdditionalInfo structure
Additional tax information to specify for a TRN in Malaysia.
- polandAdditionalInfo
-
- Type: PolandAdditionalInfo structure
Additional tax information associated with your TRN in Poland.
- romaniaAdditionalInfo
-
- Type: RomaniaAdditionalInfo structure
Additional tax information to specify for a TRN in Romania.
- saudiArabiaAdditionalInfo
-
- Type: SaudiArabiaAdditionalInfo structure
Additional tax information associated with your TRN in Saudi Arabia.
- southKoreaAdditionalInfo
-
- Type: SouthKoreaAdditionalInfo structure
Additional tax information to specify for a TRN in South Korea.
- spainAdditionalInfo
-
- Type: SpainAdditionalInfo structure
Additional tax information to specify for a TRN in Spain.
- turkeyAdditionalInfo
-
- Type: TurkeyAdditionalInfo structure
Additional tax information to specify for a TRN in Turkey.
- ukraineAdditionalInfo
-
- Type: UkraineAdditionalInfo structure
Additional tax information associated with your TRN in Ukraine.
AdditionalInfoResponse
Description
Additional tax information associated with your TRN. The Tax Settings API returns country-specific information in the response when any additional information is present with your TRN for the following countries.
Members
- brazilAdditionalInfo
-
- Type: BrazilAdditionalInfo structure
Additional tax information associated with your TRN in Brazil. The Tax Settings API returns this information in your response when any additional information is present with your TRN in Brazil.
- canadaAdditionalInfo
-
- Type: CanadaAdditionalInfo structure
Additional tax information associated with your TRN in Canada.
- estoniaAdditionalInfo
-
- Type: EstoniaAdditionalInfo structure
Additional tax information associated with your TRN in Estonia.
- georgiaAdditionalInfo
-
- Type: GeorgiaAdditionalInfo structure
Additional tax information associated with your TRN in Georgia.
- indiaAdditionalInfo
-
- Type: IndiaAdditionalInfo structure
Additional tax information in India.
- israelAdditionalInfo
-
- Type: IsraelAdditionalInfo structure
Additional tax information associated with your TRN in Israel.
- italyAdditionalInfo
-
- Type: ItalyAdditionalInfo structure
Additional tax information associated with your TRN in Italy.
- kenyaAdditionalInfo
-
- Type: KenyaAdditionalInfo structure
Additional tax information associated with your TRN in Kenya.
- malaysiaAdditionalInfo
-
- Type: MalaysiaAdditionalInfo structure
Additional tax information associated with your TRN in Malaysia.
- polandAdditionalInfo
-
- Type: PolandAdditionalInfo structure
Additional tax information associated with your TRN in Poland.
- romaniaAdditionalInfo
-
- Type: RomaniaAdditionalInfo structure
Additional tax information to specify for a TRN in Romania.
- saudiArabiaAdditionalInfo
-
- Type: SaudiArabiaAdditionalInfo structure
Additional tax information associated with your TRN in Saudi Arabia.
- southKoreaAdditionalInfo
-
- Type: SouthKoreaAdditionalInfo structure
Additional tax information associated with your TRN in South Korea.
- spainAdditionalInfo
-
- Type: SpainAdditionalInfo structure
Additional tax information associated with your TRN in Spain.
- turkeyAdditionalInfo
-
- Type: TurkeyAdditionalInfo structure
Additional tax information associated with your TRN in Turkey.
- ukraineAdditionalInfo
-
- Type: UkraineAdditionalInfo structure
Additional tax information associated with your TRN in Ukraine.
Address
Description
The details of the address associated with the TRN information.
Members
- addressLine1
-
- Required: Yes
- Type: string
The first line of the address.
- addressLine2
-
- Type: string
The second line of the address, if applicable.
- addressLine3
-
- Type: string
The third line of the address, if applicable. Currently, the Tax Settings API accepts the
addressLine3
parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter theaddressLine3
and specify the building number for the address. For example, you might enter1234
. - city
-
- Required: Yes
- Type: string
The city that the address is in.
- countryCode
-
- Required: Yes
- Type: string
The country code for the country that the address is in.
- districtOrCounty
-
- Type: string
The district or county the address is located.
For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use
districtOrCounty
for the neighborhood name. - postalCode
-
- Required: Yes
- Type: string
The postal code associated with the address.
- stateOrRegion
-
- Type: string
The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.
If this is required for tax settings, use the same name as shown on the Tax Settings page.
AttachmentUploadException
Description
Failed to upload the tax exemption document to Amazon Web Services Support case.
Members
- message
-
- Required: Yes
- Type: string
Authority
Description
The address domain associate with the tax information.
Members
- country
-
- Required: Yes
- Type: string
The country code for the country that the address is in.
- state
-
- Type: string
The state that the address is located.
BatchDeleteTaxRegistrationError
Description
The error object for representing failures in the BatchDeleteTaxRegistration
operation.
Members
- accountId
-
- Required: Yes
- Type: string
The unique account identifier for the account whose tax registration couldn't be deleted during the
BatchDeleteTaxRegistration
operation. - code
-
- Type: string
The error code for an individual failure in BatchDeleteTaxRegistration operation.
- message
-
- Required: Yes
- Type: string
The error message for an individual failure in the
BatchDeleteTaxRegistration
operation.
BatchPutTaxRegistrationError
Description
The error object for representing failures in the BatchPutTaxRegistration
operation.
Members
- accountId
-
- Required: Yes
- Type: string
The unique account identifier for the account that the tax registration couldn't be added, or updated during the
BatchPutTaxRegistration
operation. - code
-
- Type: string
The error code for an individual failure in the
BatchPutTaxRegistration
operation. - message
-
- Required: Yes
- Type: string
The error message for an individual failure in the
BatchPutTaxRegistration
operation.
BrazilAdditionalInfo
Description
Additional tax information associated with your TRN in Brazil.
Members
- ccmCode
-
- Type: string
The Cadastro de Contribuintes Mobiliários (CCM) code for your TRN in Brazil. This only applies for a CNPJ tax type for the São Paulo municipality.
- legalNatureCode
-
- Type: string
Legal nature of business, based on your TRN in Brazil. This only applies for a CNPJ tax type.
CanadaAdditionalInfo
Description
Additional tax information associated with your TRN in Canada .
Members
- canadaQuebecSalesTaxNumber
-
- Type: string
The Quebec Sales Tax ID number. Leave blank if you do not have a Quebec Sales Tax ID number.
- canadaRetailSalesTaxNumber
-
- Type: string
Manitoba Retail Sales Tax ID number. Customers purchasing Amazon Web Services services for resale in Manitoba must provide a valid Retail Sales Tax ID number for Manitoba. Leave this blank if you do not have a Retail Sales Tax ID number in Manitoba or are not purchasing Amazon Web Services services for resale.
- isResellerAccount
-
- Type: boolean
The value for this parameter must be
true
if theprovincialSalesTaxId
value is provided for a TRN in British Columbia, Saskatchewan, or Manitoba provinces.To claim a provincial sales tax (PST) and retail sales tax (RST) reseller exemption, you must confirm that purchases from this account were made for resale. Otherwise, remove the PST or RST number from the
provincialSalesTaxId
parameter from your request. - provincialSalesTaxId
-
- Type: string
The provincial sales tax ID for your TRN in Canada. This parameter can represent the following:
-
Provincial sales tax ID number for British Columbia and Saskatchewan provinces
-
Manitoba retail sales tax ID number for Manitoba province
-
Quebec sales tax ID number for Quebec province
The Tax Setting API only accepts this parameter if the TRN is specified for the previous provinces. For other provinces, the Tax Settings API doesn't accept this parameter.
CaseCreationLimitExceededException
Description
You've exceeded the Amazon Web Services Support case creation limit for your account.
Members
- message
-
- Required: Yes
- Type: string
ConflictException
Description
The exception when the input is creating conflict with the given state.
Members
- errorCode
-
- Required: Yes
- Type: string
409
- message
-
- Required: Yes
- Type: string
DestinationS3Location
Description
The location of the Amazon S3 bucket that you specify to download your tax documents to.
Members
- bucket
-
- Required: Yes
- Type: string
The name of your Amazon S3 bucket that you specify to download your tax documents to.
- prefix
-
- Type: string
The Amazon S3 object prefix that you specify for your tax document file.
EstoniaAdditionalInfo
Description
Additional tax information associated with your TRN in Estonia.
Members
- registryCommercialCode
-
- Required: Yes
- Type: string
Registry commercial code (RCC) for your TRN in Estonia. This value is an eight-numeric string, such as
12345678
.
ExemptionCertificate
Description
The exemption certificate.
Members
- documentFile
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The exemption certificate file content.
- documentName
-
- Required: Yes
- Type: string
The exemption certificate file name.
GeorgiaAdditionalInfo
Description
Additional tax information associated with your TRN in Georgia.
Members
- personType
-
- Required: Yes
- Type: string
The legal person or physical person assigned to this TRN in Georgia.
IndiaAdditionalInfo
Description
Additional tax information in India.
Members
- pan
-
- Type: string
India pan information associated with the account.
InternalServerException
Description
The exception thrown when an unexpected error occurs when processing a request.
Members
- errorCode
-
- Required: Yes
- Type: string
500
- message
-
- Required: Yes
- Type: string
IsraelAdditionalInfo
Description
Additional tax information associated with your TRN in Israel.
Members
- customerType
-
- Required: Yes
- Type: string
Customer type for your TRN in Israel. The value can be
Business
orIndividual
. UseBusiness
for entities such as not-for-profit and financial institutions. - dealerType
-
- Required: Yes
- Type: string
Dealer type for your TRN in Israel. If you're not a local authorized dealer with an Israeli VAT ID, specify your tax identification number so that Amazon Web Services can send you a compliant tax invoice.
ItalyAdditionalInfo
Description
Additional tax information associated with your TRN in Italy.
Members
- cigNumber
-
- Type: string
The tender procedure identification code.
- cupNumber
-
- Type: string
Additional tax information to specify for a TRN in Italy. This is managed by the Interministerial Committee for Economic Planning (CIPE) which characterizes every public investment project (Individual Project Code).
- sdiAccountId
-
- Type: string
Additional tax information to specify for a TRN in Italy. Use CodiceDestinatario to receive your invoices via web service (API) or FTP.
- taxCode
-
- Type: string
List of service tax codes for your TRN in Italy. You can use your customer tax code as part of a VAT Group.
Jurisdiction
Description
The jurisdiction details of the TRN information of the customers. This doesn't contain full legal address, and contains only country code and state/region/province.
Members
- countryCode
-
- Required: Yes
- Type: string
The country code of the jurisdiction.
- stateOrRegion
-
- Type: string
The state, region, or province associated with the country of the jurisdiction, if applicable.
KenyaAdditionalInfo
Description
Additional tax information associated with your TRN in Kenya.
Members
- personType
-
- Required: Yes
- Type: string
The legal person or physical person assigned to this TRN in Kenya.
MalaysiaAdditionalInfo
Description
Additional tax information associated with your TRN in Malaysia.
Members
- businessRegistrationNumber
-
- Type: string
The tax registration number (TRN) in Malaysia.
For individual, you can specify the
taxInformationNumber
inMalaysiaAdditionalInfo
with NRIC type, and a valid MyKad or NRIC number. For business, you must specify abusinessRegistrationNumber
inMalaysiaAdditionalInfo
with a TIN type and tax identification number. For business resellers, you must specify abusinessRegistrationNumber
andtaxInformationNumber
inMalaysiaAdditionalInfo
with a sales and service tax (SST) type and a valid SST number.For business resellers with service codes, you must specify
businessRegistrationNumber
,taxInformationNumber
, and distinctserviceTaxCodes
inMalaysiaAdditionalInfo
with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. - serviceTaxCodes
-
- Type: Array of strings
List of service tax codes for your TRN in Malaysia.
- taxInformationNumber
-
- Type: string
The tax information number in Malaysia.
For individual, you can specify the
taxInformationNumber
inMalaysiaAdditionalInfo
with NRIC type, and a valid MyKad or NRIC number. For business resellers, you must specify abusinessRegistrationNumber
andtaxInformationNumber
inMalaysiaAdditionalInfo
with a sales and service tax (SST) type and a valid SST number.For business resellers with service codes, you must specify
businessRegistrationNumber
,taxInformationNumber
, and distinctserviceTaxCodes
inMalaysiaAdditionalInfo
with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number.
PolandAdditionalInfo
Description
Additional tax information associated with your TRN in Poland.
Members
- individualRegistrationNumber
-
- Type: string
The individual tax registration number (NIP). Individual NIP is valid for other taxes excluding VAT purposes.
- isGroupVatEnabled
-
- Type: boolean
True if your business is a member of a VAT group with a NIP active for VAT purposes. Otherwise, this is false.
ResourceNotFoundException
Description
The exception thrown when the input doesn't have a resource associated to it.
Members
- errorCode
-
- Required: Yes
- Type: string
404
- message
-
- Required: Yes
- Type: string
RomaniaAdditionalInfo
Description
Additional tax information to specify for a TRN in Romania.
Members
- taxRegistrationNumberType
-
- Required: Yes
- Type: string
The tax registration number type. The value can be
TaxRegistrationNumber
orLocalRegistrationNumber
.
SaudiArabiaAdditionalInfo
Description
Additional tax information associated with your TRN in Saudi Arabia.
Members
- taxRegistrationNumberType
-
- Type: string
The tax registration number type.
SourceS3Location
Description
The Amazon S3 bucket in your account where your tax document is located.
Members
- bucket
-
- Required: Yes
- Type: string
The name of your Amazon S3 bucket that your tax document is located.
- key
-
- Required: Yes
- Type: string
The object key of your tax document object in Amazon S3.
SouthKoreaAdditionalInfo
Description
Additional tax information associated with your TRN in South Korea.
Members
- businessRepresentativeName
-
- Required: Yes
- Type: string
The business legal name based on the most recently uploaded tax registration certificate.
- itemOfBusiness
-
- Required: Yes
- Type: string
Item of business based on the most recently uploaded tax registration certificate.
- lineOfBusiness
-
- Required: Yes
- Type: string
Line of business based on the most recently uploaded tax registration certificate.
SpainAdditionalInfo
Description
Additional tax information associated with your TRN in Spain.
Members
- registrationType
-
- Required: Yes
- Type: string
The registration type in Spain.
SupplementalTaxRegistration
Description
Supplemental TRN details.
Members
- address
-
- Required: Yes
- Type: Address structure
The details of the address associated with the TRN information.
- authorityId
-
- Required: Yes
- Type: string
Unique authority ID for the supplemental TRN.
- legalName
-
- Required: Yes
- Type: string
The legal name associated with your TRN registration.
- registrationId
-
- Required: Yes
- Type: string
The supplemental TRN unique identifier.
- registrationType
-
- Required: Yes
- Type: string
Type of supplemental TRN. Currently, this can only be VAT.
- status
-
- Required: Yes
- Type: string
The status of your TRN.
SupplementalTaxRegistrationEntry
Description
The supplemental TRN information to provide when adding or updating a supplemental TRN.
Members
- address
-
- Required: Yes
- Type: Address structure
The details of the address associated with the TRN information.
- legalName
-
- Required: Yes
- Type: string
The legal name associated with your TRN registration.
- registrationId
-
- Required: Yes
- Type: string
The supplemental TRN unique identifier.
- registrationType
-
- Required: Yes
- Type: string
Type of supplemental TRN. Currently, this can only be VAT.
TaxDocumentMetadata
Description
The metadata for your tax document.
Members
- taxDocumentAccessToken
-
- Required: Yes
- Type: string
The tax document access token, which contains information that the Tax Settings API uses to locate the tax document.
If you update your tax registration, the existing
taxDocumentAccessToken
won't be valid. To get the latest token, call theGetTaxRegistration
orListTaxRegistrations
API operation. This token is valid for 24 hours. - taxDocumentName
-
- Required: Yes
- Type: string
The name of your tax document.
TaxExemption
Description
The tax exemption.
Members
- authority
-
- Required: Yes
- Type: Authority structure
The address domain associate with tax exemption.
- effectiveDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The tax exemption effective date.
- expirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The tax exemption expiration date.
- status
-
- Type: string
The tax exemption status.
- systemEffectiveDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The tax exemption recording time in the
TaxSettings
system. - taxExemptionType
-
- Required: Yes
- Type: TaxExemptionType structure
The tax exemption type.
TaxExemptionDetails
Description
The tax exemption details.
Members
- heritageObtainedDetails
-
- Type: boolean
The indicator if the tax exemption is inherited from the consolidated billing family management account.
- heritageObtainedParentEntity
-
- Type: string
The consolidated billing family management account the tax exemption inherited from.
- heritageObtainedReason
-
- Type: string
The reason of the heritage inheritance.
- taxExemptions
-
- Type: Array of TaxExemption structures
Tax exemptions.
TaxExemptionType
Description
The tax exemption type.
Members
- applicableJurisdictions
-
- Type: Array of Authority structures
The tax exemption's applicable jurisdictions.
- description
-
- Type: string
The tax exemption's type description.
- displayName
-
- Type: string
The tax exemption's type display name.
TaxInheritanceDetails
Description
Tax inheritance information associated with the account.
Members
- inheritanceObtainedReason
-
- Type: string
Tax inheritance reason information associated with the account.
- parentEntityId
-
- Type: string
Tax inheritance parent account information associated with the account.
TaxRegistration
Description
Your TRN information.
Members
- additionalTaxInformation
-
- Type: AdditionalInfoResponse structure
Additional tax information associated with your TRN.
- certifiedEmailId
-
- Type: string
The email address to receive VAT invoices.
- legalAddress
-
- Required: Yes
- Type: Address structure
The legal address associated with your TRN registration.
- legalName
-
- Required: Yes
- Type: string
The legal name associated with your TRN registration.
- registrationId
-
- Required: Yes
- Type: string
Your tax registration unique identifier.
- registrationType
-
- Required: Yes
- Type: string
Type of your tax registration. This can be either
VAT
orGST
. - sector
-
- Type: string
The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government. Note that certain values may not applicable for the request country. Please refer to country specific information in API document.
- status
-
- Required: Yes
- Type: string
The status of your TRN. This can be either
Verified
,Pending
,Deleted
, orRejected
. - taxDocumentMetadatas
-
- Type: Array of TaxDocumentMetadata structures
The metadata for your tax document.
TaxRegistrationDocFile
Description
The tax registration document.
Members
- fileContent
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The tax registration document content.
- fileName
-
- Required: Yes
- Type: string
The tax registration document name.
TaxRegistrationDocument
Description
Tax registration document information.
Members
- file
-
- Type: TaxRegistrationDocFile structure
The tax registration document.
- s3Location
-
- Type: SourceS3Location structure
The Amazon S3 location where your tax registration document is stored.
TaxRegistrationEntry
Description
The TRN information you provide when you add a new TRN, or update.
Members
- additionalTaxInformation
-
- Type: AdditionalInfoRequest structure
Additional tax information associated with your TRN. You only need to specify this parameter if Amazon Web Services collects any additional information for your country within AdditionalInfoRequest.
- certifiedEmailId
-
- Type: string
The email address to receive VAT invoices.
- legalAddress
-
- Type: Address structure
The legal address associated with your TRN.
If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the legal address.
For TRNs in other countries and for CPF tax types Brazil, you must specify the legal address.
- legalName
-
- Type: string
The legal name associated with your TRN.
If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in other countries, you must specify the legal name.
- registrationId
-
- Required: Yes
- Type: string
Your tax registration unique identifier.
- registrationType
-
- Required: Yes
- Type: string
Your tax registration type. This can be either
VAT
orGST
. - sector
-
- Type: string
The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document.
- verificationDetails
-
- Type: VerificationDetails structure
Additional details needed to verify your TRN information in Brazil. You only need to specify this parameter when you set a TRN in Brazil that is the CPF tax type.
Don't specify this parameter to set a TRN in Brazil of the CNPJ tax type or to set a TRN for another country.
TaxRegistrationWithJurisdiction
Description
Your TRN information with jurisdiction details. This doesn't contain the full legal address associated with the TRN information.
Members
- additionalTaxInformation
-
- Type: AdditionalInfoResponse structure
Additional tax information associated with your TRN.
- certifiedEmailId
-
- Type: string
The email address to receive VAT invoices.
- jurisdiction
-
- Required: Yes
- Type: Jurisdiction structure
The jurisdiction associated with your TRN information.
- legalName
-
- Required: Yes
- Type: string
The legal name associated with your TRN information.
- registrationId
-
- Required: Yes
- Type: string
Your tax registration unique identifier.
- registrationType
-
- Required: Yes
- Type: string
The type of your tax registration. This can be either
VAT
orGST
. - sector
-
- Type: string
The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document.
- status
-
- Required: Yes
- Type: string
The status of your TRN. This can be either
Verified
,Pending
,Deleted
, orRejected
. - taxDocumentMetadatas
-
- Type: Array of TaxDocumentMetadata structures
The metadata for your tax document.
TurkeyAdditionalInfo
Description
Additional tax information associated with your TRN in Turkey.
Members
- industries
-
- Type: string
The industry information that tells the Tax Settings API if you're subject to additional withholding taxes. This information required for business-to-business (B2B) customers. This information is conditionally mandatory for B2B customers who are subject to KDV tax.
- kepEmailId
-
- Type: string
The Registered Electronic Mail (REM) that is used to send notarized communication. This parameter is optional for business-to-business (B2B) and business-to-government (B2G) customers. It's not required for business-to-consumer (B2C) customers.
- secondaryTaxId
-
- Type: string
Secondary tax ID (“harcama birimi VKN”si”). If one isn't provided, we will use your VKN as the secondary ID.
- taxOffice
-
- Type: string
The tax office where you're registered. You can enter this information as a string. The Tax Settings API will add this information to your invoice. This parameter is required for business-to-business (B2B) and business-to-government customers. It's not required for business-to-consumer (B2C) customers.
UkraineAdditionalInfo
Description
Additional tax information associated with your TRN in Ukraine.
Members
- ukraineTrnType
-
- Required: Yes
- Type: string
The tax registration type.
ValidationException
Description
The exception when the input doesn't pass validation for at least one of the input parameters.
Members
- errorCode
-
- Required: Yes
- Type: string
400
- fieldList
-
- Type: Array of ValidationExceptionField structures
400
- message
-
- Required: Yes
- Type: string
ValidationExceptionField
Description
The information about the specified parameter in the request that caused an error.
Members
- name
-
- Required: Yes
- Type: string
The name of the parameter that caused a
ValidationException
error.
VerificationDetails
Description
Required information to verify your TRN.
Members
- dateOfBirth
-
- Type: string
Date of birth to verify your submitted TRN. Use the
YYYY-MM-DD
format. - taxRegistrationDocuments
-
- Type: Array of TaxRegistrationDocument structures
The tax registration document, which is required for specific countries such as Bangladesh, Kenya, South Korea and Spain.