Skip to main content
Version: 1.7.1

Delete

Delete

Use this endpoint to delete any in-progress W2 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 FormW2/Delete 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidMention the W2 returns Submission ID that you want to delete.
RecordIdsGuidMention the W2 returns Record ID that you want to delete. Multiple RecordIds under the same Submission can be deleted by sending the RecordIds comma separated.

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
FormW2RecordsobjectPulls the Form W-2 records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2 Records
        SequenceIdstringAn 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.
        RecordIdGuidUnique identifier of a record
        StatusstringReturns the status of the records.
        StatusTsstringDate and time of return deleted.
        StateReturnsobject[]Returns the state code and return status.
            StateCodestringReturns the code of the state.
            RecordStatusstringReturns the status of the records.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2 Records.
        RecordIdGuidUnique identifier of a record
        SequenceIdstringAn 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.
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error
Request Params
"FormW2/Delete?SubmissionId=3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465&RecordIds=212a2a80-f74a-4af9-b034-782e8650fe37,50013b2d-01ff-41b1-b08b-dbf8940a8a7c"
Response Json
ResponseDescriptionAction
200
Success Response - This is a sample response for successful API requests.
Response: 200
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465",
"FormW2Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "212a2a80-f74a-4af9-b034-782e8650fe37",
"Status": "DELETED",
"StatusTs": "2021-08-05 09:53:23 -04:00",
"StateReturns": null
},
{
"SequenceId": "1",
"RecordId": "50013b2d-01ff-41b1-b08b-dbf8940a8a7c",
"Status": "DELETED",
"StatusTs": "2021-08-05 09:53:23 -04:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}