GET UploadRequestStatus

Description

This API endpoint allows users to retrieve the status of a specific upload process and obtain detailed error messages for any tax items that may have inconsistencies. By querying this endpoint, users can monitor the progress of their upload requests, identify any tax items that failed to upload correctly, and access error messages to troubleshoot and resolve issues effectively. This functionality facilitates seamless data management and ensures the integrity of tax item uploads within the system.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/UploadRequestStatus

• Method: GET

Request Parameters

Parameter Type Required
id String Yes

Response Structure

{
  "data": {
    "uploadStatus": "string",
    "message": "string",
    "totalNumberOfLines": int,
    "itemsWithMessages": [
      {
        "companyCode": "string",
        "documentNumber": "string",
        "fiscalYear": "string",
        "itemNumber": "string",
        "message": "string",
        "itemStatus": "string"
      }
    ]
  }
} `

Upload Status -- Possible Values

Code Value
1 In Process
2 Completed
3 Failed

Item Status -- Possible Values

Code Value
E Error
W Warning

API Contract

  • The same X-Request-ID sent on the Upload request should be provided in the "id" parameter, and the status of the corresponding upload process is returned.

  • If the upload processing is incomplete, status 1 (In Process) is returned.

  • If the upload processing is completed, status 2 (Completed) is returned.

  • If the upload processing is completed and there are errors/warnings at a tax item level, status 2 (Completed) is returned with the item key and corresponding error message under "itemsWithMessages."

  • If the upload processing is completed and there are errors on the request level, such as invalid format or missing required column, status 3 (Failed) is returned with a message describing the error.

  • Items processed successfully are not returned in the response body. If the file upload was successfully processed, the combination of status 2 (Completed) and the empty list of "itemsWithMessages" will indicate that all items have been successfully processed.

  • "uploadStatus" is always return in the response structure it reflects the overall status of a previous upload request.

  • "itemStatus" will be provided for each tax item on the uploaded file if an error or a warning message is captured during processing.

  • Sample Response

{
    "data": {
        "uploadStatus": "UF",
        "message": null,
        "totalNumberOfLines": 0,
        "itemsWithMessages": null
    }
}

Sample request [CURL]

curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/TaxItemsStatus?uploadRequestID=FB19EA86-9E12-4DB3-928E-00006A416099' \
--header 'Authorization: Bearer <access_token_value>'