Delete

Delete

Use this endpoint to delete any in-progress 1098 Correction returns created in TaxBandits. When deleting, provide unique identifiers such as SubmissionId, RecordId, etc. If only the SubmissionId is provided, all returns associated with that ID will be deleted.

Note:

In the Live environment, returns with a Transmitted or Accepted status cannot be deleted. However, in the Sandbox environment, you can delete returns regardless of their status (Transmitted, Rejected, or Accepted).

DELETE Form1098Correction/Delete 

Run in Postman

Request Params

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

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
Form1098Records	object	Pulls the Form 1098 correction records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 1098 correction 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
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return deleted.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form 1098 correction return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form 1098 correction 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 code
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 code
Name	string	Name of the validation error
Message	string	Description of the validation error

Request Params

"Form1098Correction/Delete?SubmissionId=9b93d963-7ab8-4967-b766-997fa5d63c20&RecordIds=9ecfd957-cd3b-44a2-a08a-326f36c07bef"

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "9b93d963-7ab8-4967-b766-997fa5d63c20",
    "Form1098Records": {
        "SuccessRecords": [
            {
                "SequenceId": "72305",
                "RecordId": "9ecfd957-cd3b-44a2-a08a-326f36c07bef",
                "Status": "DELETED",
                "StatusTs": "2024-12-20 01:18:42 -05:00",
                "OnlineAccess": null,
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}