Delete
Delete
This endpoint can be used to delete any in-progress W-2G correction forms created in TaxBandits.
Key points
- When using this, ensure you provide unique identifiers, such as SubmissionId, RecordId, etc.
- If only the SubmissionId is provided, all returns associated with that SubmissionId will be deleted.
- In the Live environment, returns with a Transmitted or Accepted status cannot be deleted. Whereas, in the Sandbox environment, returns can be deleted regardless of status (Transmitted, Rejected, or Accepted).
DELETE FormW2GCorrection/Delete Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | A unique identifier generated by TaxBandits when a W-2G correction return is created. Mention the W-2G correction 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 W-2G correction records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form W-2G correction 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 |
| Status | string | Returns the status of the records. |
| StatusTs | string | Date and time of return deleted. |
| OnlineAccess | object | Returns the Email address for whom the online access to be given and Status of online access. |
| Status | string | Returns status of online access for Form W-2G correction return. |
| string | Email address for whom the online access to be given. | |
| Info | string | Information about the online access service. |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form W-2G correction 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
"FormW2GCorrection/Delete?SubmissionId=94677293-8ecf-443b-8a76-8b8d192b2cb1&RecordIds=97c9ba31-c244-4aeb-addc-f1b53be373fc"
Response Json
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "94677293-8ecf-443b-8a76-8b8d192b2cb1",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "97c9ba31-c244-4aeb-addc-f1b53be373fc",
"Status": "DELETED",
"StatusTs": "2025-12-01 06:04:33 -05:00",
"StateReturns": null,
"OnlineAccess": null,
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}