Delete
Delete
Use this endpoint to delete any in-progress 941 returns created in TaxBandits. When deleting, provide unique identifiers such as SubmissionId, RecordId, etc. If only the SubmissionId is provided, all returns associated with that ID will be deleted.
Note:
In the Live environment, returns with a Transmitted or Accepted status cannot be deleted. However, in the Sandbox environment, you can delete returns regardless of their status (Transmitted, Rejected, or Accepted).
DELETE Form941/Delete Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | List of record Ids to be deleted. |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
| StatusName | string | Name of the status code. |
| StatusMessage | string | Detailed status message. |
| Form941Records | object | Pulls the Form 941 records with Success and Error statuses. |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Records. |
| SequenceId | string | A unique number given by an inbound application to identify failed records. |
| RecordId | Guid | Unique identifier of a record. |
| RecordStatus | string | Returns the status of the records. |
| CreatedTs | string | Date and time of return created. |
| UpdatedTs | string | Date and time of return updated. |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Records. |
| SequenceId | string | A unique number given by an inbound application to identify failed records. |
| RecordId | Guid | Unique identifier of a record. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request Params
Delete an existing form 941 return for the given SubmissionId and RecordId.
"Form941/Delete?SubmissionId=fb18e869-e27b-4226-8ac0-1e9f5949cfa7&RecordIds=0496482c-64b6-47f0-875b-469b28e90055"
Response JSON
Based on the SubmissionId, the response will delete the returns under the specified RecordId.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form941Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "0496482c-64b6-47f0-875b-469b28e90055",
"RecordStatus": "DELETED",
"CreatedTs": "2022-03-02 03:59:28 -04:00",
"UpdatedTs": "2022-03-02 04:00:22 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}