Delete

Deletes Form 1098 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  Form1098/Delete 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a 1098 return is created. Mention the 1098 return's Record ID that you want to delete.

Request Params

"Form1098/Delete?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b,eb39714e-f653-4c4d-a53c-07f24f9a9dj5"

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
Form1098Records	object	Pulls the Form 1098 records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 1098 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 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": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
   "Form1098Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
               "Status": "DELETED",
               "StatusTs": "2021-08-05 06:26:16 -04:00"
           },
           {
               "SequenceId": "2",
               "RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
               "Status": "DELETED",
               "StatusTs": "2021-08-05 06:26:16 -04:00"
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}