List Reports
Use this request to list reports.
To list the scheduled reports, use the following URL and the GET method:
{service_url}/api/v3/reports?limit={limit}=1&status={status}&report_type={report_type}&created_after={created_after}Here, {service_url} is the URL of the sandbox or production environment, {limit} is the number of reports in the response, {status} is the report status, {report_type} is the type of report, and {created_after} lists all reports created on and after this date.
Example:
https://reporting-api.marketplace.taxamo.com/api/v3/reports?limit=5&offset=1&status=Done&report_type=Audit&created_after=2026-01-15Details
| Endpoint | Method |
|---|---|
/api/v3/reports | GET |
Input parameters
| Field | Type | Pattern | Description |
|---|---|---|---|
{limit} | Number | — | The number of reports to include in the response. Defaults to 10. |
{offset} | Number | — | The number of reports to skip for pagination. Defaults to 0. |
{status} | String | — | The report status. Possible values are Queued, Done, Failed or Processing. |
{report_type} | String | — | The report type. Possible values are Audit and Tax-ID. |
{created_after} | String | yyyy-MM-dd | Lists reports created on or after this date. |
{created_before} | String | yyyy-MM-dd | Lists reports created on or before this date. |
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?limit=5&offset=1&status=Done&report_type=Audit&created_after=2026-01-15' \
--header 'accept: application/json'
Response example
{
"reports": [
{
"presigned-url": "string",
"started-timestamp": "2024-11-05T13:34:58.581Z",
"report-type": "Audit",
"filename": "string",
"status": "Queued",
"created-timestamp": "2024-11-05T13:34:58.581Z",
"error-message": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parameters": {
"format": "csv",
"product-classes": "PSSPPDPDPDSPDDDDPDSSPSPSDDDPPPDPPDPDDDDDDPPPDSPPDDSDDPDPPDDSDPDSSSPPPPSSPSSSSPDDPSPDDPD",
"fx-source": "string",
"tax-country-subdivision-code": "yg-x_",
"end-month": "7574-69",
"tax-country-code": "st",
"currency-code": "daH",
"fx-date-type": "day",
"tax-region-key": "PR",
"start-month": "3200-88",
"report-scope": "full",
"transaction-type": "sale",
"fx-date-field": "tax-timestamp"
},
"finished-timestamp": "2024-11-05T13:34:58.582Z"
},
{
"presigned-url": "string",
"started-timestamp": "2024-11-05T13:34:58.582Z",
"report-type": "Tax-ID",
"filename": "string",
"status": "Queued",
"created-timestamp": "2024-11-05T13:34:58.582Z",
"error-message": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parameters": {
"tax-ids": [
"string"
],
"region-keys": [
"LF",
"unknown"
],
"validation-statuses": [
"syntax-valid-full-valid-cache-not-used"
],
"result-changed": true,
"start-month": "0424-68",
"end-month": "2044-56"
},
"finished-timestamp": "2024-11-05T13:34:58.582Z"
}
]
}Updated 14 days ago
Did this page help you?
