Delete

Delete

Use this endpoint to delete any in-progress state withholding forms created in TaxBandits.

Key Points

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

DELETE StateFilings/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
SubmissionId	Guid	Unique identifier of a submission
StateFilingRecords	Object	Pulls withholding or UI records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of withholding or UI Records
BusinessId	Guid	Unique identifier of a Business.
PayerRef	string	Unique identifier of the payer.
RecordId	Guid	Unique identifier of a record
State	string	Returns the State code of the withholding or UI
FormType	string	Returns the Form type
Status	string	Returns the record status.
Errors	object[]	Shows error information of state returns of withholding or UI returns
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
ErrorRecords	object[]	It will show the detailed information about the error status of withholding or UI Records.
BusinessId	Guid	Unique identifier of a Business.
PayerRef	string	Unique identifier of the payer.
RecordId	Guid	Unique identifier of a record
State	string	Returns the State code of the withholding or UI return
FormType	string	Returns the Form type
Status	string	Returns the record status.
Errors	object[]	Shows error information of state returns of withholding or UI
Id	string	Returns the validation error Id.
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 Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request Params

"StateFilings/Delete?SubmissionId=66c6e0c7-251e-4f00-8a75-14b5656a59db&RecordIds=66c6e0c7-251e-4f00-8a75-14b5656a59db"

Response JSON

200

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "019938b1-fa6a-7038-91b6-dcf508f3df88",
  "Errors": null,
  "StateFilingRecords": {
      "SuccessRecords": [
          {
              "BusinessId": "dd4e6842-5d30-4fcf-8a22-a9eea69cac43",
              "PayerRef": null,
              "RecordId": "019938b1-fafe-763f-af35-ea8bf1e81484",
              "State": "SC",
              "FormType": "SC1605",
              "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",
  "SubmissionId": null,
  "StateFilingRecords": 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"
      }
  ]
}