GET api/v7/Taxes/{taxCode}

Retrieve the tax information for the given tax code.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
taxCode *

the tax code

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

tax information

TaxDto
NameDescriptionType
taxCode

Tax Code

 string
orgName

Org Name

 string
locationName

Location Name

 string
jurisdiction

Jurisdiction

 string
taxRate

Tax rate

 decimal number
taxRateMethod

Tax Rate Method

 integer
roundingMethod

Rounding Method

 integer
thresholdMethod

Threshold Method

 integer
thresholdAmount

Threshold Amount

 decimal number
exclusive

exclusive

 boolean
returnTaxDays

Return Tax Days

 integer
taxTypeCode

Tax Type Code. If Tax Type code is for 'VAT', then 'Jurisdiction' field must be set

 string
taxTypeName

Tax Type Name

 string
taxTypeCharacters

Associated Character(s) of the tax type

 string
taxTableCode

Taxtable Code

 string
filePath

File path

 string
formula

Formula

 string
activeDate

The date from which the tax would be effective

 date
compoundTax

Compound tax specific tax information

 Collection of CompoundTaxDto
taxClassInfo

TaxClassInfo contains TaxClass associate with TaxType and also validate TaxRule if any associate with TaxClassCode This TaxClass Info does not support by Tax -PUT/POST API to create mapping. Please use TaxClassTaxType or TaxClassTaxRule API to create mapping

 Collection of TaxClassRuleDto
culture

Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc.

 string
description

Description Text (Culture specific)

 string
customerAuditDate

Audit information

 date

Response Formats

application/json, text/json

Sample: 
{
  "taxCode": "1",
  "orgName": "111",
  "locationName": "111",
  "jurisdiction": "State",
  "taxRate": 5.0,
  "returnTaxDays": 30,
  "taxTypeCode": "1",
  "taxTypeName": "state tax",
  "taxTypeCharacters": "T",
  "taxTableCode": "table01",
  "filePath": "c:\\temp\\",
  "formula": "xyz",
  "activeDate": "0001-01-01T00:00:00",
  "compoundTax": [
    {
      "taxTypeCode": "2",
      "sequence": 1
    }
  ],
  "culture": "en-US",
  "description": "state tax",
  "customerAuditDate": "2018-01-01T00:00:00"
}