com.amazonaws.services.taxsettings.AWSTaxSettings Maven / Gradle / Ivy
Show all versions of aws-java-sdk-taxsettings Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.taxsettings;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.taxsettings.model.*;
/**
* Interface for accessing Tax Settings.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.taxsettings.AbstractAWSTaxSettings} instead.
*
*
*
* 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
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSTaxSettings {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "tax";
/**
*
* 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.
*
*
*
* @param batchDeleteTaxRegistrationRequest
* @return Result of the BatchDeleteTaxRegistration operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ConflictException
* The exception when the input is creating conflict with the given state.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.BatchDeleteTaxRegistration
* @see AWS API Documentation
*/
BatchDeleteTaxRegistrationResult batchDeleteTaxRegistration(BatchDeleteTaxRegistrationRequest batchDeleteTaxRegistrationRequest);
/**
*
* 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.
*
*
*
*
* @param batchPutTaxRegistrationRequest
* @return Result of the BatchPutTaxRegistration operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ConflictException
* The exception when the input is creating conflict with the given state.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.BatchPutTaxRegistration
* @see AWS API Documentation
*/
BatchPutTaxRegistrationResult batchPutTaxRegistration(BatchPutTaxRegistrationRequest batchPutTaxRegistrationRequest);
/**
*
* 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.
*
*
*
* @param deleteTaxRegistrationRequest
* @return Result of the DeleteTaxRegistration operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ConflictException
* The exception when the input is creating conflict with the given state.
* @throws ResourceNotFoundException
* The exception thrown when the input doesn't have a resource associated to it.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.DeleteTaxRegistration
* @see AWS API Documentation
*/
DeleteTaxRegistrationResult deleteTaxRegistration(DeleteTaxRegistrationRequest deleteTaxRegistrationRequest);
/**
*
* Retrieves tax registration for a single account.
*
*
* @param getTaxRegistrationRequest
* @return Result of the GetTaxRegistration operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ResourceNotFoundException
* The exception thrown when the input doesn't have a resource associated to it.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.GetTaxRegistration
* @see AWS
* API Documentation
*/
GetTaxRegistrationResult getTaxRegistration(GetTaxRegistrationRequest getTaxRegistrationRequest);
/**
*
* Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
*
*
* @param getTaxRegistrationDocumentRequest
* @return Result of the GetTaxRegistrationDocument operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.GetTaxRegistrationDocument
* @see AWS API Documentation
*/
GetTaxRegistrationDocumentResult getTaxRegistrationDocument(GetTaxRegistrationDocumentRequest getTaxRegistrationDocumentRequest);
/**
*
* 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).
*
*
* @param listTaxRegistrationsRequest
* @return Result of the ListTaxRegistrations operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ResourceNotFoundException
* The exception thrown when the input doesn't have a resource associated to it.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.ListTaxRegistrations
* @see AWS API Documentation
*/
ListTaxRegistrationsResult listTaxRegistrations(ListTaxRegistrationsRequest listTaxRegistrationsRequest);
/**
*
* 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.
*
*
*
*
* @param putTaxRegistrationRequest
* @return Result of the PutTaxRegistration operation returned by the service.
* @throws ValidationException
* The exception when the input doesn't pass validation for at least one of the input parameters.
* @throws ConflictException
* The exception when the input is creating conflict with the given state.
* @throws InternalServerException
* The exception thrown when an unexpected error occurs when processing a request.
* @sample AWSTaxSettings.PutTaxRegistration
* @see AWS
* API Documentation
*/
PutTaxRegistrationResult putTaxRegistration(PutTaxRegistrationRequest putTaxRegistrationRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}