Skip to main content
Version: 1.7.1

Delete

Deletes 940 returns by Submission Ids and Record Ids.

If you need to delete the Transmitted or Accepted status records in Sandbox, you can contact our developer@taxbandits.com.

DELETE Form940/Delete 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission.
RecordIdsstringList of record Ids to be deleted.

Request Params

"Form940/Delete?SubmissionId=4e38f23b-ff52-4cb7-8b43-c2d4fcf90be7&RecordIds=289f3cbf-040c-4e77-8803-6eff6148375e"

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.
Form940RecordsobjectPulls the Form 940 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 940 Records.
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 940 Records
        RecordIdGuidUnique identifier of a record.
        SequencestringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "4e38f23b-ff52-4cb7-8b43-c2d4fcf90be7",
"Form940Records": {
"SuccessRecords": [
{
"Sequence": "",
"RecordId": "289f3cbf-040c-4e77-8803-6eff6148375e",
"RecordStatus": "DELETED",
"CreatedTs": "8/6/2019 1:46:16 AM",
"UpdatedTs": "8/6/2019 1:47:13 AM"
}
],
"ErrorRecords": null
},
"Errors": null
}