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
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | string | Unique identifier of a submission. |
RecordIds | string | List of record Ids to be deleted. |
Request Params
"Form940/Delete?SubmissionId=4e38f23b-ff53-4cb7-8b43-c2d4fcf90be7&RecordIds=289f3cbf-040c-4e77-8803-6eff6148375e"
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. |
Form940Records | object | Pulls the Form 940 records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 940 Records. |
Sequence | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record. |
RecordStatus | string | Returns the status of the records. |
CreatedTs | string | Date and time of return created. |
UpdatedTs | string | Date and time of return updated. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 940 Records |
RecordId | Guid | Unique identifier of a record. |
Sequence | string | A unique number given by an inbound application to identify failed records. |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type of validation error. |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type 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
}