GET UploadHistory

Description

This API endpoint retrieves the list of X-Request-IDs associated with previous Upload requests. Each X-Request-ID serves as a unique identifier for an individual upload request, allowing users to track and reference past interactions with the system. By accessing the Upload history, users can review and manage the history of their data uploads, facilitating organization and accountability within the system.

ALT

Endpoint

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

• Method: GET

Request Structure

Parameter Type Required
externalReportingEntity String Yes
uploadedFromDate String Yes
uploadedToDate String No

Response Structure

{
  "data": [
    {
      "uploadRequestID": "string",
      "uploadStatus": "string"
    }
  ]
} `

API Contract

  • uploadedFromDate and uploadedToDate
  • The date format is yyyy-mm-dd.
  • If uploadedToDate is not passed, only requests for uploadedFromDate are considered (one-day period).
  • The maximum period range for queries is one year.
  • The values of the uploadStatus on the response is the same as the ones described on the UploadRequestStatus endpoint.

Sample Response

{
    "data": null
}

Sample request [CURL]

curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/UploadHistory?externalReportingEntity=A000470001&uploadedFromDate=20231001&uploadedToDate=20240630' \
--header 'Authorization: Bearer <access_token_value>'