Tax Calculation and Tax GIS Mandatory Fields
Learn about mandatory fields for the Tax Calculation and Tax GIS API.
Calculation mandatory fields
The transactionType
field is required for both Sales (Supplies) and Purchase (Procurement) requests.
Field | Request | Description |
---|---|---|
transactionType | Calculate Tax as a Seller | string (SaleTransactionTypeEnum )Enum: "SALE" ,"RENTAL" , "LEASE" |
transactionType | Calculate Tax as a Buyer | string (PurchaseTransactionTypeEnum )Enum: "PURCHASE" , "RENTAL" , "LEASE" |
Transaction Management mandatory fields
The id
field is required to delete or reverse a transaction and the transactionid
field is required to check a transaction.
Field | Request | Description |
---|---|---|
id | Delete a Transaction | string ([ 1 .. 40 ] characters) An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes. |
id | Reverse a Transaction | string ([ 1 .. 40 ] characters) The Transaction ID of the transaction to be reversed. This is a unique user-defined value that was provided on the original tax calculation. |
transactionid | Check for a Transaction | string ([ 1 .. 40 ] characters) The Transaction ID of the transaction to be reversed. This is a unique user-defined value that was provided on the original tax calculation. |
Tax Area Lookup mandatory fields
- The
postalAddress
field is required to retrieve a tax area by address. - The
coordinates
,latitude
, andlongitude
fields are required to retrieve a tax area by latitude and longitude. - The
taxAreaId
field is required to retrieve a tax area by unique ID. - The
externalJurisdictionCode
andcountry
fields are required to retrieve a tax area by jurisdiction.
Fields | Request | Description |
---|---|---|
postalAddress | Lookup by Postal Address | object (PostalAddressType )Postal Address declaration. |
coordinates | Lookup by Coordinates | object (CoordinatesType )Coordinates declaration. |
latitude | Lookup by Coordinates | number A number representing the geographical latitude coordinate of the location |
longitude | Lookup by Coordinates | number A number representing the geographical longitude coordinate of the location. |
externalJurisdictionCode | Lookup by Jurisdiction Code | string <= 20 characters A jurisdiction identifier provided by a government authority. |
country | Lookup by Jurisdiction Code | string [ 1 .. 60 ] characters The country associated with the external jurisdiction code. You can use a data extract report to see the valid country values. |
beginDate | List Tax Areas with Changes | date Begin date for the search. |
taxAreaId | Lookup by Tax Area ID Check a Tax Area for Changes | string A Vertex-specific number that identifies a tax area. |
Updated 3 months ago