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.
DELETE FormW2C/Delete
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a W2C return is created. Mention the W2C 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 |
FormW2CRecords | object | Pulls the Form W-2C records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form W2C 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. |
StateReturns | object[] | Returns the state code and return status. |
StateCode | string | Returns the code of the state. |
RecordStatus | string | Returns the status of the records. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form W2C Records. |
RecordId | Guid | Unique identifier of a record |
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. |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error id |
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 Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
FormW2C/Delete?SubmissionId=3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465&RecordIds=212a2a80-f74a-4af9-b034-782e8650fe37,50013b2d-01ff-41b1-b08b-dbf8940a8a7c
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
}