Delete
Delete
Use this endpoint to delete any in-progress 1099-SA 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 Form1099SA/DeleteRequest Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission. |
| RecordId | Guid | An unique identifier generated by TaxBandits when a 1099 SA return is created. Mention the 1099 SA return's Record ID that you want to delete. |
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 |
| SubmissionId | Guid | Unique identifier of a submission |
| Form1099SARecords | object | Pulls the Form 1099SA records with Success and Error statuses. |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099SA Records. |
| SequenceId | string | A unique number given by an inbound application to identify failed records. |
| RecordId | Guid | Unique identifier of a record. |
| Status | string | Returns the status of the records. |
| StatusTs | string | Date and time of return deleted. |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099SA Records. |
| SequenceId | string | An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
| RecordId | Guid | Unique identifier of a record. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error Id. |
| 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 Id . |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request Params
Form1099SA/Delete?SubmissionId=f2de97de-c8de-45d5-bc60-9728b4a35abe&RecordIDs=f7b408fb-6e2a-443e-9214-ee0101f00ed6
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": null,
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "f7b408fb-6e2a-443e-9214-ee0101f00ed6",
"Status": "DELETED",
"StatusTs": "2024-01-11 00:26:16 -05:00",
"StateReturns": null,
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Info": null,
"Errors": null
}