Delete
Deletes Form 1098-T 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 Form1098T/Delete
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1098-T return is created. Mention the 1098-T return's Record ID that you want to delete. |
Request Params
"Form1098T/Delete?SubmissionId=2525f35c-da24-4824-a9c1-ea5a53da5590&RecordIds=fe917a04-f45c-426b-887e-c5433d3149d4"
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 |
Form1098TRecords | object | Pulls the Form 1098-T records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1098-T Records |
SequenceId | string | A unique number is given by an inbound application to identify failed records |
RecordId | Guid | Unique identifier of a record |
Status | string | Returns the status of the records. |
StatusTs | string | Date and time of return deleted. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1098-T Records. |
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 |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "2525f35c-da24-4824-a9c1-ea5a53da5590",
"Form1098TRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "fe917a04-f45c-426b-887e-c5433d3149d4",
"Status": "DELETED",
"StatusTs": "2024-06-27 06:08:33 -04:00",
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Info": null,
"Errors": null
}