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

Class CertificateModel

java.lang.Object
net.avalara.avatax.rest.client.models.CertificateModel
public class CertificateModel extends Object
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on criteria you specify when you store the certificate. To view or manage your certificates directly, please log onto the administrative website for the product you purchased.

  • Constructor Details

    • CertificateModel

      public CertificateModel()

  • Method Details

    • getId

      public Integer getId()
      Getter for id Unique ID number of this certificate.

    • setId

      public void setId(Integer value)
      Setter for id Unique ID number of this certificate.

    • getCompanyId

      public Integer getCompanyId()
      Getter for companyId The unique ID number of the AvaTax company that recorded this certificate.

    • setCompanyId

      public void setCompanyId(Integer value)
      Setter for companyId The unique ID number of the AvaTax company that recorded this certificate.

    • getSignedDate

      public Date getSignedDate()
      Getter for signedDate The date when this certificate was signed.

    • setSignedDate

      public void setSignedDate(Date value)
      Setter for signedDate The date when this certificate was signed.

    • getExpirationDate

      public Date getExpirationDate()
      Getter for expirationDate Expiration date when this certificate will no longer be valid.

    • setExpirationDate

      public void setExpirationDate(Date value)
      Setter for expirationDate Expiration date when this certificate will no longer be valid.

    • getFilename

      public String getFilename()
      Getter for filename File name for the image of this certificate. When creating a certificate, if you do not upload a PDF or JPG image, you must specify the filename of the certificate as it is tracked in your repository. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • setFilename

      public void setFilename(String value)
      Setter for filename File name for the image of this certificate. When creating a certificate, if you do not upload a PDF or JPG image, you must specify the filename of the certificate as it is tracked in your repository. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • getDocumentExists

      public Boolean getDocumentExists()
      Getter for documentExists This value is true if there exists scanned PDF copy of this certificate or the PDF version of the form that the customer filled via the CertCapture wizard on S3 bucket.

    • setDocumentExists

      public void setDocumentExists(Boolean value)
      Setter for documentExists This value is true if there exists scanned PDF copy of this certificate or the PDF version of the form that the customer filled via the CertCapture wizard on S3 bucket.

    • getValid

      public Boolean getValid()
      Getter for valid True if this certificate is marked as valid. A valid certificate can be considered for exemption purposes. When a certificate is marked invalid, it will no longer be considered when calculating exemption for a customer.

    • setValid

      public void setValid(Boolean value)
      Setter for valid True if this certificate is marked as valid. A valid certificate can be considered for exemption purposes. When a certificate is marked invalid, it will no longer be considered when calculating exemption for a customer.

    • getVerified

      public Boolean getVerified()
      Getter for verified This value is true if the certificate has gone through the certificate validation process. For more information on the certificate validation process, please see the Avalara Help Center.

    • setVerified

      public void setVerified(Boolean value)
      Setter for verified This value is true if the certificate has gone through the certificate validation process. For more information on the certificate validation process, please see the Avalara Help Center.

    • getExemptPercentage

      public BigDecimal getExemptPercentage()
      Getter for exemptPercentage If this certificate provides exemption from transactional taxes, what percentage of the transaction is considered exempt? For a fully exempt certificate, this percentage should be 100.

    • setExemptPercentage

      public void setExemptPercentage(BigDecimal value)
      Setter for exemptPercentage If this certificate provides exemption from transactional taxes, what percentage of the transaction is considered exempt? For a fully exempt certificate, this percentage should be 100.

    • getIsSingleCertificate

      public Boolean getIsSingleCertificate()
      Getter for isSingleCertificate This value is true if this certificate is a single (or standalone) certificate. This value is set during the audit stage of the certificate validation process.

    • setIsSingleCertificate

      public void setIsSingleCertificate(Boolean value)
      Setter for isSingleCertificate This value is true if this certificate is a single (or standalone) certificate. This value is set during the audit stage of the certificate validation process.

    • getExemptionNumber

      public String getExemptionNumber()
      Getter for exemptionNumber Indicates the tax number passed in for the certificate.

    • setExemptionNumber

      public void setExemptionNumber(String value)
      Setter for exemptionNumber Indicates the tax number passed in for the certificate.

    • getValidatedExemptionReason

      public ExemptionReasonModel getValidatedExemptionReason()
      Getter for validatedExemptionReason

    • setValidatedExemptionReason

      public void setValidatedExemptionReason(ExemptionReasonModel value)
      Setter for validatedExemptionReason

    • getExemptionReason

      public ExemptionReasonModel getExemptionReason()
      Getter for exemptionReason

    • setExemptionReason

      public void setExemptionReason(ExemptionReasonModel value)
      Setter for exemptionReason

    • getStatus

      public String getStatus()
      Getter for status The status of the certificate

    • setStatus

      public void setStatus(String value)
      Setter for status The status of the certificate

    • getCreatedDate

      public Date getCreatedDate()
      Getter for createdDate The date/time when this record was created.

    • setCreatedDate

      public void setCreatedDate(Date value)
      Setter for createdDate The date/time when this record was created.

    • getModifiedDate

      public Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.

    • setModifiedDate

      public void setModifiedDate(Date value)
      Setter for modifiedDate The date/time when this record was last modified.

    • getTaxNumberType

      public String getTaxNumberType()
      Getter for taxNumberType The tax number type for the certificate. For example, `FEIN`, `Social Security Number`, or `Employer Identification Number`.

    • setTaxNumberType

      public void setTaxNumberType(String value)
      Setter for taxNumberType The tax number type for the certificate. For example, `FEIN`, `Social Security Number`, or `Employer Identification Number`.

    • getBusinessNumberType

      public String getBusinessNumberType()
      Getter for businessNumberType Description of business for the certificate. For example, `Retail trade`, `Professional services`, or `Construction`.

    • setBusinessNumberType

      public void setBusinessNumberType(String value)
      Setter for businessNumberType Description of business for the certificate. For example, `Retail trade`, `Professional services`, or `Construction`.

    • getPageCount

      public Integer getPageCount()
      Getter for pageCount Number of pages contained within this certificate.

    • setPageCount

      public void setPageCount(Integer value)
      Setter for pageCount Number of pages contained within this certificate.

    • getCustomers

      public ArrayList<CustomerModel> getCustomers()
      Getter for customers A list of customers to which this certificate applies. You can fetch this data by specifying `$include=customers` when calling a certificate fetch API.

    • setCustomers

      public void setCustomers(ArrayList<CustomerModel> value)
      Setter for customers A list of customers to which this certificate applies. You can fetch this data by specifying `$include=customers` when calling a certificate fetch API.

    • getPoNumbers

      public ArrayList<PoNumberModel> getPoNumbers()
      Getter for poNumbers A list of purchase order numbers that are valid for use with this certificate. If this certificate is applicable for all purchase order numbers, this field will be empty. You can fetch this data by specifying `$include=po_numbers` when calling a certificate fetch API.

    • setPoNumbers

      public void setPoNumbers(ArrayList<PoNumberModel> value)
      Setter for poNumbers A list of purchase order numbers that are valid for use with this certificate. If this certificate is applicable for all purchase order numbers, this field will be empty. You can fetch this data by specifying `$include=po_numbers` when calling a certificate fetch API.

    • getExposureZone

      public ExposureZoneModel getExposureZone()
      Getter for exposureZone

    • setExposureZone

      public void setExposureZone(ExposureZoneModel value)
      Setter for exposureZone

    • getAttributes

      public ArrayList<CertificateAttributeModel> getAttributes()
      Getter for attributes A list of certificate attributes that apply to this certificate. You can fetch this data by specifying `$include=attributes` when calling a certificate fetch API.

    • setAttributes

      public void setAttributes(ArrayList<CertificateAttributeModel> value)
      Setter for attributes A list of certificate attributes that apply to this certificate. You can fetch this data by specifying `$include=attributes` when calling a certificate fetch API.

    • getEcmsId

      public Integer getEcmsId()
      Getter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.

    • setEcmsId

      public void setEcmsId(Integer value)
      Setter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.

    • getEcmsStatus

      public String getEcmsStatus()
      Getter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.

    • setEcmsStatus

      public void setEcmsStatus(String value)
      Setter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.

    • getPdf

      public String getPdf()
      Getter for pdf This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a PDF image in Base64 URLEncoded format. PDFs are automatically parsed into individual page JPG images and can be retrieved back later as either the original PDF or the individual pages. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • setPdf

      public void setPdf(String value)
      Setter for pdf This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a PDF image in Base64 URLEncoded format. PDFs are automatically parsed into individual page JPG images and can be retrieved back later as either the original PDF or the individual pages. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • getPages

      public ArrayList<String> getPages()
      Getter for pages This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a list of JPG images, one per page, in Base64 URLEncoded format. These JPG images are automatically combined into a single downloadable PDF and can be retrieved back later as either the original JPG images or the combined PDF. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • setPages

      public void setPages(ArrayList<String> value)
      Setter for pages This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a list of JPG images, one per page, in Base64 URLEncoded format. These JPG images are automatically combined into a single downloadable PDF and can be retrieved back later as either the original JPG images or the combined PDF. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.

    • toString

      public String toString()
      Returns a JSON string representation of CertificateModel
      Overrides:
      toString in class Object