Delete

Delete

Use this endpoint to delete any in-progress new hire reports created in TaxBandits.

Key Points

• When using this, ensure you provide the SubmissionId and the RecordId (Optional). If only the SubmissionId is provided, all reports associated with that SubmissionId will be deleted.
• In the Live environment, reports with a Transmitted or Accepted status cannot be deleted. Whereas, in the Sandbox environment, reports can be deleted regardless of status.

DELETE NewHire/Employee/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 withholding or UI return is created. Mention the withholding or UI return's Record ID that you want to Get.

Response Body

Field	Type	Description
BusinessId	Guid	Unique Identifier of the business
PayerRef	string	Unique identifier of the payer.
NewHireRecords	object	Returns detailed information of the NewHire form records.
SuccessRecords	object[]	It will show the detailed information about the success status of New Hire Form Records.
SubmissionId	Guid	Unique identifier of a submission.
RecordId	Guid	Unique identifier of a record
EmployeeId	Guid	Unique Identifier of the business
EmpRef	string	Unique identifier of the payer.
ReportingState	string	Reporting state.
Status	string	Returns the status of the 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.
ErrorRecords	object[]	It will show the detailed information about the error status of NewHire 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.

Request Params

"newhire/employee/Delete?RecordIds=66c6e0c7-251e-4f00-8a75-14b5656a59dba&SubmissionId=01993cc2-65a7-749f-ae9f-11228a524981"

Response JSON

200

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "01993cc2-65a7-749f-ae9f-11228a524981",
  "BusinessId": "07e6d7d9-5463-43d2-a272-14dc563cb5e0",
  "PayerRef": null

  "Errors": null,
  "NewHireRecords": {
      "SuccessRecords": [
          {
              "RecordId": "01993cc2-67a6-72ba-91d7-3e21e6ed3310",
              "EmployeeId": "b3a91620-d26c-421e-95c6-1176522f105a",
              "EmpRef": "2344",
              "ReportingState": "SC",
              "Status": "DELETED",
              "Errors": null
          }
      ],
      "ErrorRecords": null
  },
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "StatusCode": "400",
  "StatusName": "BadRequest",
  "StatusMessage": "Validation error has occurred",
  "BusinessId": null,
  "PayerRef": null,
  "SubmissionId": "",
  "NewHireRecords": null,
  "Errors": [
      {
          "Id": "S00-000097",
          "Name": "SubmissionId",
          "Message": "SubmissionId is required."
      }
  ]
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100018",
          "Name": "Authorization",
          "Message": "JWT EXPIRED"
      }
  ]
}