GET DeletionRequestStatus
Description
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.
Endpoint
• Endpoint: <environment base url>/v1.0/api/Forms/DeletionRequestStatus
• Method: GET
Request Structure
| Parameter | Type | Required |
|---|---|---|
| id | String | Yes |
Response Structure
{
"data": {
"deletionStatus": "string"
}
} `
Deletion Status -- Possible Values
| Code | Value |
|---|---|
| 1 | In Process |
| 2 | Completed |
API Contract
- The same X-Request-ID sent on the delete request should be provided in the "id" parameter, and the status of the corresponding deletion process is returned.
- During the deletion of the tax items, status 1 (In Process) is returned.
- Only at the end of the deletion process will status 2 (Completed) is returned.
- Error messages for specific tax items with errors or warnings will not be returned as it may considerably increase the payload size, impacting the HTTP request performance.
- "deletionStatus" is a mandatory attribute in the response structure.
Sample Response
{
"data": {
"deletionStatus": "IP"
}
}
Sample request [CURL]
curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/TaxItemsDeleteStatus?deleteRequestID=BE8F18D7-3D12-411D-AD30-D1FEBFF0B7D2' \
--header 'Authorization: Bearer <access_token_value>'