taxsettings

package module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 42 Imported by: 3

Documentation

Overview

Package taxsettings provides the API client, operations, and parameter types for Tax Settings.

You can use the tax setting API to programmatically set, modify, and delete the tax registration number (TRN), associated business legal name, and address (Collectively referred to as "TRN information"). You can also programmatically view TRN information and tax addresses ("Tax profiles").

You can use this API to automate your TRN information settings instead of manually using the console.

Service Endpoint

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "TaxSettings"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDeleteTaxRegistrationInput 

type BatchDeleteTaxRegistrationInput struct {

	// List of unique account identifiers.
	//
	// This member is required.
	AccountIds []string
	// contains filtered or unexported fields
}

type BatchDeleteTaxRegistrationOutput 

type BatchDeleteTaxRegistrationOutput struct {

	// The list of errors for the accounts the TRN information could not be deleted
	// for.
	//
	// This member is required.
	Errors []types.BatchDeleteTaxRegistrationError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetTaxExemptionsInput added in v1.7.0 

type BatchGetTaxExemptionsInput struct {

	//  List of unique account identifiers.
	//
	// This member is required.
	AccountIds []string
	// contains filtered or unexported fields
}

type BatchGetTaxExemptionsOutput added in v1.7.0 

type BatchGetTaxExemptionsOutput struct {

	// The list of accounts that failed to get tax exemptions.
	FailedAccounts []string

	// The tax exemption details map of accountId and tax exemption details.
	TaxExemptionDetailsMap map[string]types.TaxExemptionDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchPutTaxRegistrationInput 

type BatchPutTaxRegistrationInput struct {

	//  List of unique account identifiers.
	//
	// This member is required.
	AccountIds []string

	// Your TRN information that will be stored to the accounts mentioned in putEntries
	// .
	//
	// This member is required.
	TaxRegistrationEntry *types.TaxRegistrationEntry
	// contains filtered or unexported fields
}

type BatchPutTaxRegistrationOutput 

type BatchPutTaxRegistrationOutput struct {

	// List of errors for the accounts the TRN information could not be added or
	// updated to.
	//
	// This member is required.
	Errors []types.BatchPutTaxRegistrationError

	// 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 .
	Status types.TaxRegistrationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Tax Settings.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDeleteTaxRegistration 

func (c *Client) BatchDeleteTaxRegistration(ctx context.Context, params *BatchDeleteTaxRegistrationInput, optFns ...func(*Options)) (*BatchDeleteTaxRegistrationOutput, error)

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 preferencespage in the Billing and Cost Management console instead.

func (*Client) BatchGetTaxExemptions added in v1.7.0 

func (c *Client) BatchGetTaxExemptions(ctx context.Context, params *BatchGetTaxExemptionsInput, optFns ...func(*Options)) (*BatchGetTaxExemptionsOutput, error)

Get the active tax exemptions for a given list of accounts.

func (*Client) BatchPutTaxRegistration 

func (c *Client) BatchPutTaxRegistration(ctx context.Context, params *BatchPutTaxRegistrationInput, optFns ...func(*Options)) (*BatchPutTaxRegistrationOutput, error)

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 preferencespage 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

  • The sector valid values are Business and Individual .

  • RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

  • For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

  • For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

  • For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

  • For business resellers with service codes, you must specify businessRegistrationNumber , taxInformationNumber , and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.

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

func (*Client) DeleteSupplementalTaxRegistration added in v1.6.0 

func (c *Client) DeleteSupplementalTaxRegistration(ctx context.Context, params *DeleteSupplementalTaxRegistrationInput, optFns ...func(*Options)) (*DeleteSupplementalTaxRegistrationOutput, error)

Deletes a supplemental tax registration for a single account.

func (*Client) DeleteTaxRegistration 

func (c *Client) DeleteTaxRegistration(ctx context.Context, params *DeleteTaxRegistrationInput, optFns ...func(*Options)) (*DeleteTaxRegistrationOutput, error)

Deletes tax registration for a single account.

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

func (*Client) GetTaxExemptionTypes added in v1.7.0 

func (c *Client) GetTaxExemptionTypes(ctx context.Context, params *GetTaxExemptionTypesInput, optFns ...func(*Options)) (*GetTaxExemptionTypesOutput, error)

Get supported tax exemption types.

func (*Client) GetTaxInheritance added in v1.7.0 

func (c *Client) GetTaxInheritance(ctx context.Context, params *GetTaxInheritanceInput, optFns ...func(*Options)) (*GetTaxInheritanceOutput, error)

The get account tax inheritance status.

func (*Client) GetTaxRegistration 

func (c *Client) GetTaxRegistration(ctx context.Context, params *GetTaxRegistrationInput, optFns ...func(*Options)) (*GetTaxRegistrationOutput, error)

Retrieves tax registration for a single account.

func (*Client) GetTaxRegistrationDocument 

func (c *Client) GetTaxRegistrationDocument(ctx context.Context, params *GetTaxRegistrationDocumentInput, optFns ...func(*Options)) (*GetTaxRegistrationDocumentOutput, error)

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

func (*Client) ListSupplementalTaxRegistrations added in v1.6.0 

func (c *Client) ListSupplementalTaxRegistrations(ctx context.Context, params *ListSupplementalTaxRegistrationsInput, optFns ...func(*Options)) (*ListSupplementalTaxRegistrationsOutput, error)

Retrieves supplemental tax registrations for a single account.

func (*Client) ListTaxExemptions added in v1.7.0 

func (c *Client) ListTaxExemptions(ctx context.Context, params *ListTaxExemptionsInput, optFns ...func(*Options)) (*ListTaxExemptionsOutput, error)

Retrieves the tax exemption of accounts listed in a consolidated billing family.

func (*Client) ListTaxRegistrations 

func (c *Client) ListTaxRegistrations(ctx context.Context, params *ListTaxRegistrationsInput, optFns ...func(*Options)) (*ListTaxRegistrationsOutput, error)

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

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutSupplementalTaxRegistration added in v1.6.0 

func (c *Client) PutSupplementalTaxRegistration(ctx context.Context, params *PutSupplementalTaxRegistrationInput, optFns ...func(*Options)) (*PutSupplementalTaxRegistrationOutput, error)

Stores supplemental tax registration for a single account.

func (*Client) PutTaxExemption added in v1.7.0 

func (c *Client) PutTaxExemption(ctx context.Context, params *PutTaxExemptionInput, optFns ...func(*Options)) (*PutTaxExemptionOutput, error)

Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.

func (*Client) PutTaxInheritance added in v1.7.0 

func (c *Client) PutTaxInheritance(ctx context.Context, params *PutTaxInheritanceInput, optFns ...func(*Options)) (*PutTaxInheritanceOutput, error)

The updated tax inheritance status.

func (*Client) PutTaxRegistration 

func (c *Client) PutTaxRegistration(ctx context.Context, params *PutTaxRegistrationInput, optFns ...func(*Options)) (*PutTaxRegistrationOutput, error)

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 preferencespage 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

  • The sector valid values are Business and Individual .

  • RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

  • For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

  • For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

  • For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

  • For business resellers with service codes, you must specify businessRegistrationNumber , taxInformationNumber , and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.

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

type DeleteSupplementalTaxRegistrationInput added in v1.6.0 

type DeleteSupplementalTaxRegistrationInput struct {

	//  The unique authority Id for the supplemental TRN information that needs to be
	// deleted.
	//
	// This member is required.
	AuthorityId *string
	// contains filtered or unexported fields
}

type DeleteSupplementalTaxRegistrationOutput added in v1.6.0 

type DeleteSupplementalTaxRegistrationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTaxRegistrationInput 

type DeleteTaxRegistrationInput struct {

	// 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.
	AccountId *string
	// contains filtered or unexported fields
}

type DeleteTaxRegistrationOutput 

type DeleteTaxRegistrationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetTaxExemptionTypesInput added in v1.7.0 

type GetTaxExemptionTypesInput struct {
	// contains filtered or unexported fields
}

type GetTaxExemptionTypesOutput added in v1.7.0 

type GetTaxExemptionTypesOutput struct {

	// The supported types of tax exemptions.
	TaxExemptionTypes []types.TaxExemptionType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTaxInheritanceInput added in v1.7.0 

type GetTaxInheritanceInput struct {
	// contains filtered or unexported fields
}

type GetTaxInheritanceOutput added in v1.7.0 

type GetTaxInheritanceOutput struct {

	// The tax inheritance status.
	HeritageStatus types.HeritageStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTaxRegistrationDocumentInput 

type GetTaxRegistrationDocumentInput struct {

	// The metadata for your tax document.
	//
	// This member is required.
	TaxDocumentMetadata *types.TaxDocumentMetadata

	// The Amazon S3 bucket that you specify to download your tax documents to.
	DestinationS3Location *types.DestinationS3Location
	// contains filtered or unexported fields
}

type GetTaxRegistrationDocumentOutput 

type GetTaxRegistrationDocumentOutput struct {

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

	// The Amazon S3 presigned URL of the tax registration document.
	PresignedS3Url *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTaxRegistrationInput 

type GetTaxRegistrationInput struct {

	// Your unique account identifier.
	AccountId *string
	// contains filtered or unexported fields
}

type GetTaxRegistrationOutput 

type GetTaxRegistrationOutput struct {

	// TRN information of the account mentioned in the request.
	TaxRegistration *types.TaxRegistration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListSupplementalTaxRegistrationsAPIClient added in v1.6.0 

type ListSupplementalTaxRegistrationsAPIClient interface {
	ListSupplementalTaxRegistrations(context.Context, *ListSupplementalTaxRegistrationsInput, ...func(*Options)) (*ListSupplementalTaxRegistrationsOutput, error)
}

ListSupplementalTaxRegistrationsAPIClient is a client that implements the ListSupplementalTaxRegistrations operation.

type ListSupplementalTaxRegistrationsInput added in v1.6.0 

type ListSupplementalTaxRegistrationsInput struct {

	//  The number of taxRegistrations results you want in one response.
	MaxResults *int32

	//  The token to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSupplementalTaxRegistrationsOutput added in v1.6.0 

type ListSupplementalTaxRegistrationsOutput struct {

	//  The list of supplemental tax registrations.
	//
	// This member is required.
	TaxRegistrations []types.SupplementalTaxRegistration

	//  The token to retrieve the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSupplementalTaxRegistrationsPaginator added in v1.6.0 

type ListSupplementalTaxRegistrationsPaginator struct {
	// contains filtered or unexported fields
}

ListSupplementalTaxRegistrationsPaginator is a paginator for ListSupplementalTaxRegistrations

func NewListSupplementalTaxRegistrationsPaginator added in v1.6.0 

func NewListSupplementalTaxRegistrationsPaginator(client ListSupplementalTaxRegistrationsAPIClient, params *ListSupplementalTaxRegistrationsInput, optFns ...func(*ListSupplementalTaxRegistrationsPaginatorOptions)) *ListSupplementalTaxRegistrationsPaginator

NewListSupplementalTaxRegistrationsPaginator returns a new ListSupplementalTaxRegistrationsPaginator

func (*ListSupplementalTaxRegistrationsPaginator) HasMorePages added in v1.6.0 

func (p *ListSupplementalTaxRegistrationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSupplementalTaxRegistrationsPaginator) NextPage added in v1.6.0 

func (p *ListSupplementalTaxRegistrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSupplementalTaxRegistrationsOutput, error)

NextPage retrieves the next ListSupplementalTaxRegistrations page.

type ListSupplementalTaxRegistrationsPaginatorOptions added in v1.6.0 

type ListSupplementalTaxRegistrationsPaginatorOptions struct {
	//  The number of taxRegistrations results you want in one response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSupplementalTaxRegistrationsPaginatorOptions is the paginator options for ListSupplementalTaxRegistrations

type ListTaxExemptionsAPIClient added in v1.7.0 

type ListTaxExemptionsAPIClient interface {
	ListTaxExemptions(context.Context, *ListTaxExemptionsInput, ...func(*Options)) (*ListTaxExemptionsOutput, error)
}

ListTaxExemptionsAPIClient is a client that implements the ListTaxExemptions operation.

type ListTaxExemptionsInput added in v1.7.0 

type ListTaxExemptionsInput struct {

	// The number of results you want in one response.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTaxExemptionsOutput added in v1.7.0 

type ListTaxExemptionsOutput struct {

	// The token to retrieve the next set of results.
	NextToken *string

	// The tax exemption details map of accountId and tax exemption details.
	TaxExemptionDetailsMap map[string]types.TaxExemptionDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTaxExemptionsPaginator added in v1.7.0 

type ListTaxExemptionsPaginator struct {
	// contains filtered or unexported fields
}

ListTaxExemptionsPaginator is a paginator for ListTaxExemptions

func NewListTaxExemptionsPaginator added in v1.7.0 

func NewListTaxExemptionsPaginator(client ListTaxExemptionsAPIClient, params *ListTaxExemptionsInput, optFns ...func(*ListTaxExemptionsPaginatorOptions)) *ListTaxExemptionsPaginator

NewListTaxExemptionsPaginator returns a new ListTaxExemptionsPaginator

func (*ListTaxExemptionsPaginator) HasMorePages added in v1.7.0 

func (p *ListTaxExemptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTaxExemptionsPaginator) NextPage added in v1.7.0 

func (p *ListTaxExemptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTaxExemptionsOutput, error)

NextPage retrieves the next ListTaxExemptions page.

type ListTaxExemptionsPaginatorOptions added in v1.7.0 

type ListTaxExemptionsPaginatorOptions struct {
	// The number of results you want in one response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTaxExemptionsPaginatorOptions is the paginator options for ListTaxExemptions

type ListTaxRegistrationsAPIClient 

type ListTaxRegistrationsAPIClient interface {
	ListTaxRegistrations(context.Context, *ListTaxRegistrationsInput, ...func(*Options)) (*ListTaxRegistrationsOutput, error)
}

ListTaxRegistrationsAPIClient is a client that implements the ListTaxRegistrations operation.

type ListTaxRegistrationsInput 

type ListTaxRegistrationsInput struct {

	// Number of accountDetails results you want in one response.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTaxRegistrationsOutput 

type ListTaxRegistrationsOutput struct {

	// The list of account details. This contains account Ids and TRN Information for
	// each of the linked accounts.
	//
	// This member is required.
	AccountDetails []types.AccountDetails

	//  The token to retrieve the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTaxRegistrationsPaginator 

type ListTaxRegistrationsPaginator struct {
	// contains filtered or unexported fields
}

ListTaxRegistrationsPaginator is a paginator for ListTaxRegistrations

func NewListTaxRegistrationsPaginator 

func NewListTaxRegistrationsPaginator(client ListTaxRegistrationsAPIClient, params *ListTaxRegistrationsInput, optFns ...func(*ListTaxRegistrationsPaginatorOptions)) *ListTaxRegistrationsPaginator

NewListTaxRegistrationsPaginator returns a new ListTaxRegistrationsPaginator

func (*ListTaxRegistrationsPaginator) HasMorePages 

func (p *ListTaxRegistrationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTaxRegistrationsPaginator) NextPage 

func (p *ListTaxRegistrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTaxRegistrationsOutput, error)

NextPage retrieves the next ListTaxRegistrations page.

type ListTaxRegistrationsPaginatorOptions 

type ListTaxRegistrationsPaginatorOptions struct {
	// Number of accountDetails results you want in one response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTaxRegistrationsPaginatorOptions is the paginator options for ListTaxRegistrations

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutSupplementalTaxRegistrationInput added in v1.6.0 

type PutSupplementalTaxRegistrationInput struct {

	//  The supplemental TRN information that will be stored for the caller account
	// ID.
	//
	// This member is required.
	TaxRegistrationEntry *types.SupplementalTaxRegistrationEntry
	// contains filtered or unexported fields
}

type PutSupplementalTaxRegistrationOutput added in v1.6.0 

type PutSupplementalTaxRegistrationOutput struct {

	//  Unique authority ID for the supplemental TRN information that was stored.
	//
	// This member is required.
	AuthorityId *string

	//  The status of the supplemental TRN stored in the system after processing.
	// Based on the validation occurring on the TRN, the status can be Verified ,
	// Pending , Rejected , or Deleted .
	//
	// This member is required.
	Status types.TaxRegistrationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTaxExemptionInput added in v1.7.0 

type PutTaxExemptionInput struct {

	//  The list of unique account identifiers.
	//
	// This member is required.
	AccountIds []string

	// The address domain associate with the tax information.
	//
	// This member is required.
	Authority *types.Authority

	// The exemption certificate.
	//
	// This member is required.
	ExemptionCertificate *types.ExemptionCertificate

	// The exemption type.
	//
	// This member is required.
	ExemptionType *string
	// contains filtered or unexported fields
}

type PutTaxExemptionOutput added in v1.7.0 

type PutTaxExemptionOutput struct {

	// The customer support case ID.
	CaseId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTaxInheritanceInput added in v1.7.0 

type PutTaxInheritanceInput struct {

	// The tax inheritance status.
	HeritageStatus types.HeritageStatus
	// contains filtered or unexported fields
}

type PutTaxInheritanceOutput added in v1.7.0 

type PutTaxInheritanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTaxRegistrationInput 

type PutTaxRegistrationInput struct {

	//  Your TRN information that will be stored to the account mentioned in accountId
	// .
	//
	// This member is required.
	TaxRegistrationEntry *types.TaxRegistrationEntry

	// Your unique account identifier.
	AccountId *string
	// contains filtered or unexported fields
}

type PutTaxRegistrationOutput 

type PutTaxRegistrationOutput struct {

	// 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 .
	Status types.TaxRegistrationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.