Skip to main content
Version: 1.7.0

Delete

Deletes Form W2-G return created in TaxBandits. Transmitted forms cannot be deleted.

If you need to delete the Transmitted or Accepted status records in Sandbox, you can contact our developer@taxbandits.com.

DELETE FormW2G/Delete 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]An unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Record ID that you want to delete.

Request Params

"FormW2G/Delete?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=15c3caa6-8402-4548-8713-4fcdd2f7d42d"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form1099RecordsobjectPulls the Form W2-G records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2-G Records
        SequenceIdstringA unique number is given by an inbound application to identify failed records
        RecordIdGuidUnique identifier of a record
        StatusstringReturns the status of the records.
        StatusTsstringDate and time of return deleted.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2-G Records.
        SequenceIdstringA unique number given by an inbound application to identify failed records
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error code
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error code
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
"Status": "DELETED",
"StatusTs": "2021-08-05 06:26:16 -04:00"
},
{
"SequenceId": "2",
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Status": "DELETED",
"StatusTs": "2021-08-05 06:26:16 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}