Interface TaxSettingsClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TaxSettingsClient extends AwsClient
Service client for accessing Tax Settings. This can be created using the static builder() method.

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

  • Field Details

  • Method Details

    • batchDeleteTaxRegistration

      Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.

      This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.

      Parameters:
      batchDeleteTaxRegistrationRequest -
      Returns:
      Result of the BatchDeleteTaxRegistration operation returned by the service.
      See Also:
    • batchDeleteTaxRegistration

      Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.

      This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.


      This is a convenience which creates an instance of the BatchDeleteTaxRegistrationRequest.Builder avoiding the need to create one manually via BatchDeleteTaxRegistrationRequest.builder()

      Parameters:
      batchDeleteTaxRegistrationRequest - A Consumer that will call methods on BatchDeleteTaxRegistrationRequest.Builder to create a request.
      Returns:
      Result of the BatchDeleteTaxRegistration operation returned by the service.
      See Also:
    • batchPutTaxRegistration

      Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

      To call this API operation for specific countries, see the following country-specific requirements.

      Bangladesh

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Brazil

      • You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

      • For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

      Georgia

      • The valid personType values are Physical Person and Business.

      Kenya

      • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

      • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Malaysia

      • If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

      • By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

      • Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

      • If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

      • Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

      • Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

        Taxable service and service tax codes:

        Consultancy - 9907061674

        Training or coaching service - 9907071685

        IT service - 9907101676

        Digital services and electronic medium - 9907121690

      Nepal

      • The sector valid values are Business and Individual.

      Saudi Arabia

      • For address, you must specify addressLine3.

      South Korea

      • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

      • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

      Spain

      • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

      • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Turkey

      • You must specify the sector in the taxRegistrationEntry object.

      • If your sector is Business, Individual, or Government:

        • Specify the taxOffice. If your sector is Individual, don't enter this value.

        • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

        • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

      • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

      • For address, you must specify districtOrCounty.

      Ukraine

      • The sector valid values are Business and Individual.

      Parameters:
      batchPutTaxRegistrationRequest -
      Returns:
      Result of the BatchPutTaxRegistration operation returned by the service.
      See Also:
    • batchPutTaxRegistration

      Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

      To call this API operation for specific countries, see the following country-specific requirements.

      Bangladesh

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Brazil

      • You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

      • For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

      Georgia

      • The valid personType values are Physical Person and Business.

      Kenya

      • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

      • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Malaysia

      • If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

      • By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

      • Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

      • If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

      • Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

      • Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

        Taxable service and service tax codes:

        Consultancy - 9907061674

        Training or coaching service - 9907071685

        IT service - 9907101676

        Digital services and electronic medium - 9907121690

      Nepal

      • The sector valid values are Business and Individual.

      Saudi Arabia

      • For address, you must specify addressLine3.

      South Korea

      • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

      • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

      Spain

      • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

      • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Turkey

      • You must specify the sector in the taxRegistrationEntry object.

      • If your sector is Business, Individual, or Government:

        • Specify the taxOffice. If your sector is Individual, don't enter this value.

        • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

        • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

      • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

      • For address, you must specify districtOrCounty.

      Ukraine

      • The sector valid values are Business and Individual.


      This is a convenience which creates an instance of the BatchPutTaxRegistrationRequest.Builder avoiding the need to create one manually via BatchPutTaxRegistrationRequest.builder()

      Parameters:
      batchPutTaxRegistrationRequest - A Consumer that will call methods on BatchPutTaxRegistrationRequest.Builder to create a request.
      Returns:
      Result of the BatchPutTaxRegistration operation returned by the service.
      See Also:
    • deleteTaxRegistration

      Deletes tax registration for a single account.

      This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.

      Parameters:
      deleteTaxRegistrationRequest -
      Returns:
      Result of the DeleteTaxRegistration operation returned by the service.
      See Also:
    • deleteTaxRegistration

      Deletes tax registration for a single account.

      This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.


      This is a convenience which creates an instance of the DeleteTaxRegistrationRequest.Builder avoiding the need to create one manually via DeleteTaxRegistrationRequest.builder()

      Parameters:
      deleteTaxRegistrationRequest - A Consumer that will call methods on DeleteTaxRegistrationRequest.Builder to create a request.
      Returns:
      Result of the DeleteTaxRegistration operation returned by the service.
      See Also:
    • getTaxRegistration

      Retrieves tax registration for a single account.

      Parameters:
      getTaxRegistrationRequest -
      Returns:
      Result of the GetTaxRegistration operation returned by the service.
      See Also:
    • getTaxRegistration

      Retrieves tax registration for a single account.


      This is a convenience which creates an instance of the GetTaxRegistrationRequest.Builder avoiding the need to create one manually via GetTaxRegistrationRequest.builder()

      Parameters:
      getTaxRegistrationRequest - A Consumer that will call methods on GetTaxRegistrationRequest.Builder to create a request.
      Returns:
      Result of the GetTaxRegistration operation returned by the service.
      See Also:
    • getTaxRegistrationDocument

      Downloads your tax documents to the Amazon S3 bucket that you specify in your request.

      Parameters:
      getTaxRegistrationDocumentRequest -
      Returns:
      Result of the GetTaxRegistrationDocument operation returned by the service.
      See Also:
    • getTaxRegistrationDocument

      Downloads your tax documents to the Amazon S3 bucket that you specify in your request.


      This is a convenience which creates an instance of the GetTaxRegistrationDocumentRequest.Builder avoiding the need to create one manually via GetTaxRegistrationDocumentRequest.builder()

      Parameters:
      getTaxRegistrationDocumentRequest - A Consumer that will call methods on GetTaxRegistrationDocumentRequest.Builder to create a request.
      Returns:
      Result of the GetTaxRegistrationDocument operation returned by the service.
      See Also:
    • listTaxRegistrations

      Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).

      Parameters:
      listTaxRegistrationsRequest -
      Returns:
      Result of the ListTaxRegistrations operation returned by the service.
      See Also:
    • listTaxRegistrations

      Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).


      This is a convenience which creates an instance of the ListTaxRegistrationsRequest.Builder avoiding the need to create one manually via ListTaxRegistrationsRequest.builder()

      Parameters:
      listTaxRegistrationsRequest - A Consumer that will call methods on ListTaxRegistrationsRequest.Builder to create a request.
      Returns:
      Result of the ListTaxRegistrations operation returned by the service.
      See Also:
    • listTaxRegistrationsPaginator

      This is a variant of listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream
       
       software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request);
       responses.stream().forEach(....);
       
       
      2) Using For loop
       {
           @code
           software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client
                   .listTaxRegistrationsPaginator(request);
           for (software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response : responses) {
               // do something;
           }
       }
       
      3) Use iterator directly
       
       software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request);
       responses.iterator().forEachRemaining(....);
       
       

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest) operation.

      Parameters:
      listTaxRegistrationsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      See Also:
    • listTaxRegistrationsPaginator

      This is a variant of listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream
       
       software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request);
       responses.stream().forEach(....);
       
       
      2) Using For loop
       {
           @code
           software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client
                   .listTaxRegistrationsPaginator(request);
           for (software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response : responses) {
               // do something;
           }
       }
       
      3) Use iterator directly
       
       software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request);
       responses.iterator().forEachRemaining(....);
       
       

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest) operation.


      This is a convenience which creates an instance of the ListTaxRegistrationsRequest.Builder avoiding the need to create one manually via ListTaxRegistrationsRequest.builder()

      Parameters:
      listTaxRegistrationsRequest - A Consumer that will call methods on ListTaxRegistrationsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      See Also:
    • putTaxRegistration

      Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

      To call this API operation for specific countries, see the following country-specific requirements.

      Bangladesh

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Brazil

      • You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

      • For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

      Georgia

      • The valid personType values are Physical Person and Business.

      Kenya

      • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

      • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Malaysia

      • If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

      • By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

      • Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

      • If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

      • Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

      • Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

        Taxable service and service tax codes:

        Consultancy - 9907061674

        Training or coaching service - 9907071685

        IT service - 9907101676

        Digital services and electronic medium - 9907121690

      Nepal

      • The sector valid values are Business and Individual.

      Saudi Arabia

      • For address, you must specify addressLine3.

      South Korea

      • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

      • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

      Spain

      • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

      • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Turkey

      • You must specify the sector in the taxRegistrationEntry object.

      • If your sector is Business, Individual, or Government:

        • Specify the taxOffice. If your sector is Individual, don't enter this value.

        • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

        • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

      • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

      • For address, you must specify districtOrCounty.

      Ukraine

      • The sector valid values are Business and Individual.

      Parameters:
      putTaxRegistrationRequest -
      Returns:
      Result of the PutTaxRegistration operation returned by the service.
      See Also:
    • putTaxRegistration

      Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

      To call this API operation for specific countries, see the following country-specific requirements.

      Bangladesh

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Brazil

      • You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

      • For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

      Georgia

      • The valid personType values are Physical Person and Business.

      Kenya

      • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

      • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Malaysia

      • If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

      • By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

      • Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

      • If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

      • Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

      • Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

        Taxable service and service tax codes:

        Consultancy - 9907061674

        Training or coaching service - 9907071685

        IT service - 9907101676

        Digital services and electronic medium - 9907121690

      Nepal

      • The sector valid values are Business and Individual.

      Saudi Arabia

      • For address, you must specify addressLine3.

      South Korea

      • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

      • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

      • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

      Spain

      • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

      • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

      Turkey

      • You must specify the sector in the taxRegistrationEntry object.

      • If your sector is Business, Individual, or Government:

        • Specify the taxOffice. If your sector is Individual, don't enter this value.

        • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

        • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

      • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

      • For address, you must specify districtOrCounty.

      Ukraine

      • The sector valid values are Business and Individual.


      This is a convenience which creates an instance of the PutTaxRegistrationRequest.Builder avoiding the need to create one manually via PutTaxRegistrationRequest.builder()

      Parameters:
      putTaxRegistrationRequest - A Consumer that will call methods on PutTaxRegistrationRequest.Builder to create a request.
      Returns:
      Result of the PutTaxRegistration operation returned by the service.
      See Also:
    • create

      static TaxSettingsClient create()
      Create a TaxSettingsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      static TaxSettingsClientBuilder builder()
      Create a builder that can be used to configure and create a TaxSettingsClient.
    • serviceMetadata

      static ServiceMetadata serviceMetadata()
    • serviceClientConfiguration

      default TaxSettingsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration