Deactivate
Deactivate
This endpoint temporarily suspends a business without deleting it. Use this when a business is temporarily inactive, undergoing restructuring, or should be paused from filing without losing its history.
You can deactivate multiple businesses in a single API request.
Key Points
- Recipients Unchanged — Once the business is deactivated, the associated recipient details will remain unchanged; however, filings cannot be made until the business is reactivated.
- Reactivation — You can reactivate the business at any time using the
Reactivateendpoint.
GET business/deactivate Request Body
| Field | Type | Description |
|---|---|---|
| BusinessId | GUIDs | TaxBandits-generated unique identifier of the business |
| PayerRef | String | Your unique identifier for the business. |
Response Body
| Field | Type | Description |
|---|---|---|
| SuccessRecords | Object [] | Records that were processed successfully. |
| BusinessId | GUID | TaxBandits-generated unique identifier of the business. |
| PayerRef | String | Your unique identifier for the business. |
| Status | String | Status of the operation. |
| StatusTs | String | Date and time the operation was completed. |
| ErrorRecords | Object [] | Records that failed to process. |
| BusinessId | GUID | Identifier of the failed business. |
| PayerRef | String | Your unique identifier for the payer. |
| Errors | Object [] | Validation error details. |
| Id | String | Validation error code. |
| Name | String | Name of the validation rule that failed. |
| Message | String | Description of the error. |
Request Json
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Deactivate a business using BusinessId and PayerRef. |
Sample 1
business/deactivate?PayerRefs=ABC123&BusinessIds=fe6b952e-439f-4079-ac6d-92d3e799e903
Response Json
| Sample | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. | |
| 400 | Bad Request Response - You'll get the below response when your API requests contain any validation errors. | |
| 300 | Multi-status Response - You'll get the below response when multiple statuses are included. | |
| 401 | Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials. |
{
"SuccessRecords": [
{
"BusinessId": "cb4f2035-7c19-4b24-abfa-18c871ec9acb",
"PayerRef": null,
"Status": "DEACTIVATED",
"StatusTs": "2026-07-07 10:24:31 -04:00"
}
],
"ErrorRecords": null,
"Errors": null
}