Skip to main content
Version: 1.7.3

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 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]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

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form1098TRecordsobjectPulls the Form 1098-T records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1098-T 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 1098-T Records.
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": "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
}