Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTaxRegistrations

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).

Request Syntax


POST /ListTaxRegistrations HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Number of accountDetails results you want in one response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: ^[-A-Za-z0-9_+\=\/]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accountDetails": [ 
      { 
         "accountId": "string",
         "accountMetaData": { 
            "accountName": "string",
            "address": { 
               "addressLine1": "string",
               "addressLine2": "string",
               "addressLine3": "string",
               "city": "string",
               "countryCode": "string",
               "districtOrCounty": "string",
               "postalCode": "string",
               "stateOrRegion": "string"
            },
            "addressRoleMap": { 
               "string" : { 
                  "countryCode": "string",
                  "stateOrRegion": "string"
               }
            },
            "addressType": "string",
            "seller": "string"
         },
         "taxInheritanceDetails": { 
            "inheritanceObtainedReason": "string",
            "parentEntityId": "string"
         },
         "taxRegistration": { 
            "additionalTaxInformation": { 
               "brazilAdditionalInfo": { 
                  "ccmCode": "string",
                  "legalNatureCode": "string"
               },
               "canadaAdditionalInfo": { 
                  "canadaQuebecSalesTaxNumber": "string",
                  "canadaRetailSalesTaxNumber": "string",
                  "isResellerAccount": boolean,
                  "provincialSalesTaxId": "string"
               },
               "estoniaAdditionalInfo": { 
                  "registryCommercialCode": "string"
               },
               "georgiaAdditionalInfo": { 
                  "personType": "string"
               },
               "indiaAdditionalInfo": { 
                  "pan": "string"
               },
               "israelAdditionalInfo": { 
                  "customerType": "string",
                  "dealerType": "string"
               },
               "italyAdditionalInfo": { 
                  "cigNumber": "string",
                  "cupNumber": "string",
                  "sdiAccountId": "string",
                  "taxCode": "string"
               },
               "kenyaAdditionalInfo": { 
                  "personType": "string"
               },
               "malaysiaAdditionalInfo": { 
                  "serviceTaxCodes": [ "string" ]
               },
               "polandAdditionalInfo": { 
                  "individualRegistrationNumber": "string",
                  "isGroupVatEnabled": boolean
               },
               "romaniaAdditionalInfo": { 
                  "taxRegistrationNumberType": "string"
               },
               "saudiArabiaAdditionalInfo": { 
                  "taxRegistrationNumberType": "string"
               },
               "southKoreaAdditionalInfo": { 
                  "businessRepresentativeName": "string",
                  "itemOfBusiness": "string",
                  "lineOfBusiness": "string"
               },
               "spainAdditionalInfo": { 
                  "registrationType": "string"
               },
               "turkeyAdditionalInfo": { 
                  "industries": "string",
                  "kepEmailId": "string",
                  "secondaryTaxId": "string",
                  "taxOffice": "string"
               },
               "ukraineAdditionalInfo": { 
                  "ukraineTrnType": "string"
               }
            },
            "certifiedEmailId": "string",
            "jurisdiction": { 
               "countryCode": "string",
               "stateOrRegion": "string"
            },
            "legalName": "string",
            "registrationId": "string",
            "registrationType": "string",
            "sector": "string",
            "status": "string",
            "taxDocumentMetadatas": [ 
               { 
                  "taxDocumentAccessToken": "string",
                  "taxDocumentName": "string"
               }
            ]
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

accountDetails

The list of account details. This contains account Ids and TRN Information for each of the linked accounts.

Type: Array of AccountDetails objects

nextToken

The token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: ^[-A-Za-z0-9_+\=\/]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The exception thrown when an unexpected error occurs when processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The exception thrown when the input doesn't have a resource associated to it.

HTTP Status Code: 404

ValidationException

The exception when the input doesn't pass validation for at least one of the input parameters.

HTTP Status Code: 400