Exemption Certificate Management

OverviewAPIMCPIntegration guides
ECM (AvaTax) API
CertCapture RESTful APIs

EcmsDetailModel

Represents an ECMS record, used internally by AvaTax to track information about exemptions.

Parameters
exemptCertDetailIdRequired
integer

Unique, system-assigned identifier of a ExemptCertDetail record.

exemptCertIdRequired
integer

The calc_id associated with a certificate in CertCapture.

stateFipsRequired
string

State FIPS

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

idNoOptional
string

The customer Tax Id Number (tax_number) associated with a certificate. This is same as exemptionNo in Transactions.

countryRequired
string

Name or ISO 3166 code identifying the country.

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.

endDateOptional
string

End date of this exempt certificate

idTypeOptional
string

The type of idNo (tax_number) associated with a certificate. Example: Driver's Licence Number, Permit Number.

isTaxCodeListExclusionListOptional
integer

Is the tax code list an exculsion list?

taxCodesOptional
array

optional: list of tax code associated with this exempt certificate detail