AvaTax

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

EcmsModel

Exempt certificate

Parameters
exemptCertIdRequired
integer

The calc_id associated with a certificate in CertCapture.

companyIdRequired
integer

Company ID

customerCodeRequired
string

Customer code

customerNameOptional
string

Customer name

address1Optional
string

Address line 1

address2Optional
string

Address line 2

address3Optional
string

Address line 3

cityOptional
string

City

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.

postalCodeOptional
string

Postal code / zip code

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.

exemptCertTypeIdRequired
string

The type of exemption certificate. Permitted values are: Blanket and Single.

Enum: Blanket, SingleUse
documentRefNoOptional
string

Document Reference Number, in the case of single-use exemption certificates, the DocumentCode or PurchaseOrderNo to which the certificate should apply.

businessTypeIdRequired
integer

Business type the customer belongs to.

businessTypeOtherDescriptionOptional
string

Other description for this business type

exemptReasonIdOptional
string

Exempt reason associated with the certificate, coded by CustomerUsageType. Example: A - Federal Government.

exemptReasonOtherDescriptionOptional
string

Other description for exempt reason i.e. Populated on if exemptReasonId is 'L' - Other.

effectiveDateOptional
string

Effective date for this exempt certificate

regionsApplicableRequired
string

A list of applicable regions for this exempt certificate.

To list more than one applicable region, separate the list of region codes with commas.

exemptCertStatusIdRequired
string

Status for this exempt certificate

Enum: Inactive, Active, Expired, Revoked
createdDateOptional
string

Date when this exempt certificate was created

lastTransactionDateOptional
string

Date when last transaction with this exempt certificate happened

expiryDateOptional
string

When this exempt certificate will expire

createdUserIdOptional
integer

User that creates the certificate

modifiedDateOptional
string

Date when this exempt certificate was modified

modifiedUserIdOptional
integer

Who modified this exempt certificate

countryIssuedRequired
string

Name or ISO 3166 code identifying the country that issued this ECMS certificate.

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.

avaCertIdOptional
string

If the certificate record was synced from an AvaTax Certs account(as opposed to being entered in ECMS directly), the unique AvaTax Certs identifier for the certificate record. Usually same as the Id of a Certificate.

exemptCertReviewStatusIdOptional
string

Review status for this exempt certificate

Enum: Pending, Accepted, Rejected
detailsOptional
array

Exempt Cert details