Delete
DELETE Form5498SA/Delete
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 5498 SA return is created. Mention the 5498 SA return's Record ID that you want to delete. |
Request Params
"Form5498SA/delete?SubmissionId=a4c5f341-bbce-43bb-bc36-636aa0bc7d0b&RecordId=b35cc4ec-71ae-4286-98d1-834e44dcf5b2"
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 |
Form5498SARecords | object | Pulls the Form 5498 SA records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 5498 SA 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 5498 SA 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": "02cb3594-5bc9-4e61-8d2b-1a8117139915",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "16cfee8a-b311-4945-8dd8-1644053209fc",
"Status": "DELETED",
"StatusTs": "2023-11-01 03:15:33 -04:00"
}
],
"ErrorRecords": null
},
"Info": null,
"Errors": null
}