Package net.avalara.avatax.rest.client.models

Class CertExpressInvitationModel

  • public class CertExpressInvitationModel
extends java.lang.Object
    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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the AvaTax company that sent this invitation.
      CoverLetterModel getCoverLetter()
      Getter for coverLetter The attached cover letter object to this request.
      java.lang.Boolean getCoverLettersOnly()
      Getter for coverLettersOnly True if this invitation contained a cover letter only.
      CustomerModel getCustomer()
      Getter for customer The customer who received this invitation.
      java.lang.String getCustomerCode()
      Getter for customerCode The unique code of the customer that received this invitation.
      java.util.Date getDate()
      Getter for date The date of the invitation.
      CertificateRequestDeliveryMethod getDeliveryMethod()
      Getter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.
      java.lang.String getEmailStatus()
      Getter for emailStatus The status of the emails associated with this invitation.
      java.util.ArrayList<java.lang.Integer> getExemptReasons()
      Getter for exemptReasons The list of exemption reasons identified by this CertExpress invitation.
      java.util.ArrayList<java.lang.Integer> 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.
      java.lang.Integer getId()
      Getter for id A unique ID number representing this CertExpress invitation.
      java.lang.String getMessage()
      Getter for message The custom message delivered with this invitation.
      java.lang.String getRecipient()
      Getter for recipient The email address to which this invitation was sent.
      java.lang.String getRequestLink()
      Getter for requestLink The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the AvaTax company that sent this invitation.
      void setCoverLetter​(CoverLetterModel value)
      Setter for coverLetter The attached cover letter object to this request.
      void setCoverLettersOnly​(java.lang.Boolean value)
      Setter for coverLettersOnly True if this invitation contained a cover letter only.
      void setCustomer​(CustomerModel value)
      Setter for customer The customer who received this invitation.
      void setCustomerCode​(java.lang.String value)
      Setter for customerCode The unique code of the customer that received this invitation.
      void setDate​(java.util.Date value)
      Setter for date The date of the invitation.
      void setDeliveryMethod​(CertificateRequestDeliveryMethod value)
      Setter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.
      void setEmailStatus​(java.lang.String value)
      Setter for emailStatus The status of the emails associated with this invitation.
      void setExemptReasons​(java.util.ArrayList<java.lang.Integer> value)
      Setter for exemptReasons The list of exemption reasons identified by this CertExpress invitation.
      void setExposureZones​(java.util.ArrayList<java.lang.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 setId​(java.lang.Integer value)
      Setter for id A unique ID number representing this CertExpress invitation.
      void setMessage​(java.lang.String value)
      Setter for message The custom message delivered with this invitation.
      void setRecipient​(java.lang.String value)
      Setter for recipient The email address to which this invitation was sent.
      void setRequestLink​(java.lang.String value)
      Setter for requestLink The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.
      java.lang.String toString()
      Returns a JSON string representation of CertExpressInvitationModel

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • CertExpressInvitationModel

        public CertExpressInvitationModel()

    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id A unique ID number representing this CertExpress invitation.

      • setId

        public void setId​(java.lang.Integer value)
        Setter for id A unique ID number representing this CertExpress invitation.

      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId The unique ID number of the AvaTax company that sent this invitation.

      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId The unique ID number of the AvaTax company that sent this invitation.

      • getRecipient

        public java.lang.String 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

        public void setRecipient​(java.lang.String value)
        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

        public java.lang.String 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

        public void setCustomerCode​(java.lang.String value)
        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

        public CustomerModel getCustomer()
        Getter for customer The customer who received this invitation.

      • setCustomer

        public void setCustomer​(CustomerModel value)
        Setter for customer The customer who received this invitation.

      • getCoverLetter

        public CoverLetterModel getCoverLetter()
        Getter for coverLetter The attached cover letter object to this request.

      • setCoverLetter

        public void setCoverLetter​(CoverLetterModel value)
        Setter for coverLetter The attached cover letter object to this request.

      • getEmailStatus

        public java.lang.String 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

        public void setEmailStatus​(java.lang.String value)
        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

        public java.lang.Boolean getCoverLettersOnly()
        Getter for coverLettersOnly True if this invitation contained a cover letter only.

      • setCoverLettersOnly

        public void setCoverLettersOnly​(java.lang.Boolean value)
        Setter for coverLettersOnly True if this invitation contained a cover letter only.

      • getExposureZones

        public java.util.ArrayList<java.lang.Integer> 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

        public void setExposureZones​(java.util.ArrayList<java.lang.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. This list contains the ID numbers of the exposure zones identified. For a list of exposure zones, please call `ListCertificateExposureZones`.

      • getExemptReasons

        public java.util.ArrayList<java.lang.Integer> getExemptReasons()
        Getter for exemptReasons The list of exemption reasons identified by this CertExpress invitation. For a list of reason codes, please call `ListCertificateExemptReasons`.

      • setExemptReasons

        public void setExemptReasons​(java.util.ArrayList<java.lang.Integer> value)
        Setter for exemptReasons The list of exemption reasons identified by this CertExpress invitation. For a list of reason codes, please call `ListCertificateExemptReasons`.

      • getDeliveryMethod

        public CertificateRequestDeliveryMethod getDeliveryMethod()
        Getter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.

      • setDeliveryMethod

        public void setDeliveryMethod​(CertificateRequestDeliveryMethod value)
        Setter for deliveryMethod Indicates the method that was used to deliver this CertExpress invitation.

      • getMessage

        public java.lang.String getMessage()
        Getter for message The custom message delivered with this invitation.

      • setMessage

        public void setMessage​(java.lang.String value)
        Setter for message The custom message delivered with this invitation.

      • getDate

        public java.util.Date getDate()
        Getter for date The date of the invitation.

      • setDate

        public void setDate​(java.util.Date value)
        Setter for date The date of the invitation.

      • getRequestLink

        public java.lang.String 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

        public void setRequestLink​(java.lang.String value)
        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

        public java.lang.String toString()
        Returns a JSON string representation of CertExpressInvitationModel
        Overrides:
        toString in class java.lang.Object