Skip to main content
Version: 1.7.3

Delete

Delete API Endpoint, as the name suggests, is used to delete the Tax Return that was created. Once the return is transmitted, the tax return can not be deleted.

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

DELETE FormW2C/Delete 
Run in Postman

Request Params

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

Request Params

"FormW2C/Delete?SubmissionId=3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465&RecordIds=212a2a80-f74a-4af9-b034-782e8650fe37,50013b2d-01ff-41b1-b08b-dbf8940a8a7c"

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
FormW2CRecordsobjectPulls the Form W-2C records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2C 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 W2C 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

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465",
"FormW2CRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "212a2a80-f74a-4af9-b034-782e8650fe37",
"Status": "DELETED",
"StatusTs": "2019-08-05 09:53:23 -04:00",
"StateReturns": null
},
{
"SequenceId": "1",
"RecordId": "50013b2d-01ff-41b1-b08b-dbf8940a8a7c",
"Status": "DELETED",
"StatusTs": "2019-08-05 09:53:23 -04:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}