Delete

Use this endpoint to delete any in-progress 1042-S 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  Form1042S/Delete 

Request Params

Field	Type	Description
SubmissionId	Guid	Mention the 1042-S returns Submission ID that you want to delete.
RecordIds	Guid[]	Mention the 1042-S returns Record ID that you want to delete. Multiple RecordIds under the same Submission can be deleted by sending the RecordIds comma separated.

Request Params

"Form1042S/Delete?SubmissionId=462a5651-1b92-4093-8eb2-8845dcc7929e&RecordIds=27227762-0981-4f3b-b115-1aed8671e478"

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
Form1042SRecords	object	Pulls the Form 1042-S records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 1042-S 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 1042-S Records.
SequenceId	string	A unique number given by an inbound application to identify failed records
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

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "462a5651-1b93-4093-8eb2-8845dcc7929e",
    "Form1042SRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "27227762-0981-4f3b-b115-1aed8671e478",
                "Status": "DELETED",
                "StatusTs": "2024-06-21 02:04:44 -04:00",
                "OnlineAccess": null,
                "Postal": null
            }
        ],
        "ErrorRecords": null
    },
    "Info": null,
    "Errors": null
}