Attention!

Looking for the most up-to-date Sales Tax Filing or CertManager documentation? Go to our new documentation platform, Sovos Docs. For Global Tax Determination, connector and CertManager API docs, stay here.

Create an exemption (V1)

The V1 API only supports state and province-level exemptions. To add local exemptions, use the V2 API.

Request information

  • HTTP method: POST
  • Content-type header: multipart/form-data
  • URL
    • CertManager UAT: https://certmanager-uat.sovos.com/api/pre-auth/v1/certificates/public/exemptions
    • CertManager Production: https://certmanager.sovos.com/api/pre-auth/v1/certificates/public/exemptions

The customer must exist in CertManager before you can create the exemption and assign it to them.

Request fields

Field

Data type

Required or optional

Description
file File Required PDF of exemption
creationBy String Optional

Name of user creating the exemption

If not passed, the default is Public API
effectiveDate Date

Required if isAuditable is true

Optional if isAuditable is false

Exemption's effective date

Date format: MM/DD/YY
expirationDate Date Optional

Exemption's expiration date

Date format: MM/DD/YY
certificateNumber String

Required if isAuditable is true

Optional if isAuditable is false

 Exemption's certificate number
customerName String

Required if isAuditable is true

Optional if isAuditable is false

 Exemption's customer name
customerNumber String

Required if isAuditable is true

Optional if isAuditable is false

 Exemption's customer number
isAuditable Boolean Optional

If true and all required metadata is passed, the exemption will be marked as AUDITABLE_COMPLETE and will appear on the Exemptions page in CertManager

If false or if not all required metadata is passed, the exemption will be marked as INITIAL and will appear on the Certificates page in CertManager
isGtdEnabled Boolean Optional

If true and GTD integration is enabled, the exemption will automatically sync with GTD if it is marked as AUDITABLE_COMPLETE in CertManager

If false and GTD integration is enabled, the exemption will not sync with GTD and will have the Not in GTD sync status in CertManager

If not passed, the parameter will default to false
stateCode String Optional Two-letter abbreviation of exemption's state or province
entityUseCode Integer

Required if isAuditable is true

Optional if isAuditable is false

Reason for exemption
notes String

Optional

Notes about the exemption

Example response

{ 
"status": 200, 
"message": "CorrelationId: 1635969967897 - Created Exemption with 
Exemption Id: bf081f84-35d4-4c5e-8d19-80dec9272010", 
"data": { 
"exemptionId": "bf081f84-35d4-4c5e-8d19-80dec9272010" 
}, 
"success": true 
}