Exemption Certificate Management

OverviewAPIMCPIntegration guides
ECM (AvaTax) API
CertCapture RESTful APIs

TransactionSummary

Summary information about an overall transaction.

Parameters
countryOptional
string

Two character ISO-3166 country code.

regionOptional
string

Two or three character ISO region, state or province code, if applicable.

jurisTypeOptional
string

The type of jurisdiction that collects this tax.

Enum: Country, State, County, City, Special
jurisCodeOptional
string

Jurisdiction Code for the taxing jurisdiction

jurisNameOptional
string

The name of the jurisdiction that collects this tax.

taxAuthorityTypeOptional
integer

The unique ID of the Tax Authority Type that collects this tax.

stateAssignedNoOptional
string

The state assigned number of the jurisdiction that collects this tax.

taxTypeOptional
string

The tax type of this tax.

taxSubTypeOptional
string

The tax subtype of this tax.

taxNameOptional
string

The name of the tax.

taxGroupOptional
string

Group code when special grouping is enabled.

rateTypeOptional
string

DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead. Indicates the tax rate type.

Enum: ReducedA, ReducedB, Food, General, IncreasedStandard, LinenRental, Medical, Construction, Parking, SuperReduced, ReducedR, Standard, Leasing, LeasingLow, Services, Zero
rateTypeCodeOptional
string

Indicates the code of the rate type. Use ListRateTypesByCountry API for a full list of rate type codes.

taxableOptional
number

Tax Base - The adjusted taxable amount.

rateOptional
number

Tax Rate - The rate of taxation, as a fraction of the amount.

taxOptional
number

Tax amount - The calculated tax (Base * Rate).

taxCalculatedOptional
number

The amount of tax that AvaTax calculated for the transaction.

If you used a taxOverride of type taxAmount, there may be a difference between the tax field which applies your override, and the TaxCalculated field which represents the amount of tax that AvaTax calculated for this transaction without override.

You can use this for comparison.

nonTaxableOptional
number

The amount of the transaction that was non-taxable.

exemptionOptional
number

The amount of the transaction that was exempt.