Delete
Delete
Use this endpoint to delete any in-progress 1099-G 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 Form1099G/Delete Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-G 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 |
| Form1099Records | object | Pulls the Form 1099-G records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099-G Records |
| SequenceId | string | A unique number is 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 1099-G 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 |
Payload
Node.js
Python
Java
.NET C#
Response Json
Delete an existing form 1099-G return for the given SubmissionId and RecordId.
"Form1099G/Delete?SubmissionId=daea186d-9d01-4978-ab2b-534085ae5a6e&RecordIds=0b04d901-077f-4757-83de-3377eeb1d4be"
Response Json
| Response | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. |
Response: 200
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "daea186d-9d01-4978-ab2b-534085ae5a6e",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "0b04d901-077f-4757-83de-3377eeb1d4be",
"Status": "DELETED",
"StatusTs": "2021-11-24 09:30:29 -05:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}