Request information
- HTTP method: PUT
-
URL (replace exemptionId with the unique exemption ID received in the response when creating the exemption)
- CertManager UAT: https://certmanager-uat.sovos.com/api/pre-auth/v3/certificates/exemptions/exemptionId
- CertManager Production: https://certmanager.sovos.com/api/pre-auth/v3/certificates/exemptions/exemptionId
Request fields
Because the HTTP PUT request replaces the current customer information with the information passed in the request, you must include all fields relevant to that customer in the request body — even the fields that are not being updated. If you do not pass a field, the API replaces the current value with a null value. For example, if an exemption has an image but you do not include the imageId field in your request body, the image will no longer be associated with the exemption.
| Field | Data type | Required or optional | Description |
| effectiveDate | String | Required |
Exemption's effective date Date format: MM/DD/YYYY |
| entityUseCode | Integer | Optional | 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 |
|
| 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 |
| 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 |
Example request
{
"effectiveDate": "03/07/2025",
"imageId": "8df30106-3951-494e-9e65-9d19d56b89e",
"customerId": "61d27cff-0a06-4ced-a9f2-999939f78e49",
"entityUseCode": 365,
"certificateNumber": "43914",
"jurisdictionId": 294,
"applyToSubJurisdictions": true,
"isInherited": false,
"skus": [],
"notes": null
}
Example response
{
"status": 200,
"message": "Edited Exemption",
"data": {
"id": "b9505011-e341-40a6-8d24-2680c912db5f",
"creationDate": 1745259919538,
"applyToSubJurisdictions": false,
"certificateNumber": "48081180",
"creationBy": "user@sovos.com",
"effectiveDate": 1737504000000,
"entityUseCode": {
"entityUseCode": 1,
"entityUseName": "AGRI - Agriculture",
"description": "Agriculture"
},
"exemptionCustomers": [
{
"customerId": "02116848-8fc3-4d67-9994-de1003c4e22a",
"customerName": "Customer",
"customerNumber": "30531132",
"synced": false
}
],
"expirationDate": 1927670400000,
"inherited": false,
"jurisdiction": {
"jurisdictionId": 294
"name": "ALABAMA",
"isoCode": "AL",
"type": 2,
"parentJurisdictionId": 227
},
"orgId": "2eb8930a-f56c-4961-9c3e-f8a9c8181f65",
},
"success": true
}