SureTax Returns API

GET Tax Items Delete Request Status

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint provides users with the status of the deletion process for tax items, along with any associated error messages. While not mandatory, it offers valuable insight into the progress and outcome of deletion operations initiated within the system. Users can utilize this endpoint to monitor the status of deletion requests, identify any errors or issues encountered during the process, and take appropriate actions as needed.

OperationId: GET Tax Items Delete Request Status

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/TaxItemsDeleteRequestStatus

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Id*	id	string

*Mandatory parameter

TaxItemsDeleteRequestStatusResponse

OVERVIEWEXAMPLE

Overview

Response object for delete status of for tax item.

TaxItemsDeleteRequestStatusResponse

Display Name	Field Name	Field Type
Data	data	array[TaxItemsDelete]

TaxItemsDelete

Display Name	Field Name	Field Type
Deletion Status	deletionStatus	string

Example Response

The following is an example response you can expect for this operation

{
  "data": [
    {
      "deletionStatus": "1"
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API response contains the status for a deletion process. Success Response - 200 OK. The API will respond with the current status of the process.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/TaxItemsDeleteRequestStatus

Add Request Headers: