TaxSettings / Paginator / ListSupplementalTaxRegistrations

ListSupplementalTaxRegistrations

class TaxSettings.Paginator.ListSupplementalTaxRegistrations

paginator = client.get_paginator('list_supplemental_tax_registrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TaxSettings.Client.list_supplemental_tax_registrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.