TaxSettings *********** Client ====== class TaxSettings.Client A low-level client representing Tax Settings You can use the tax setting API to programmatically set, modify, and delete the tax registration number (TRN), associated business legal name, and address (Collectively referred to as "TRN information"). You can also programmatically view TRN information and tax addresses ("Tax profiles"). You can use this API to automate your TRN information settings instead of manually using the console. Service Endpoint * https://tax.us-east-1.amazonaws.com import boto3 client = boto3.client('taxsettings') These are the available methods: * batch_delete_tax_registration * batch_get_tax_exemptions * batch_put_tax_registration * can_paginate * close * delete_supplemental_tax_registration * delete_tax_registration * get_paginator * get_tax_exemption_types * get_tax_inheritance * get_tax_registration * get_tax_registration_document * get_waiter * list_supplemental_tax_registrations * list_tax_exemptions * list_tax_registrations * put_supplemental_tax_registration * put_tax_exemption * put_tax_inheritance * put_tax_registration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListSupplementalTaxRegistrations * ListTaxExemptions * ListTaxRegistrations TaxSettings / Paginator / ListTaxExemptions ListTaxExemptions ***************** class TaxSettings.Paginator.ListTaxExemptions paginator = client.get_paginator('list_tax_exemptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "TaxSettings.Client.list_tax_exemptions()". 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** { 'taxExemptionDetailsMap': { 'string': { 'heritageObtainedDetails': True|False, 'heritageObtainedParentEntity': 'string', 'heritageObtainedReason': 'string', 'taxExemptions': [ { 'authority': { 'country': 'string', 'state': 'string' }, 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'status': 'None'|'Valid'|'Expired'|'Pending', 'systemEffectiveDate': datetime(2015, 1, 1), 'taxExemptionType': { 'applicableJurisdictions': [ { 'country': 'string', 'state': 'string' }, ], 'description': 'string', 'displayName': 'string' } }, ] } }, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **taxExemptionDetailsMap** *(dict) --* The tax exemption details map of "accountId" and tax exemption details. * *(string) --* * *(dict) --* The tax exemption details. * **heritageObtainedDetails** *(boolean) --* The indicator if the tax exemption is inherited from the consolidated billing family management account. * **heritageObtainedParentEntity** *(string) --* The consolidated billing family management account the tax exemption inherited from. * **heritageObtainedReason** *(string) --* The reason of the heritage inheritance. * **taxExemptions** *(list) --* Tax exemptions. * *(dict) --* The tax exemption. * **authority** *(dict) --* The address domain associate with tax exemption. * **country** *(string) --* The country code for the country that the address is in. * **state** *(string) --* The state that the address is located. * **effectiveDate** *(datetime) --* The tax exemption effective date. * **expirationDate** *(datetime) --* The tax exemption expiration date. * **status** *(string) --* The tax exemption status. * **systemEffectiveDate** *(datetime) --* The tax exemption recording time in the "TaxSettings" system. * **taxExemptionType** *(dict) --* The tax exemption type. * **applicableJurisdictions** *(list) --* The tax exemption's applicable jurisdictions. * *(dict) --* The address domain associate with the tax information. * **country** *(string) --* The country code for the country that the address is in. * **state** *(string) --* The state that the address is located. * **description** *(string) --* The tax exemption's type description. * **displayName** *(string) --* The tax exemption's type display name. * **NextToken** *(string) --* A token to resume pagination. 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' }, 'egyptAdditionalInfo': { 'uniqueIdentificationNumber': 'string', 'uniqueIdentificationNumberExpirationDate': 'string' }, 'estoniaAdditionalInfo': { 'registryCommercialCode': 'string' }, 'georgiaAdditionalInfo': { 'personType': 'Legal Person'|'Physical Person'|'Business' }, 'greeceAdditionalInfo': { 'contractingAuthorityCode': 'string' }, 'indiaAdditionalInfo': { 'pan': 'string' }, 'indonesiaAdditionalInfo': { 'decisionNumber': 'string', 'ppnExceptionDesignationCode': 'string', 'taxRegistrationNumberType': 'NIK'|'PassportNumber'|'NPWP'|'NITKU' }, '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': { 'businessRegistrationNumber': 'string', 'serviceTaxCodes': [ 'Consultancy'|'Digital Service And Electronic Medium'|'IT Services'|'Training Or Coaching', ], 'taxInformationNumber': 'string' }, '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' }, 'uzbekistanAdditionalInfo': { 'taxRegistrationNumberType': 'Business'|'Individual', 'vatRegistrationNumber': 'string' }, 'vietnamAdditionalInfo': { 'electronicTransactionCodeNumber': 'string', 'enterpriseIdentificationNumber': 'string', 'paymentVoucherNumber': 'string', 'paymentVoucherNumberDate': 'string' } }, 'certifiedEmailId': 'string', 'jurisdiction': { 'countryCode': 'string', 'stateOrRegion': 'string' }, 'legalName': 'string', 'registrationId': 'string', 'registrationType': 'VAT'|'GST'|'CPF'|'CNPJ'|'SST'|'TIN'|'NRIC', '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. 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. * **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 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 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. * **egyptAdditionalInfo** *(dict) --* Additional tax information to specify for a TRN in Egypt. * **uniqueIdentificationNumber** *(string) --* The unique identification number provided by the Egypt Tax Authority. * **uniqueIdentificationNumberExpirationDate** *(string) --* The expiration date of the unique identification number provided by the Egypt Tax Authority. * **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. * **greeceAdditionalInfo** *(dict) --* Additional tax information to specify for a TRN in Greece. * **contractingAuthorityCode** *(string) --* The code of contracting authority for e-invoicing. * **indiaAdditionalInfo** *(dict) --* Additional tax information in India. * **pan** *(string) --* India pan information associated with the account. * **indonesiaAdditionalInfo** *(dict) --* Additional tax information associated with your TRN in Indonesia. * **decisionNumber** *(string) --* VAT-exempt customers have a Directorate General of Taxation (DGT) exemption letter or certificate (Surat Keterangan Bebas) decision number. Non-collected VAT have a DGT letter or certificate (Surat Keterangan Tidak Dipungut). * **ppnExceptionDesignationCode** *(string) --* Exception code if you are designated by Directorate General of Taxation (DGT) as a VAT collector, non-collected VAT, or VAT-exempt customer. * **taxRegistrationNumberType** *(string) --* The tax registration number type. * **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 >>``<>``<>``<>``<>``<