We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.TaxSettings

Inherits:
AWS.Service show all
Identifier:
taxsettings
API Version:
2018-05-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using TaxSettings

var taxsettings = new AWS.TaxSettings();
taxsettings.batchDeleteTaxRegistration(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the TaxSettings object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var taxsettings = new AWS.TaxSettings({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the taxsettings service identifier:

AWS.config.apiVersions = {
  taxsettings: '2018-05-10',
  // other service API versions
};

var taxsettings = new AWS.TaxSettings();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.TaxSettings(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a TaxSettings object

var taxsettings = new AWS.TaxSettings({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.TaxSettings.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.TaxSettings.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.TaxSettings.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteTaxRegistration(params = {}, callback) ⇒ AWS.Request

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

Note: 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.

Service Reference:

Examples:

Calling the batchDeleteTaxRegistration operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
taxsettings.batchDeleteTaxRegistration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      List of unique account identifiers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • errors — (Array<map>)

        The list of errors for the accounts the TRN information could not be deleted for.

        • accountIdrequired — (String)

          The unique account identifier for the account whose tax registration couldn't be deleted during the BatchDeleteTaxRegistration operation.

        • code — (String)

          The error code for an individual failure in BatchDeleteTaxRegistration operation.

        • messagerequired — (String)

          The error message for an individual failure in the BatchDeleteTaxRegistration operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchPutTaxRegistration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchPutTaxRegistration operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  taxRegistrationEntry: { /* required */
    registrationId: 'STRING_VALUE', /* required */
    registrationType: VAT | GST | CPF | CNPJ | SST, /* required */
    additionalTaxInformation: {
      canadaAdditionalInfo: {
        canadaQuebecSalesTaxNumber: 'STRING_VALUE',
        canadaRetailSalesTaxNumber: 'STRING_VALUE',
        isResellerAccount: true || false,
        provincialSalesTaxId: 'STRING_VALUE'
      },
      estoniaAdditionalInfo: {
        registryCommercialCode: 'STRING_VALUE' /* required */
      },
      georgiaAdditionalInfo: {
        personType: Legal Person | Physical Person | Business /* required */
      },
      israelAdditionalInfo: {
        customerType: Business | Individual, /* required */
        dealerType: Authorized | Non-authorized /* required */
      },
      italyAdditionalInfo: {
        cigNumber: 'STRING_VALUE',
        cupNumber: 'STRING_VALUE',
        sdiAccountId: 'STRING_VALUE',
        taxCode: 'STRING_VALUE'
      },
      kenyaAdditionalInfo: {
        personType: Legal Person | Physical Person | Business /* required */
      },
      malaysiaAdditionalInfo: {
        serviceTaxCodes: [ /* required */
          Consultancy | Digital Service And Electronic Medium | IT Services | Training Or Coaching,
          /* more items */
        ]
      },
      polandAdditionalInfo: {
        individualRegistrationNumber: 'STRING_VALUE',
        isGroupVatEnabled: true || false
      },
      romaniaAdditionalInfo: {
        taxRegistrationNumberType: TaxRegistrationNumber | LocalRegistrationNumber /* required */
      },
      saudiArabiaAdditionalInfo: {
        taxRegistrationNumberType: TaxRegistrationNumber | TaxIdentificationNumber | CommercialRegistrationNumber
      },
      southKoreaAdditionalInfo: {
        businessRepresentativeName: 'STRING_VALUE', /* required */
        itemOfBusiness: 'STRING_VALUE', /* required */
        lineOfBusiness: 'STRING_VALUE' /* required */
      },
      spainAdditionalInfo: {
        registrationType: Intra-EU | Local /* required */
      },
      turkeyAdditionalInfo: {
        industries: CirculatingOrg | ProfessionalOrg | Banks | Insurance | PensionAndBenefitFunds | DevelopmentAgencies,
        kepEmailId: 'STRING_VALUE',
        secondaryTaxId: 'STRING_VALUE',
        taxOffice: 'STRING_VALUE'
      },
      ukraineAdditionalInfo: {
        ukraineTrnType: Business | Individual /* required */
      }
    },
    certifiedEmailId: 'STRING_VALUE',
    legalAddress: {
      addressLine1: 'STRING_VALUE', /* required */
      city: 'STRING_VALUE', /* required */
      countryCode: 'STRING_VALUE', /* required */
      postalCode: 'STRING_VALUE', /* required */
      addressLine2: 'STRING_VALUE',
      addressLine3: 'STRING_VALUE',
      districtOrCounty: 'STRING_VALUE',
      stateOrRegion: 'STRING_VALUE'
    },
    legalName: 'STRING_VALUE',
    sector: Business | Individual | Government,
    verificationDetails: {
      dateOfBirth: 'STRING_VALUE',
      taxRegistrationDocuments: [
        {
          s3Location: { /* required */
            bucket: 'STRING_VALUE', /* required */
            key: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ]
    }
  }
};
taxsettings.batchPutTaxRegistration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      List of unique account identifiers.

    • taxRegistrationEntry — (map)

      Your TRN information that will be stored to the accounts mentioned in putEntries.

      • additionalTaxInformation — (map)

        Additional tax information associated with your TRN. You only need to specify this parameter if Amazon Web Services collects any additional information for your country within AdditionalInfoRequest.

        • canadaAdditionalInfo — (map)

          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 — (map)

          Additional tax information to specify for a TRN in Estonia.

          • registryCommercialCoderequired — (String)

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

        • georgiaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Georgia.

          • personTyperequired — (String)

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

            Possible values include:
            • "Legal Person"
            • "Physical Person"
            • "Business"
        • israelAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Israel.

          • customerTyperequired — (String)

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

            Possible values include:
            • "Business"
            • "Individual"
          • dealerTyperequired — (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.

            Possible values include:
            • "Authorized"
            • "Non-authorized"
        • italyAdditionalInfo — (map)

          Additional tax information to specify for a 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 — (map)

          Additional tax information to specify for a TRN in Kenya.

          • personTyperequired — (String)

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

            Possible values include:
            • "Legal Person"
            • "Physical Person"
            • "Business"
        • malaysiaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Malaysia.

          • serviceTaxCodesrequired — (Array<String>)

            List of service tax codes for your TRN in Malaysia.

        • polandAdditionalInfo — (map)

          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 — (map)

          Additional tax information to specify for a TRN in Romania.

          • taxRegistrationNumberTyperequired — (String)

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

            Possible values include:
            • "TaxRegistrationNumber"
            • "LocalRegistrationNumber"
        • saudiArabiaAdditionalInfo — (map)

          Additional tax information associated with your TRN in Saudi Arabia.

          • taxRegistrationNumberType — (String)

            The tax registration number type.

            Possible values include:
            • "TaxRegistrationNumber"
            • "TaxIdentificationNumber"
            • "CommercialRegistrationNumber"
        • southKoreaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in South Korea.

          • businessRepresentativeNamerequired — (String)

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

          • itemOfBusinessrequired — (String)

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

          • lineOfBusinessrequired — (String)

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

        • spainAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Spain.

          • registrationTyperequired — (String)

            The registration type in Spain.

            Possible values include:
            • "Intra-EU"
            • "Local"
        • turkeyAdditionalInfo — (map)

          Additional tax information to specify for a 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.

            Possible values include:
            • "CirculatingOrg"
            • "ProfessionalOrg"
            • "Banks"
            • "Insurance"
            • "PensionAndBenefitFunds"
            • "DevelopmentAgencies"
          • 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 — (map)

          Additional tax information associated with your TRN in Ukraine.

          • ukraineTrnTyperequired — (String)

            The tax registration type.

            Possible values include:
            • "Business"
            • "Individual"
      • certifiedEmailId — (String)

        The email address to receive VAT invoices.

      • legalAddress — (map)

        The legal address associated with your TRN.

        Note: If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the legal address. For TRNs in other countries and for CPF tax types Brazil, you must specify the legal address.
        • addressLine1required — (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.

        • cityrequired — (String)

          The city that the address is in.

        • countryCoderequired — (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.
        • postalCoderequired — (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.

      • legalName — (String)

        The legal name associated with your TRN.

        Note: If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in other countries, you must specify the legal name.
      • registrationIdrequired — (String)

        Your tax registration unique identifier.

      • registrationTyperequired — (String)

        Your tax registration type. This can be either VAT or GST.

        Possible values include:
        • "VAT"
        • "GST"
        • "CPF"
        • "CNPJ"
        • "SST"
      • 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.

        Possible values include:
        • "Business"
        • "Individual"
        • "Government"
      • verificationDetails — (map)

        Additional details needed to verify your TRN information in Brazil. You only need to specify this parameter when you set a TRN in Brazil that is the CPF tax type.

        Note: Don't specify this parameter to set a TRN in Brazil of the CNPJ tax type or to set a TRN for another country.
        • dateOfBirth — (String)

          Date of birth to verify your submitted TRN. Use the YYYY-MM-DD format.

        • taxRegistrationDocuments — (Array<map>)

          The tax registration document, which is required for specific countries such as Bangladesh, Kenya, South Korea and Spain.

          • s3Locationrequired — (map)

            The Amazon S3 location where your tax registration document is stored.

            • bucketrequired — (String)

              The name of your Amazon S3 bucket that your tax document is located.

            • keyrequired — (String)

              The object key of your tax document object in Amazon S3.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • errors — (Array<map>)

        List of errors for the accounts the TRN information could not be added or updated to.

        • accountIdrequired — (String)

          The unique account identifier for the account that the tax registration couldn't be added, or updated during the BatchPutTaxRegistration operation.

        • code — (String)

          The error code for an individual failure in the BatchPutTaxRegistration operation.

        • messagerequired — (String)

          The error message for an individual failure in the BatchPutTaxRegistration operation.

      • status — (String)

        The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending or Rejected.

        Possible values include:
        • "Verified"
        • "Pending"
        • "Deleted"
        • "Rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTaxRegistration(params = {}, callback) ⇒ AWS.Request

Deletes tax registration for a single account.

Note: 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.

Service Reference:

Examples:

Calling the deleteTaxRegistration operation

var params = {
  accountId: 'STRING_VALUE'
};
taxsettings.deleteTaxRegistration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      Unique account identifier for the TRN information that needs to be deleted. If this isn't passed, the account ID corresponding to the credentials of the API caller will be used for this parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTaxRegistration(params = {}, callback) ⇒ AWS.Request

Retrieves tax registration for a single account.

Service Reference:

Examples:

Calling the getTaxRegistration operation

var params = {
  accountId: 'STRING_VALUE'
};
taxsettings.getTaxRegistration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      Your unique account identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • taxRegistration — (map)

        TRN information of the account mentioned in the request.

        • additionalTaxInformation — (map)

          Additional tax information associated with your TRN.

          • brazilAdditionalInfo — (map)

            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 — (map)

            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 — (map)

            Additional tax information associated with your TRN in Estonia.

            • registryCommercialCoderequired — (String)

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

          • georgiaAdditionalInfo — (map)

            Additional tax information associated with your TRN in Georgia.

            • personTyperequired — (String)

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

              Possible values include:
              • "Legal Person"
              • "Physical Person"
              • "Business"
          • indiaAdditionalInfo — (map)

            Additional tax information in India.

            • pan — (String)

              India pan information associated with the account.

          • israelAdditionalInfo — (map)

            Additional tax information associated with your TRN in Israel.

            • customerTyperequired — (String)

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

              Possible values include:
              • "Business"
              • "Individual"
            • dealerTyperequired — (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.

              Possible values include:
              • "Authorized"
              • "Non-authorized"
          • italyAdditionalInfo — (map)

            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 — (map)

            Additional tax information associated with your TRN in Kenya.

            • personTyperequired — (String)

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

              Possible values include:
              • "Legal Person"
              • "Physical Person"
              • "Business"
          • malaysiaAdditionalInfo — (map)

            Additional tax information associated with your TRN in Malaysia.

            • serviceTaxCodesrequired — (Array<String>)

              List of service tax codes for your TRN in Malaysia.

          • polandAdditionalInfo — (map)

            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 — (map)

            Additional tax information to specify for a TRN in Romania.

            • taxRegistrationNumberTyperequired — (String)

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

              Possible values include:
              • "TaxRegistrationNumber"
              • "LocalRegistrationNumber"
          • saudiArabiaAdditionalInfo — (map)

            Additional tax information associated with your TRN in Saudi Arabia.

            • taxRegistrationNumberType — (String)

              The tax registration number type.

              Possible values include:
              • "TaxRegistrationNumber"
              • "TaxIdentificationNumber"
              • "CommercialRegistrationNumber"
          • southKoreaAdditionalInfo — (map)

            Additional tax information associated with your TRN in South Korea.

            • businessRepresentativeNamerequired — (String)

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

            • itemOfBusinessrequired — (String)

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

            • lineOfBusinessrequired — (String)

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

          • spainAdditionalInfo — (map)

            Additional tax information associated with your TRN in Spain.

            • registrationTyperequired — (String)

              The registration type in Spain.

              Possible values include:
              • "Intra-EU"
              • "Local"
          • turkeyAdditionalInfo — (map)

            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.

              Possible values include:
              • "CirculatingOrg"
              • "ProfessionalOrg"
              • "Banks"
              • "Insurance"
              • "PensionAndBenefitFunds"
              • "DevelopmentAgencies"
            • 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 — (map)

            Additional tax information associated with your TRN in Ukraine.

            • ukraineTrnTyperequired — (String)

              The tax registration type.

              Possible values include:
              • "Business"
              • "Individual"
        • certifiedEmailId — (String)

          The email address to receive VAT invoices.

        • legalAddressrequired — (map)

          The legal address associated with your TRN registration.

          • addressLine1required — (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.

          • cityrequired — (String)

            The city that the address is in.

          • countryCoderequired — (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.
          • postalCoderequired — (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.

        • legalNamerequired — (String)

          The legal name associated with your TRN registration.

        • registrationIdrequired — (String)

          Your tax registration unique identifier.

        • registrationTyperequired — (String)

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

          Possible values include:
          • "VAT"
          • "GST"
          • "CPF"
          • "CNPJ"
          • "SST"
        • 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.

          Possible values include:
          • "Business"
          • "Individual"
          • "Government"
        • statusrequired — (String)

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

          Possible values include:
          • "Verified"
          • "Pending"
          • "Deleted"
          • "Rejected"
        • taxDocumentMetadatas — (Array<map>)

          The metadata for your tax document.

          • taxDocumentAccessTokenrequired — (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.
          • taxDocumentNamerequired — (String)

            The name of your tax document.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTaxRegistrationDocument(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getTaxRegistrationDocument operation

var params = {
  destinationS3Location: { /* required */
    bucket: 'STRING_VALUE', /* required */
    prefix: 'STRING_VALUE'
  },
  taxDocumentMetadata: { /* required */
    taxDocumentAccessToken: 'STRING_VALUE', /* required */
    taxDocumentName: 'STRING_VALUE' /* required */
  }
};
taxsettings.getTaxRegistrationDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • destinationS3Location — (map)

      The Amazon S3 bucket that you specify to download your tax documents to.

      • bucketrequired — (String)

        The name of your Amazon S3 bucket that you specify to download your tax documents to.

      • prefix — (String)

        The Amazon S3 object prefix that you specify for your tax document file.

    • taxDocumentMetadata — (map)

      The metadata for your tax document.

      • taxDocumentAccessTokenrequired — (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.
      • taxDocumentNamerequired — (String)

        The name of your tax document.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • destinationFilePath — (String)

        The file path of the Amazon S3 bucket where you want to download your tax document to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTaxRegistrations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTaxRegistrations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
taxsettings.listTaxRegistrations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Number of accountDetails results you want in one response.

    • nextToken — (String)

      The token to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountDetails — (Array<map>)

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

        • accountId — (String)

          List of unique account identifiers.

        • accountMetaData — (map)

          The meta data information associated with the account.

          • accountName — (String)

            The Amazon Web Services accounts name.

          • address — (map)

            The details of the address associated with the TRN information.

            • addressLine1required — (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.

            • cityrequired — (String)

              The city that the address is in.

            • countryCoderequired — (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.
            • postalCoderequired — (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 — (map<map>)

            Address roles associated with the account containing country code information.

            • countryCoderequired — (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.

            Possible values include:
            • "TaxAddress"
            • "BillingAddress"
            • "ContactAddress"
          • seller — (String)

            Seller information associated with the account.

        • taxInheritanceDetails — (map)

          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 — (map)

          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 — (map)

            Additional tax information associated with your TRN.

            • brazilAdditionalInfo — (map)

              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 — (map)

              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 — (map)

              Additional tax information associated with your TRN in Estonia.

              • registryCommercialCoderequired — (String)

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

            • georgiaAdditionalInfo — (map)

              Additional tax information associated with your TRN in Georgia.

              • personTyperequired — (String)

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

                Possible values include:
                • "Legal Person"
                • "Physical Person"
                • "Business"
            • indiaAdditionalInfo — (map)

              Additional tax information in India.

              • pan — (String)

                India pan information associated with the account.

            • israelAdditionalInfo — (map)

              Additional tax information associated with your TRN in Israel.

              • customerTyperequired — (String)

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

                Possible values include:
                • "Business"
                • "Individual"
              • dealerTyperequired — (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.

                Possible values include:
                • "Authorized"
                • "Non-authorized"
            • italyAdditionalInfo — (map)

              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 — (map)

              Additional tax information associated with your TRN in Kenya.

              • personTyperequired — (String)

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

                Possible values include:
                • "Legal Person"
                • "Physical Person"
                • "Business"
            • malaysiaAdditionalInfo — (map)

              Additional tax information associated with your TRN in Malaysia.

              • serviceTaxCodesrequired — (Array<String>)

                List of service tax codes for your TRN in Malaysia.

            • polandAdditionalInfo — (map)

              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 — (map)

              Additional tax information to specify for a TRN in Romania.

              • taxRegistrationNumberTyperequired — (String)

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

                Possible values include:
                • "TaxRegistrationNumber"
                • "LocalRegistrationNumber"
            • saudiArabiaAdditionalInfo — (map)

              Additional tax information associated with your TRN in Saudi Arabia.

              • taxRegistrationNumberType — (String)

                The tax registration number type.

                Possible values include:
                • "TaxRegistrationNumber"
                • "TaxIdentificationNumber"
                • "CommercialRegistrationNumber"
            • southKoreaAdditionalInfo — (map)

              Additional tax information associated with your TRN in South Korea.

              • businessRepresentativeNamerequired — (String)

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

              • itemOfBusinessrequired — (String)

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

              • lineOfBusinessrequired — (String)

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

            • spainAdditionalInfo — (map)

              Additional tax information associated with your TRN in Spain.

              • registrationTyperequired — (String)

                The registration type in Spain.

                Possible values include:
                • "Intra-EU"
                • "Local"
            • turkeyAdditionalInfo — (map)

              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.

                Possible values include:
                • "CirculatingOrg"
                • "ProfessionalOrg"
                • "Banks"
                • "Insurance"
                • "PensionAndBenefitFunds"
                • "DevelopmentAgencies"
              • 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 — (map)

              Additional tax information associated with your TRN in Ukraine.

              • ukraineTrnTyperequired — (String)

                The tax registration type.

                Possible values include:
                • "Business"
                • "Individual"
          • certifiedEmailId — (String)

            The email address to receive VAT invoices.

          • jurisdictionrequired — (map)

            The jurisdiction associated with your TRN information.

            • countryCoderequired — (String)

              The country code of the jurisdiction.

            • stateOrRegion — (String)

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

          • legalNamerequired — (String)

            The legal name associated with your TRN information.

          • registrationIdrequired — (String)

            Your tax registration unique identifier.

          • registrationTyperequired — (String)

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

            Possible values include:
            • "VAT"
            • "GST"
            • "CPF"
            • "CNPJ"
            • "SST"
          • 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.

            Possible values include:
            • "Business"
            • "Individual"
            • "Government"
          • statusrequired — (String)

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

            Possible values include:
            • "Verified"
            • "Pending"
            • "Deleted"
            • "Rejected"
          • taxDocumentMetadatas — (Array<map>)

            The metadata for your tax document.

            • taxDocumentAccessTokenrequired — (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.
            • taxDocumentNamerequired — (String)

              The name of your tax document.

      • nextToken — (String)

        The token to retrieve the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putTaxRegistration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putTaxRegistration operation

var params = {
  taxRegistrationEntry: { /* required */
    registrationId: 'STRING_VALUE', /* required */
    registrationType: VAT | GST | CPF | CNPJ | SST, /* required */
    additionalTaxInformation: {
      canadaAdditionalInfo: {
        canadaQuebecSalesTaxNumber: 'STRING_VALUE',
        canadaRetailSalesTaxNumber: 'STRING_VALUE',
        isResellerAccount: true || false,
        provincialSalesTaxId: 'STRING_VALUE'
      },
      estoniaAdditionalInfo: {
        registryCommercialCode: 'STRING_VALUE' /* required */
      },
      georgiaAdditionalInfo: {
        personType: Legal Person | Physical Person | Business /* required */
      },
      israelAdditionalInfo: {
        customerType: Business | Individual, /* required */
        dealerType: Authorized | Non-authorized /* required */
      },
      italyAdditionalInfo: {
        cigNumber: 'STRING_VALUE',
        cupNumber: 'STRING_VALUE',
        sdiAccountId: 'STRING_VALUE',
        taxCode: 'STRING_VALUE'
      },
      kenyaAdditionalInfo: {
        personType: Legal Person | Physical Person | Business /* required */
      },
      malaysiaAdditionalInfo: {
        serviceTaxCodes: [ /* required */
          Consultancy | Digital Service And Electronic Medium | IT Services | Training Or Coaching,
          /* more items */
        ]
      },
      polandAdditionalInfo: {
        individualRegistrationNumber: 'STRING_VALUE',
        isGroupVatEnabled: true || false
      },
      romaniaAdditionalInfo: {
        taxRegistrationNumberType: TaxRegistrationNumber | LocalRegistrationNumber /* required */
      },
      saudiArabiaAdditionalInfo: {
        taxRegistrationNumberType: TaxRegistrationNumber | TaxIdentificationNumber | CommercialRegistrationNumber
      },
      southKoreaAdditionalInfo: {
        businessRepresentativeName: 'STRING_VALUE', /* required */
        itemOfBusiness: 'STRING_VALUE', /* required */
        lineOfBusiness: 'STRING_VALUE' /* required */
      },
      spainAdditionalInfo: {
        registrationType: Intra-EU | Local /* required */
      },
      turkeyAdditionalInfo: {
        industries: CirculatingOrg | ProfessionalOrg | Banks | Insurance | PensionAndBenefitFunds | DevelopmentAgencies,
        kepEmailId: 'STRING_VALUE',
        secondaryTaxId: 'STRING_VALUE',
        taxOffice: 'STRING_VALUE'
      },
      ukraineAdditionalInfo: {
        ukraineTrnType: Business | Individual /* required */
      }
    },
    certifiedEmailId: 'STRING_VALUE',
    legalAddress: {
      addressLine1: 'STRING_VALUE', /* required */
      city: 'STRING_VALUE', /* required */
      countryCode: 'STRING_VALUE', /* required */
      postalCode: 'STRING_VALUE', /* required */
      addressLine2: 'STRING_VALUE',
      addressLine3: 'STRING_VALUE',
      districtOrCounty: 'STRING_VALUE',
      stateOrRegion: 'STRING_VALUE'
    },
    legalName: 'STRING_VALUE',
    sector: Business | Individual | Government,
    verificationDetails: {
      dateOfBirth: 'STRING_VALUE',
      taxRegistrationDocuments: [
        {
          s3Location: { /* required */
            bucket: 'STRING_VALUE', /* required */
            key: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ]
    }
  },
  accountId: 'STRING_VALUE'
};
taxsettings.putTaxRegistration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      Your unique account identifier.

    • taxRegistrationEntry — (map)

      Your TRN information that will be stored to the account mentioned in accountId.

      • additionalTaxInformation — (map)

        Additional tax information associated with your TRN. You only need to specify this parameter if Amazon Web Services collects any additional information for your country within AdditionalInfoRequest.

        • canadaAdditionalInfo — (map)

          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 — (map)

          Additional tax information to specify for a TRN in Estonia.

          • registryCommercialCoderequired — (String)

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

        • georgiaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Georgia.

          • personTyperequired — (String)

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

            Possible values include:
            • "Legal Person"
            • "Physical Person"
            • "Business"
        • israelAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Israel.

          • customerTyperequired — (String)

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

            Possible values include:
            • "Business"
            • "Individual"
          • dealerTyperequired — (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.

            Possible values include:
            • "Authorized"
            • "Non-authorized"
        • italyAdditionalInfo — (map)

          Additional tax information to specify for a 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 — (map)

          Additional tax information to specify for a TRN in Kenya.

          • personTyperequired — (String)

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

            Possible values include:
            • "Legal Person"
            • "Physical Person"
            • "Business"
        • malaysiaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Malaysia.

          • serviceTaxCodesrequired — (Array<String>)

            List of service tax codes for your TRN in Malaysia.

        • polandAdditionalInfo — (map)

          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 — (map)

          Additional tax information to specify for a TRN in Romania.

          • taxRegistrationNumberTyperequired — (String)

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

            Possible values include:
            • "TaxRegistrationNumber"
            • "LocalRegistrationNumber"
        • saudiArabiaAdditionalInfo — (map)

          Additional tax information associated with your TRN in Saudi Arabia.

          • taxRegistrationNumberType — (String)

            The tax registration number type.

            Possible values include:
            • "TaxRegistrationNumber"
            • "TaxIdentificationNumber"
            • "CommercialRegistrationNumber"
        • southKoreaAdditionalInfo — (map)

          Additional tax information to specify for a TRN in South Korea.

          • businessRepresentativeNamerequired — (String)

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

          • itemOfBusinessrequired — (String)

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

          • lineOfBusinessrequired — (String)

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

        • spainAdditionalInfo — (map)

          Additional tax information to specify for a TRN in Spain.

          • registrationTyperequired — (String)

            The registration type in Spain.

            Possible values include:
            • "Intra-EU"
            • "Local"
        • turkeyAdditionalInfo — (map)

          Additional tax information to specify for a 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.

            Possible values include:
            • "CirculatingOrg"
            • "ProfessionalOrg"
            • "Banks"
            • "Insurance"
            • "PensionAndBenefitFunds"
            • "DevelopmentAgencies"
          • 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 — (map)

          Additional tax information associated with your TRN in Ukraine.

          • ukraineTrnTyperequired — (String)

            The tax registration type.

            Possible values include:
            • "Business"
            • "Individual"
      • certifiedEmailId — (String)

        The email address to receive VAT invoices.

      • legalAddress — (map)

        The legal address associated with your TRN.

        Note: If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the legal address. For TRNs in other countries and for CPF tax types Brazil, you must specify the legal address.
        • addressLine1required — (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.

        • cityrequired — (String)

          The city that the address is in.

        • countryCoderequired — (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.
        • postalCoderequired — (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.

      • legalName — (String)

        The legal name associated with your TRN.

        Note: If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in other countries, you must specify the legal name.
      • registrationIdrequired — (String)

        Your tax registration unique identifier.

      • registrationTyperequired — (String)

        Your tax registration type. This can be either VAT or GST.

        Possible values include:
        • "VAT"
        • "GST"
        • "CPF"
        • "CNPJ"
        • "SST"
      • 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.

        Possible values include:
        • "Business"
        • "Individual"
        • "Government"
      • verificationDetails — (map)

        Additional details needed to verify your TRN information in Brazil. You only need to specify this parameter when you set a TRN in Brazil that is the CPF tax type.

        Note: Don't specify this parameter to set a TRN in Brazil of the CNPJ tax type or to set a TRN for another country.
        • dateOfBirth — (String)

          Date of birth to verify your submitted TRN. Use the YYYY-MM-DD format.

        • taxRegistrationDocuments — (Array<map>)

          The tax registration document, which is required for specific countries such as Bangladesh, Kenya, South Korea and Spain.

          • s3Locationrequired — (map)

            The Amazon S3 location where your tax registration document is stored.

            • bucketrequired — (String)

              The name of your Amazon S3 bucket that your tax document is located.

            • keyrequired — (String)

              The object key of your tax document object in Amazon S3.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending or Rejected.

        Possible values include:
        • "Verified"
        • "Pending"
        • "Deleted"
        • "Rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.