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

ListSupplementalTaxRegistrations

Retrieves supplemental tax registrations for a single account.

Request Syntax


POST /ListSupplementalTaxRegistrations 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

The number of taxRegistrations 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

{
   "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": "string",
         "status": "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.

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_+\=\/]+$

taxRegistrations

The list of supplemental tax registrations.

Type: Array of SupplementalTaxRegistration objects

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