AvaTax
VendorCertificateModel
Represents a certificate document for vendors. This model inherits all properties from CertificateModel and adds vendor-specific functionality.
The unique ID number of the document type for this vendor certificate.
The name of the document type for this vendor certificate.
The description of the document type for this vendor certificate.
Indicates whether this document type is for outgoing documents.
The unique ID number of this certificate.
The unique ID number of the AvaTax company that recorded this certificate.
The date when this certificate was signed.
Expiration date when this certificate will no longer be valid.
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.
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.
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.
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.
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.
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.
Indicates the tax number passed in for the certificate.
The exemption reason that CertCapture audit/internal logic identifies for created certificate.
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.
The status of the certificate. Possible values for status COMPLETE,PENDING,PENDING-FUTURE,PENDING-MULTI,PENDING-SINGLE,REVOKED
The status of the certificate as displayed on https://exemptions.avalara.com. The values in CertificateEcmStatus include all the possible status values.
The date/time when this record was created.
The date/time when this record was last modified.
The tax number type for the certificate. For example, FEIN, Social Security Number, or Employer Identification Number.
Description of business for the certificate. For example, Retail trade, Professional services, or Construction.
The number of pages contained within this certificate.
A list of customers to which this certificate applies. You can fetch this data by specifying
$include=customers when calling a certificate fetch API.
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.
The exposure zone where this certificate is valid.
The name of the exposure zone where this certificate is valid. This is a computed property for filtering purposes.
A list of jurisdictions associated with this certificate, indicating the tax authority regions where the certificate applies. A certificate can have one or more jurisdictions.
You can fetch this data by specifying $include=jurisdictions when calling a certificate fetch API.
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.
A list of update histories for this certificate.
You can fetch this data by specifying $include=histories when calling a certificate fetch API.
The jobs (and their phases / tasks) associated with this certificate.
On POST / PUT: supply the id of each existing job — and optionally nested phase /
task ids — to link them to this certificate. All other fields on each entry
(name, jobNumber, isExplicit, etc.) are server-computed and ignored
on input.
On GET: populated when $include=jobs is specified. Use $include=jobs.phases
to also expand the phases within each job, and $include=jobs.tasks to expand the
tasks within each phase (which implies jobs and jobs.phases).
A list of logs for this certificate.
You can fetch this data by specifying $include=logs when calling a certificate fetch API.
For a certificate with an invalid status, this lists the reasons why the certificate is invalid.
You can fetch this data by specifying $include=invalid_reasons when calling a certificate fetch API.
A list of custom defined fields for this certificate.
You can fetch this data by specifying $include=custom_fields when calling a certificate fetch API.
The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
The status of current AvaTax Exemption Certificate that refers to this certificate.
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.
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.