CertificateModel

java.lang.Object
- net.avalara.avatax.rest.client.models.CertificateModel

```
public class CertificateModel
extends java.lang.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 Summary

Constructors
Constructor and Description

CertificateModel()

Constructors
Constructor and Description
`CertificateModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.ArrayList<CertificateAttributeModel>`	`getAttributes()` Getter for attributes A list of certificate attributes that apply to this certificate.
`java.lang.Integer`	`getCompanyId()` Getter for companyId The unique ID number of the AvaTax company that recorded this certificate.
`java.util.Date`	`getCreatedDate()` Getter for createdDate The date/time when this record was created.
`java.util.ArrayList<CustomerModel>`	`getCustomers()` Getter for customers A list of customers to which this certificate applies.
`java.lang.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.
`java.lang.Integer`	`getEcmsId()` Getter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
`java.lang.String`	`getEcmsStatus()` Getter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.
`java.lang.String`	`getExemptionNumber()` Getter for exemptionNumber Indicates the tax number passed in for the certificate.
`ExemptionReasonModel`	`getExemptionReason()` Getter for exemptionReason The exemption reason associated with this certificate.
`java.math.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.
`java.util.Date`	`getExpirationDate()` Getter for expirationDate Expiration date when this certificate will no longer be valid.
`ExposureZoneModel`	`getExposureZone()` Getter for exposureZone The exposure zone where this certificate is valid.
`java.lang.String`	`getFilename()` Getter for filename File name for the image of this certificate.
`java.lang.Integer`	`getId()` Getter for id Unique ID number of this certificate.
`java.lang.Boolean`	`getIsSingleCertificate()` Getter for isSingleCertificate This value is true if this certificate is a single (or standalone) certificate.
`java.util.Date`	`getModifiedDate()` Getter for modifiedDate The date/time when this record was last modified.
`java.lang.Integer`	`getPageCount()` Getter for pageCount Number of pages contained within this certificate.
`java.util.ArrayList<java.lang.String>`	`getPages()` Getter for pages This field is available for input only.
`java.lang.String`	`getPdf()` Getter for pdf This field is available for input only.
`java.util.ArrayList<PoNumberModel>`	`getPoNumbers()` Getter for poNumbers A list of purchase order numbers that are valid for use with this certificate.
`java.util.Date`	`getSignedDate()` Getter for signedDate The date when this certificate was signed.
`java.lang.String`	`getStatus()` Getter for status The status of the certificate
`java.lang.Boolean`	`getValid()` Getter for valid True if this certificate is marked as valid.
`ExemptionReasonModel`	`getValidatedExemptionReason()` Getter for validatedExemptionReason The exemption reason that CertCapture audit/internal logic identifies for created certificate.
`java.lang.Boolean`	`getVerified()` Getter for verified This value is true if the certificate has gone through the certificate validation process.
`void`	`setAttributes(java.util.ArrayList<CertificateAttributeModel> value)` Setter for attributes A list of certificate attributes that apply to this certificate.
`void`	`setCompanyId(java.lang.Integer value)` Setter for companyId The unique ID number of the AvaTax company that recorded this certificate.
`void`	`setCreatedDate(java.util.Date value)` Setter for createdDate The date/time when this record was created.
`void`	`setCustomers(java.util.ArrayList<CustomerModel> value)` Setter for customers A list of customers to which this certificate applies.
`void`	`setDocumentExists(java.lang.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.
`void`	`setEcmsId(java.lang.Integer value)` Setter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
`void`	`setEcmsStatus(java.lang.String value)` Setter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.
`void`	`setExemptionNumber(java.lang.String value)` Setter for exemptionNumber Indicates the tax number passed in for the certificate.
`void`	`setExemptionReason(ExemptionReasonModel value)` Setter for exemptionReason The exemption reason associated with this certificate.
`void`	`setExemptPercentage(java.math.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.
`void`	`setExpirationDate(java.util.Date value)` Setter for expirationDate Expiration date when this certificate will no longer be valid.
`void`	`setExposureZone(ExposureZoneModel value)` Setter for exposureZone The exposure zone where this certificate is valid.
`void`	`setFilename(java.lang.String value)` Setter for filename File name for the image of this certificate.
`void`	`setId(java.lang.Integer value)` Setter for id Unique ID number of this certificate.
`void`	`setIsSingleCertificate(java.lang.Boolean value)` Setter for isSingleCertificate This value is true if this certificate is a single (or standalone) certificate.
`void`	`setModifiedDate(java.util.Date value)` Setter for modifiedDate The date/time when this record was last modified.
`void`	`setPageCount(java.lang.Integer value)` Setter for pageCount Number of pages contained within this certificate.
`void`	`setPages(java.util.ArrayList<java.lang.String> value)` Setter for pages This field is available for input only.
`void`	`setPdf(java.lang.String value)` Setter for pdf This field is available for input only.
`void`	`setPoNumbers(java.util.ArrayList<PoNumberModel> value)` Setter for poNumbers A list of purchase order numbers that are valid for use with this certificate.
`void`	`setSignedDate(java.util.Date value)` Setter for signedDate The date when this certificate was signed.
`void`	`setStatus(java.lang.String value)` Setter for status The status of the certificate
`void`	`setValid(java.lang.Boolean value)` Setter for valid True if this certificate is marked as valid.
`void`	`setValidatedExemptionReason(ExemptionReasonModel value)` Setter for validatedExemptionReason The exemption reason that CertCapture audit/internal logic identifies for created certificate.
`void`	`setVerified(java.lang.Boolean value)` Setter for verified This value is true if the certificate has gone through the certificate validation process.
`java.lang.String`	`toString()` Returns a JSON string representation of CertificateModel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CertificateModel
```
public CertificateModel()
```
- Method Detail
  - getId
```
public java.lang.Integer getId()
```
    Getter for id Unique ID number of this certificate.
  - setId
```
public void setId(java.lang.Integer value)
```
    Setter for id Unique ID number of this certificate.
  - getCompanyId
```
public java.lang.Integer getCompanyId()
```
    Getter for companyId The unique ID number of the AvaTax company that recorded this certificate.
  - setCompanyId
```
public void setCompanyId(java.lang.Integer value)
```
    Setter for companyId The unique ID number of the AvaTax company that recorded this certificate.
  - getSignedDate
```
public java.util.Date getSignedDate()
```
    Getter for signedDate The date when this certificate was signed.
  - setSignedDate
```
public void setSignedDate(java.util.Date value)
```
    Setter for signedDate The date when this certificate was signed.
  - getExpirationDate
```
public java.util.Date getExpirationDate()
```
    Getter for expirationDate Expiration date when this certificate will no longer be valid.
  - setExpirationDate
```
public void setExpirationDate(java.util.Date value)
```
    Setter for expirationDate Expiration date when this certificate will no longer be valid.
  - getFilename
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.math.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(java.math.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 java.lang.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(java.lang.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 java.lang.String getExemptionNumber()
```
    Getter for exemptionNumber Indicates the tax number passed in for the certificate.
  - setExemptionNumber
```
public void setExemptionNumber(java.lang.String value)
```
    Setter for exemptionNumber Indicates the tax number passed in for the certificate.
  - getValidatedExemptionReason
```
public ExemptionReasonModel getValidatedExemptionReason()
```
    Getter for validatedExemptionReason The exemption reason that CertCapture audit/internal logic identifies for created certificate.
  - setValidatedExemptionReason
```
public void setValidatedExemptionReason(ExemptionReasonModel value)
```
    Setter for validatedExemptionReason The exemption reason that CertCapture audit/internal logic identifies for created certificate.
  - getExemptionReason
```
public ExemptionReasonModel getExemptionReason()
```
    Getter for exemptionReason The exemption reason associated with this certificate. For example, the reason code for exemption for purposes of resale is `RESALE`. For a list of exemption reasons, call `ListCertificateExemptReasons`.
  - setExemptionReason
```
public void setExemptionReason(ExemptionReasonModel value)
```
    Setter for exemptionReason The exemption reason associated with this certificate. For example, the reason code for exemption for purposes of resale is `RESALE`. For a list of exemption reasons, call `ListCertificateExemptReasons`.
  - getStatus
```
public java.lang.String getStatus()
```
    Getter for status The status of the certificate
  - setStatus
```
public void setStatus(java.lang.String value)
```
    Setter for status The status of the certificate
  - getCreatedDate
```
public java.util.Date getCreatedDate()
```
    Getter for createdDate The date/time when this record was created.
  - setCreatedDate
```
public void setCreatedDate(java.util.Date value)
```
    Setter for createdDate The date/time when this record was created.
  - getModifiedDate
```
public java.util.Date getModifiedDate()
```
    Getter for modifiedDate The date/time when this record was last modified.
  - setModifiedDate
```
public void setModifiedDate(java.util.Date value)
```
    Setter for modifiedDate The date/time when this record was last modified.
  - getPageCount
```
public java.lang.Integer getPageCount()
```
    Getter for pageCount Number of pages contained within this certificate.
  - setPageCount
```
public void setPageCount(java.lang.Integer value)
```
    Setter for pageCount Number of pages contained within this certificate.
  - getCustomers
```
public java.util.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(java.util.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 java.util.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(java.util.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 The exposure zone where this certificate is valid.
  - setExposureZone
```
public void setExposureZone(ExposureZoneModel value)
```
    Setter for exposureZone The exposure zone where this certificate is valid.
  - getAttributes
```
public java.util.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(java.util.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 java.lang.Integer getEcmsId()
```
    Getter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
  - setEcmsId
```
public void setEcmsId(java.lang.Integer value)
```
    Setter for ecmsId The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
  - getEcmsStatus
```
public java.lang.String getEcmsStatus()
```
    Getter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.
  - setEcmsStatus
```
public void setEcmsStatus(java.lang.String value)
```
    Setter for ecmsStatus The status of current AvaTax Exemption Certificate that refers to this certificate.
  - getPdf
```
public java.lang.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(java.lang.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 java.util.ArrayList<java.lang.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(java.util.ArrayList<java.lang.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 java.lang.String toString()
```
    Returns a JSON string representation of CertificateModel
    
    Overrides:
    
    toString in class java.lang.Object

Class CertificateModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CertificateModel

Method Detail

getId

setId

getCompanyId

setCompanyId

getSignedDate

setSignedDate

getExpirationDate

setExpirationDate

getFilename

setFilename

getDocumentExists

setDocumentExists

getValid

setValid

getVerified

setVerified

getExemptPercentage

setExemptPercentage

getIsSingleCertificate

setIsSingleCertificate

getExemptionNumber

setExemptionNumber

getValidatedExemptionReason

setValidatedExemptionReason

getExemptionReason

setExemptionReason

getStatus

setStatus

getCreatedDate

setCreatedDate

getModifiedDate

setModifiedDate

getPageCount

setPageCount

getCustomers

setCustomers

getPoNumbers

setPoNumbers

getExposureZone

setExposureZone

getAttributes

setAttributes

getEcmsId

setEcmsId

getEcmsStatus

setEcmsStatus

getPdf

setPdf

getPages

setPages

toString