Delete
DELETE Form1097BTC/Delete
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
RecordId | Guid | An 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
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 |
Form1097BTCRecords | object | Pulls the Form 1097-BTC records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1097-BTC Records. |
SequenceId | string | A unique number 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 1097-BTC 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. |
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. |
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
}