AvaTax

OverviewAPISDKMCP
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

CertExpressInvitationModel

Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record.

This model is used in the following APIs:

Parameters
idOptional
integer

A unique ID number representing this CertExpress invitation.

companyIdOptional
integer

The unique ID number of the AvaTax company that sent this invitation.

recipientOptional
string

The email address to which this invitation was sent. If this invitation was presented as a weblink, this value will be null.

customerCodeOptional
string

The unique code of the customer that received this invitation. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.

customerOptional
CustomerModel

The customer who received this invitation.

coverLetterOptional
CoverLetterModel

The attached cover letter object to this request.

emailStatusOptional
string

The status of the emails associated with this invitation. If this invitation was sent via email, this value will change to Sent when the email message has been sent.

coverLettersOnlyOptional
boolean

True if this invitation contained a cover letter only.

exposureZonesOptional
array

When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload their exemption certificates. This list contains the ID numbers of the exposure zones identified.

For a list of exposure zones, please call ListCertificateExposureZones.

exemptReasonsOptional
array

The list of exemption reasons identified by this CertExpress invitation.

For a list of reason codes, please call ListCertificateExemptReasons.

deliveryMethodOptional
string

Indicates the method that was used to deliver this CertExpress invitation.

Enum: Email, Fax, Download
messageOptional
string

The custom message delivered with this invitation.

dateOptional
string

The date of the invitation.

requestLinkOptional
string

The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.

This value is only usable if the status of this invitation is Ready and the request was created with type Download. NOTE: This link usually takes a few minutes to be available.