TaxSettings / Paginator / ListTaxRegistrations

ListTaxRegistrations

class TaxSettings.Paginator.ListTaxRegistrations

paginator = client.get_paginator('list_tax_registrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TaxSettings.Client.list_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

{
    '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': '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': {
                        'serviceTaxCodes': [
                            'Consultancy'|'Digital Service And Electronic Medium'|'IT Services'|'Training Or Coaching',
                        ]
                    },
                    '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',
                'sector': 'Business'|'Individual'|'Government',
                'status': 'Verified'|'Pending'|'Deleted'|'Rejected',
                'taxDocumentMetadatas': [
                    {
                        'taxDocumentAccessToken': 'string',
                        'taxDocumentName': 'string'
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • accountDetails (list) –

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

    • (dict) –

      An object with your accountId and TRN information.

      • accountId (string) –

        List of unique account identifiers.

      • accountMetaData (dict) –

        The meta data information associated with the account.

        • accountName (string) –

          The Amazon Web Services accounts name.

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

            If this is required for tax settings, use the same name as shown on the Tax Settings page.

        • addressRoleMap (dict) –

          Address roles associated with the account containing country code information.

          • (string) –

            • (dict) –

              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.

              • countryCode (string) –

                The country code of the jurisdiction.

              • stateOrRegion (string) –

                The state, region, or province associated with the country of the jurisdiction, if applicable.

        • addressType (string) –

          The type of address associated with the legal profile.

        • seller (string) –

          Seller information associated with the account.

      • taxInheritanceDetails (dict) –

        Tax inheritance information associated with the account.

        • inheritanceObtainedReason (string) –

          Tax inheritance reason information associated with the account.

        • parentEntityId (string) –

          Tax inheritance parent account information associated with the account.

      • taxRegistration (dict) –

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

        • additionalTaxInformation (dict) –

          Additional tax information associated with your TRN.

          • brazilAdditionalInfo (dict) –

            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.

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

              Legal nature of business, based on your TRN in Brazil. This only applies for a CNPJ tax type.

          • canadaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Canada.

            • canadaQuebecSalesTaxNumber (string) –

              The Quebec Sales Tax ID number. Leave blank if you do not have a Quebec Sales Tax ID number.

            • canadaRetailSalesTaxNumber (string) –

              Manitoba Retail Sales Tax ID number. Customers purchasing Amazon Web 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 for resale.

            • isResellerAccount (boolean) –

              The value for this parameter must be true if the provincialSalesTaxId 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 (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.

          • estoniaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Estonia.

            • registryCommercialCode (string) –

              Registry commercial code (RCC) for your TRN in Estonia. This value is an eight-numeric string, such as 12345678.

          • georgiaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Georgia.

            • personType (string) –

              The legal person or physical person assigned to this TRN in Georgia.

          • indiaAdditionalInfo (dict) –

            Additional tax information in India.

            • pan (string) –

              India pan information associated with the account.

          • israelAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Israel.

            • customerType (string) –

              Customer type for your TRN in Israel. The value can be Business or Individual. Use ``Business``for entities such as not-for-profit and financial institutions.

            • dealerType (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 (dict) –

            Additional tax information associated with your TRN in Italy.

            • cigNumber (string) –

              The tender procedure identification code.

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

              Additional tax information to specify for a TRN in Italy. Use CodiceDestinatario to receive your invoices via web service (API) or FTP.

            • taxCode (string) –

              List of service tax codes for your TRN in Italy. You can use your customer tax code as part of a VAT Group.

          • kenyaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Kenya.

            • personType (string) –

              The legal person or physical person assigned to this TRN in Kenya.

          • malaysiaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Malaysia.

            • serviceTaxCodes (list) –

              List of service tax codes for your TRN in Malaysia.

              • (string) –

          • polandAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Poland.

            • individualRegistrationNumber (string) –

              The individual tax registration number (NIP). Individual NIP is valid for other taxes excluding VAT purposes.

            • isGroupVatEnabled (boolean) –

              True if your business is a member of a VAT group with a NIP active for VAT purposes. Otherwise, this is false.

          • romaniaAdditionalInfo (dict) –

            Additional tax information to specify for a TRN in Romania.

            • taxRegistrationNumberType (string) –

              The tax registration number type. The value can be TaxRegistrationNumber or LocalRegistrationNumber.

          • saudiArabiaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Saudi Arabia.

            • taxRegistrationNumberType (string) –

              The tax registration number type.

          • southKoreaAdditionalInfo (dict) –

            Additional tax information associated with your TRN in South Korea.

            • businessRepresentativeName (string) –

              The business legal name based on the most recently uploaded tax registration certificate.

            • itemOfBusiness (string) –

              Item of business based on the most recently uploaded tax registration certificate.

            • lineOfBusiness (string) –

              Line of business based on the most recently uploaded tax registration certificate.

          • spainAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Spain.

            • registrationType (string) –

              The registration type in Spain.

          • turkeyAdditionalInfo (dict) –

            Additional tax information associated with your TRN in Turkey.

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

              Secondary tax ID (“harcama birimi VKN”si”). If one isn’t provided, we will use your VKN as the secondary ID.

            • taxOffice (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 (dict) –

            Additional tax information associated with your TRN in Ukraine.

            • ukraineTrnType (string) –

              The tax registration type.

        • certifiedEmailId (string) –

          The email address to receive VAT invoices.

        • jurisdiction (dict) –

          The jurisdiction associated with your TRN information.

          • countryCode (string) –

            The country code of the jurisdiction.

          • stateOrRegion (string) –

            The state, region, or province associated with the country of the jurisdiction, if applicable.

        • legalName (string) –

          The legal name associated with your TRN information.

        • registrationId (string) –

          Your tax registration unique identifier.

        • registrationType (string) –

          The type of your tax registration. This can be either VAT or GST.

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

          The status of your TRN. This can be either Verified, Pending, Deleted, or Rejected.

        • taxDocumentMetadatas (list) –

          The metadata for your tax document.

          • (dict) –

            The metadata for your tax document.

            • taxDocumentAccessToken (string) –

              The tax document access token, which contains information that the Tax Settings API uses to locate the tax document.

              Note

              If you update your tax registration, the existing taxDocumentAccessToken won’t be valid. To get the latest token, call the GetTaxRegistration or ListTaxRegistrations API operation. This token is valid for 24 hours.

            • taxDocumentName (string) –

              The name of your tax document.

  • NextToken (string) –

    A token to resume pagination.