Skip to main content
Version: 1.7.3

Delete

DELETE Form5498ESA/Delete 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdsGuid[]An unique identifier generated by TaxBandits when a 5498 ESA return is created. Mention the 5498 ESA return's Record ID that you want to delete.

Request Params

"Form5498ESA/Delete?SubmissionId=215e8a7a-bea1-4aaf-8fbc-8cafd6d71db7&Recordids=45612bd4-cab9-4518-aafe-4c267dddb66d"

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
Form5498ESARecordsobjectPulls the Form 5498 ESA records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 5498 ESA 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 5498 ESA 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": "215e8a7a-bea1-4aaf-8fbc-8cafd6d71db7",
"Form5498ESARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "45612bd4-cab9-4518-aafe-4c267dddb66d",
"Status": "DELETED",
"StatusTs": "2023-10-30 07:02:30 -04:00"
}
],
"ErrorRecords": null
},
"Info": null,
"Errors": null
}