TaxSettings / Client / list_supplemental_tax_registrations

list_supplemental_tax_registrations

TaxSettings.Client.list_supplemental_tax_registrations(**kwargs)

Retrieves supplemental tax registrations for a single account.

See also: AWS API Documentation

Request Syntax

response = client.list_supplemental_tax_registrations(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The number of taxRegistrations results you want in one response.

• nextToken (string) – The token to retrieve the next set of results.

Return type:

dict

Returns:

Response 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'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    The token to retrieve the next set of results.

  • taxRegistrations (list) –

    The list of supplemental tax registrations.

    • (dict) –

      Supplemental TRN details.

      • address (dict) –

        The details of the address associated with the TRN information.

        • addressLine1 (string) –

          The first line of the address.

        • addressLine2 (string) –

          The second line of the address, if applicable.

        • addressLine3 (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 the addressLine3 and specify the building number for the address. For example, you might enter 1234.

        • city (string) –

          The city that the address is in.

        • countryCode (string) –

          The country code for the country that the address is in.

        • districtOrCounty (string) –

          The district or county the address is located.

          Note

          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 (string) –

          The postal code associated with the address.

        • stateOrRegion (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.

      • authorityId (string) –

        Unique authority ID for the supplemental TRN.

      • legalName (string) –

        The legal name associated with your TRN registration.

      • registrationId (string) –

        The supplemental TRN unique identifier.

      • registrationType (string) –

        Type of supplemental TRN. Currently, this can only be VAT.

      • status (string) –

        The status of your TRN.

Exceptions

• TaxSettings.Client.exceptions.ValidationException

• TaxSettings.Client.exceptions.ResourceNotFoundException

• TaxSettings.Client.exceptions.InternalServerException