Exemption Certificate Management

CertCapture RESTful APIs

CustomerCertificate

The object returned from the /v2/customers/{id}/certificates call. The certificate nodel w customer pivot points is returned. Note - to create a new certificate, you will need to use the Certificate 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
barcode_readOptional
boolean
business_numberOptional
integer

business number associated with certificate.

business_number_typeOptional
string
calc_idOptional
integer

id associated with calc account.

certificate_numberOptional
string
client_idOptional
integer

The system generated company id.

communication_idOptional
integer
createdOptional
string

DateTime of when the record was created.

directOptional
boolean
document_typeOptional
array

Designates the document type.

exempt_reason_descriptionOptional
string
exmpt_percentOptional
number
expected_tax_codeOptional
array

The expected tax code of the certificate.

expiration_dateOptional
string

Date of when the record expires.

explicitOptional
boolean
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
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
statusOptional
array

Status of the certificate.

tax_numberOptional
string
tax_number_typeOptional
string
unused_multi_certOptional
boolean
validOptional
boolean

Designates if a certificate is valid.

verification_numberOptional
string
verifiedOptional
boolean

Designates if a certificate has been verified.