Exemption Certificate Management

OverviewAPIMCPIntegration guides
ECM (AvaTax) API
CertCapture RESTful APIs

ComplianceJurisdictionModel

Model for distinct jurisdictions.

Parameters
taxRegionIdOptional
integer

The id of the tax region.

stateAssignedCodeOptional
string

The state assigned code for the jurisdiction.

jurisdictionTypeIdOptional
string

The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.

nameOptional
string

The name of the jurisdiction.

countyOptional
string

The name of the county.

cityOptional
string

The name of the city.

regionOptional
string

Name or ISO 3166 code identifying the region within the country.

This field supports many different region identifiers:

  • Two and three character ISO 3166 region codes
  • Fully spelled out names of the region in ISO supported languages
  • Common alternative spellings for many regions

For a full list of all supported codes and names, please see the Definitions API ListRegions.

countryOptional
string

Name or ISO 3166 code identifying the country of this jurisdiction.

This field supports many different country identifiers:

  • Two character ISO 3166 codes
  • Three character ISO 3166 codes
  • Fully spelled out names of the country in ISO supported languages
  • Common alternative spellings for many countries

For a full list of all supported codes and names, please see the Definitions API ListCountries.

taxRegionNameOptional
string

The name of the tax region.

taxAuthorityIdOptional
integer

The id of the tax authority.

ratesOptional
array

Optional: A list of rates for this jurisdiction. To fetch this list, add the query string ?$include=TaxRates to your URL.