Delete

You can use this endpoint to delete the BOI reports created in TaxBandits. You must include the SubmissionId or Report Number in your request JSON to refer to the corresponding reports.

note

Transmitted BOI reports cannot be deleted.

DELETEBOIR/Delete

Request Params

Field	Type	Description
SubmissionId	Guid	Provide the SubmissionId (unique identifier created by TaxBandits for a submission) to identify which submission needs to be deleted. Either SubmissionId or ReportNumber can be provided to delete a report
ReportNumber	string	Provide the ReportNumber (unique identifier created by TaxBandits for a report) to identify which report needs to be deleted.

Request Params

Sample 1

Request using SubmissionId.

BOIR/Delete?SubmissionId=954cdad5-3b8a-4123-9052-8beba4be5376

Sample 2

Request using ReportNumber.

BOIR/Delete?ReportNumber=109685

Response Json

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	Returns the SubmissionId of the report.
ReportNumber	number	Returns the Report Number for which the request was made.
ReportType	string	The type of the report created in the submission.
BOIRRecords	object	Pulls BOIR records with Success and Error statuses.
SuccessRecords	Object	It will show the detailed information about the success status of BOI Report.
ReportStatus	String	Returns the status of the report.
CreatedTs	String	Returns created date and time.
UpdatedTs	String	Returns updated date and time.
ErrorRecords	object[]	It will show the detailed information about the errored status.
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node wither SubmissionId or ReportNumber.
Message	string	Shows the description of the error message.
Errors	object[]	Object that provides the collection of error information in the request
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the description of the error message.

Response json

200

This is a sample response for successful API requests.

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "3e9169b8-533b-4083-9b94-c26b3741bb87",
  "ReportNumber": "110638",
  "ReportType": "INITIAL",
  "BOIRRecords": {
    "SuccessRecords": {
      "ReportStatus": "DELETED",
      "CreatedTs": "2024-08-14T10:41:44.579Z",
      "UpdatedTs": "2024-08-14T10:41:47.967Z"
    },
    "ErrorRecords": null
  },
  "Errors": null
}

400

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

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
    "SubmissionId": "69a8f032-db2b-45bc-a5f8-f96daeb91034",
    "ReportNumber": "110692",
    "ReportType": "INITIAL",
    "ReportStatus": "TRANSMITTED",
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1655",
            "Name": "SubmissionId",
            "Message": "Report already transmitted cannot be deleted"
        }
    ]
}

401

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-100026",
            "Name": "Authorization ",
            "Message": "Authorization Failed"
        }
    ]
}

404

You'll get the below response if your API request contains a record that's not found in our database.

{
    "StatusCode": 404,
    "StatusName": "NotFound",
    "StatusMessage": "The resource you have specified cannot be found",
    "SubmissionId": "fe061e50-1fbc-41d2-bad8-f1970d74ed9",
    "ReportNumber": "110483",
    "ReportType": null,
    "ReportStatus": null,
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1622",
            "Name": "ReportNumber",
            "Message": "Invalid Report Number"
        }
    ]
}