The V3 API supports multi-jurisdictional exemptions and metadata-only exemptions that do not require image PDFs.
Request information
- HTTP method: POST
-
URL
- CertManager UAT: https://certmanager-uat.sovos.com/api/pre-auth/v3/certificates/exemptions
- CertManager Production: https://certmanager.sovos.com/api/pre-auth/v3/certificates/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 |
effectiveDate | String | Required |
Exemption's effective date Date format: MM/DD/YYYY |
entityUseCode | Integer | Required | Reason for exemption |
customerId | String | Required | The unique customer ID received in the response when creating or updating a customer |
isInherited | Boolean | Optional | |
applyToSubJurisdictions | Boolean | Required |
If true, the exemption will apply to subjurisdictions If false, the exemption will not apply to subjurisdictions |
imageId | String | Optional | The unique image ID received in the response when creating an image |
incompleteReasons | Array of objects | Optional | |
skus | Array of objects | Optional |
|
jurisdictions | Array of objects | Required | |
notes | String | Optional | Notes about the exemption |
incompleteReasons fields
Field |
Data type |
Required or optional |
Description |
incompleteReasonId | Integer | Optional | Reason for incomplete |
skus fields
Field |
Data type |
Required or optional |
Description |
sku | String | Optional | SKU |
isInclude | Boolean | Optional |
If true, the SKU is included in the exemption If false, the SKU is excluded from the exemption |
jurisdictions fields
Field |
Data type |
Required or optional |
Description |
jurisdictionId | String | Required | The ID for a specific taxing jurisdiction (TJID) |
certificateNumber | String | Required | The number of the certificate that applies to this jurisdiction |
expirationDate | String | Optional |
Exemption's expiration date Date format: MM/DD/YYYY |
Example request
{
"effectiveDate": "03/07/2025",
"notes": "notes about the exemption",
"entityUseCode": 2052402,
"customerId": "61d27cff-0a06-4ced-a9f2-999939f78e49",
"isInherited": false,
"applyToSubJurisdictions": true,
"imageId": "8df30106-3951-494e-9e65-9d19d56b89e8",
"duplicateExemptions": [],
"creationBy": "username@sovos.com",
"incompleteReasons": [
{
"incompleteReasonId": 1022
}
],
"skus": [
{
"sku": "111222",
"isInclude": true
}
],
"jurisdictions": [
{
"certificateNumber": "31431",
"expirationDate": "03/25/2025",
"jurisdictionId": 287
}
]
}
Example response
{
"status": 201,
"message": "Created Exemption(s)",
"data": [
{
"id": "bda9f1d7-945b-4fa0-871e-3ce884c29768",
"creationDate": 1745258804354,
"applyToSubJurisdictions": true,
"certificateNumber": "4821480",
"creationBy": "user@sovos.com",
"effectiveDate": 1745280000000,
"entityUseCode": {
"entityUseCode": 1,
"entityUseName": "AGRI - Agriculture",
"description": "Agriculture"
},
"exemptionCustomers": [
{
"customerId": "16297116-5714-4d56-9b94-5f013cf474d6",
"customerName": "Customer",
"customerNumber": "388502",
"synced": false
}
],
"expirationDate": 1767139200000,
"inherited": false,
"jurisdiction": {
"jurisdictionId": 294
"name": "ALABAMA",
"isoCode": "AL",
"type": 2,
"parentJurisdictionId": 227
},
"notes": "notes about exemption",
"orgId": "2eb8930a-f56c-4961-9c3e-f8a9c8181f65",
"skus": [
{
"id": "fceb9324-c906-4b25-986b-5f7ae87bb934",
"isInclude": true,
"sku": "83503526"
}
]
}
],
"success": true
}