Skip to main content
Version: 1.7.3

Delete

DELETE Form1097BTC/Delete

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdGuidAn unique identifier generated by TaxBandits when a 1097-BTC return is created. Mention the 1097-BTC return's Record ID that you want to delete.

Request Params

"Form1097BTC/Delete?SubmissionId=944dc61f-54e7-41e3-a736-d16de592dd19&RecordIDs=62016798-8c0b-46b6-840d-d041ce05a83d"

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
Form1097BTCRecordsobjectPulls the Form 1097-BTC records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1097-BTC Records.
        SequenceIdstringA unique number 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 1097-BTC 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.
        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

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "944dc61f-54e7-41e3-a736-d16de592dd19",
"Form1097BTCRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "62016798-8c0b-46b6-840d-d041ce05a83d",
"Status": "DELETED",
"StatusTs": "2024-11-13 17:52:57 +05:30",
"OnlineAccess": null,
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Info": null,
"Errors": null
}