Skip to main content

supplemental_tax_registrations

Creates, updates, deletes, gets or lists a supplemental_tax_registrations resource.

Overview

Namesupplemental_tax_registrations
TypeResource
Idaws.taxsettings.supplemental_tax_registrations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
addressobjectThe details of the address associated with the TRN information.
authority_idstringUnique authority ID for the supplemental TRN. (pattern: <code>[\s\S]*</code>)
legal_namestringThe legal name associated with your TRN registration. (pattern: <code>(?!\s*$)[\s\S]+</code>)
registration_idstringThe supplemental TRN unique identifier. (pattern: <code>(?!\s*$)[\s\S]+</code>)
registration_typestringType of supplemental TRN. Currently, this can only be VAT. (VAT)
statusstringThe status of your TRN. (Verified, Pending, Deleted, Rejected)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_supplemental_tax_registrationsselectregionRetrieves supplemental tax registrations for a single account.
put_supplemental_tax_registrationreplaceregion, taxRegistrationEntryStores supplemental tax registration for a single account.
delete_supplemental_tax_registrationdeleteregionDeletes a supplemental tax registration for a single account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves supplemental tax registrations for a single account.

SELECT
address,
authority_id,
legal_name,
registration_id,
registration_type,
status
FROM aws.taxsettings.supplemental_tax_registrations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

Stores supplemental tax registration for a single account.

REPLACE aws.taxsettings.supplemental_tax_registrations
SET
taxRegistrationEntry = '{{ taxRegistrationEntry }}'
WHERE
region = '{{ region }}' --required
AND taxRegistrationEntry = '{{ taxRegistrationEntry }}' --required
RETURNING
authority_id,
status;

DELETE examples

Deletes a supplemental tax registration for a single account.

DELETE FROM aws.taxsettings.supplemental_tax_registrations
WHERE region = '{{ region }}' --required
;