To retrieve the details for a specific report, use the following URL and the GET method:

{service_url}/api/v3/reports/{uuid}

Here, {service_url} is the URL of the sandbox or production environment, and {uuid} is the universally unique identifier of the report.

Example:

https://reporting-api.marketplace.taxamo.com/api/v3/reports/ABcasdaw%5B%5Dpdqweqwescasad

Details

Endpoint	Method
`/api/v3/reports/{uuid}`	GET

Input parameters

Field	Description
`uuid`	The universally unique identifier of the report.

Output parameters

Field	Type	Pattern	Description
`presigned-url`	String	—	The pre-signed URL for the report, if available.
`started-timestamp`	String	—	The date and time when report processing started.
`report-type`	String	—	The report type. Possible values are `Audit` and `Tax-ID`.
`filename`	String	—	The name of the report file.
`status`	String	—	The report status. Possible values are `Queued`, `Done`, `Failed` or `Processing`.
`created-timestamp`	String	`$date-time`	The date and time when the report was created. This is the time when report processing is complete.
`error-message`	String	—	If report generation failed, the error message.
`uuid`	String	`$uuid`	The universally unique identifier of the report.
`parameters`	String	—	See Schedule Reports Input Parameters.
`finished-timestamp`	String and Null	—	The date and time when report processing finished.

Request example

curl --request GET \
     --url https://reporting-api.marketplace.taxamo.com/api/v3/reports/ABcasdaw%5B%5Dpdqweqwescasad \
     --header 'accept: application/json'

Response example

{
  "presigned-url": "string",
  "started-timestamp": "2024-11-05T14:15:16.730Z",
  "report-type": "Audit",
  "filename": "string",
  "status": "Queued",
  "created-timestamp": "2024-11-05T14:15:16.730Z",
  "error-message": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "parameters": {
    "format": "csv",
    "product-classes": "SPDSSSSPDDDDPSSPSPDPSDSSDPDPPDSPDDSDSPDSSDDDSDSPPSSSDPDDSDSDPSDDP",
    "fx-source": "string",
    "tax-country-subdivision-code": "Ik-an",
    "end-month": "8986-75",
    "tax-country-code": "st",
    "currency-code": "hfv",
    "fx-date-type": "day",
    "tax-region-key": "XA",
    "start-month": "6332-63",
    "report-scope": "full",
    "transaction-type": "sale",
    "fx-date-field": "tax-timestamp"
  },
  "finished-timestamp": "2024-11-05T14:15:16.731Z"
}