Exemption Certificate Management

CertCapture RESTful APIs

CertificateResponse

Certificate Response Model

This model is used in the following APIs:

Parameters
actual_tax_codeOptional
array

The actual tax code of the certificate.

anonymous_customer_idOptional
integer

The id of the anonymous customer who created this certificate, if applicable.

barcode_readOptional
boolean

Used to indicate if this certificate contains a barcode for the system to read.

business_numberOptional
integer

business number associated with certificate.

business_number_typeOptional
string

From the SST form, the purchaser's type of business selected

calc_idOptional
integer

id associated with calc account.

certificate_numberOptional
string

The certificate number.

client_idOptional
integer

The system generated company id.

communication_idOptional
integer
createdOptional
string

DateTime of when the record was created.

document_typeOptional
array

Designates the document type.

exempt_reason_descriptionOptional
string

From the SST form, reason for exemption selected.

exmpt_percentOptional
number

The percentage that this certificate will exempt.

expected_tax_codeOptional
array

The expected tax code of the certificate.

expiration_dateOptional
string

Date of when the record expires.

exposure_zoneOptional
ExposureZone
filenameOptional
string

The certificate file name that was uploaded.

idOptional
integer

System Generated Certificate id.

is_singleOptional
boolean

Designates if certificate is single.

legacy_certificate_idOptional
string
location_idOptional
integer

The id of the location, if applicable, where this certificate was generated.

modifiedOptional
string

DateTime of when the record was modified.

never_renewOptional
boolean

Designates if a certificate can be renewed.

page_countOptional
integer

number of pages certificates contains.

renewableOptional
boolean

Designates if a certificate can be renewed.

s3_document_existsOptional
boolean

Designates if certificate exists in s3.

signed_dateOptional
string

Date of when the record was signed.

sst_metadataOptional
string

The SST data collected

statusOptional
array

Status of the certificate.

tax_numberOptional
string

The tax number used on the certificate.

tax_number_typeOptional
string

The type of tax number used on the certificate.

unused_multi_certOptional
boolean
validOptional
boolean

Designates if a certificate is valid.

verification_numberOptional
string

The verification number used for the certificate.

verifiedOptional
boolean

Designates if a certificate has been verified.