Class CertExpressInvitationModel
java.lang.Object
net.avalara.avatax.rest.client.models.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.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGetter for companyId The unique ID number of the AvaTax company that sent this invitation.Getter for coverLetterGetter for coverLettersOnly True if this invitation contained a cover letter only.Getter for customerGetter for customerCode The unique code of the customer that received this invitation.getDate()
Getter for date The date of the invitation.Getter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.Getter for emailStatus The status of the emails associated with this invitation.Getter for exemptReasons The list of exemption reasons identified by this CertExpress invitation.Getter for exposureZones When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload their exemption certificates.getId()
Getter for id A unique ID number representing this CertExpress invitation.Getter for message The custom message delivered with this invitation.Getter for recipient The email address to which this invitation was sent.Getter for requestLink The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.void
setCompanyId
(Integer value) Setter for companyId The unique ID number of the AvaTax company that sent this invitation.void
setCoverLetter
(CoverLetterModel value) Setter for coverLettervoid
setCoverLettersOnly
(Boolean value) Setter for coverLettersOnly True if this invitation contained a cover letter only.void
setCustomer
(CustomerModel value) Setter for customervoid
setCustomerCode
(String value) Setter for customerCode The unique code of the customer that received this invitation.void
Setter for date The date of the invitation.void
Setter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.void
setEmailStatus
(String value) Setter for emailStatus The status of the emails associated with this invitation.void
setExemptReasons
(ArrayList<Integer> value) Setter for exemptReasons The list of exemption reasons identified by this CertExpress invitation.void
setExposureZones
(ArrayList<Integer> value) Setter for exposureZones When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload their exemption certificates.void
Setter for id A unique ID number representing this CertExpress invitation.void
setMessage
(String value) Setter for message The custom message delivered with this invitation.void
setRecipient
(String value) Setter for recipient The email address to which this invitation was sent.void
setRequestLink
(String value) Setter for requestLink The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.toString()
Returns a JSON string representation of CertExpressInvitationModel
-
Constructor Details
-
CertExpressInvitationModel
public CertExpressInvitationModel()
-
-
Method Details
-
getId
Getter for id A unique ID number representing this CertExpress invitation. -
setId
Setter for id A unique ID number representing this CertExpress invitation. -
getCompanyId
Getter for companyId The unique ID number of the AvaTax company that sent this invitation. -
setCompanyId
Setter for companyId The unique ID number of the AvaTax company that sent this invitation. -
getRecipient
Getter for recipient The email address to which this invitation was sent. If this invitation was presented as a weblink, this value will be null. -
setRecipient
Setter for recipient The email address to which this invitation was sent. If this invitation was presented as a weblink, this value will be null. -
getCustomerCode
Getter for customerCode 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. -
setCustomerCode
Setter for customerCode 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. -
getCustomer
Getter for customer -
setCustomer
Setter for customer -
getCoverLetter
Getter for coverLetter -
setCoverLetter
Setter for coverLetter -
getEmailStatus
Getter for emailStatus 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. -
setEmailStatus
Setter for emailStatus 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. -
getCoverLettersOnly
Getter for coverLettersOnly True if this invitation contained a cover letter only. -
setCoverLettersOnly
Setter for coverLettersOnly True if this invitation contained a cover letter only. -
getExposureZones
Getter for exposureZones 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`. -
setExposureZones
Setter for exposureZones 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`. -
getExemptReasons
Getter for exemptReasons The list of exemption reasons identified by this CertExpress invitation. For a list of reason codes, please call `ListCertificateExemptReasons`. -
setExemptReasons
Setter for exemptReasons The list of exemption reasons identified by this CertExpress invitation. For a list of reason codes, please call `ListCertificateExemptReasons`. -
getDeliveryMethod
Getter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation. -
setDeliveryMethod
Setter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation. -
getMessage
Getter for message The custom message delivered with this invitation. -
setMessage
Setter for message The custom message delivered with this invitation. -
getDate
Getter for date The date of the invitation. -
setDate
Setter for date The date of the invitation. -
getRequestLink
Getter for requestLink 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. -
setRequestLink
Setter for requestLink 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. -
toString
Returns a JSON string representation of CertExpressInvitationModel
-