Delete

DELETE Form5498/Delete 

Request Params

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

Request Params

"Form5498/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
Form5498Records	object	Pulls the Form 5498 records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 5498 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 5498 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

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
}