Skip to main content
Version: 2.0

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 Reactivate endpoint.
GET business/deactivate 

Request Body

FieldTypeDescription
BusinessIdGUIDsTaxBandits-generated unique identifier of the business
PayerRefStringYour unique identifier for the business.

Response Body

FieldTypeDescription
SuccessRecordsObject []Records that were processed successfully.
BusinessIdGUIDTaxBandits-generated unique identifier of the business.
PayerRefStringYour unique identifier for the business.
StatusStringStatus of the operation.
StatusTsStringDate and time the operation was completed.
ErrorRecordsObject []Records that failed to process.
BusinessIdGUIDIdentifier of the failed business.
PayerRefStringYour unique identifier for the payer.
ErrorsObject []Validation error details.
IdStringValidation error code.
NameStringName of the validation rule that failed.
MessageStringDescription of the error.
Request Json
SampleDescriptionAction
Sample 1
Deactivate a business using BusinessId and PayerRef.
Sample 1
business/deactivate?PayerRefs=ABC123&BusinessIds=fe6b952e-439f-4079-ac6d-92d3e799e903
Response Json
SampleDescriptionAction
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
}