This request retrieves the reports you created and scheduled with the Schedule Report request.

Details

Endpoint	Method
`/api/v3/reports`	GET

Request parameters

The following parameters are available for each request:

Field	Type	Format	Description
`limit`	Integer	N/A	Specify the maximum number of reports to return in a single response. The default value is `10`.
`offset`	Integer	N/A	Specify the number of reports to skip before returning results. Use this parameter for pagination. The default value is `0`.
`status`	String	N/A	Filter reports by status. Valid values are `Queued`, `Processing`, `Done`, and `Failed`.
`report_type`	String	N/A	Filter reports by type. Valid values are `Audit` and `Tax-ID`.
`created_after`	String	`yyyy-MM-dd`	Return reports created on or after the specified date.
`created_before`	String	`yyyy-MM-dd`	Return reports created on or before the specified date.

Response parameters

The following parameters are returned in the response:

Field	Type	Format	Description
`presigned-url`	String	n/a	The pre-signed URL for the report, if available.
`started-timestamp`	String	n/a	The time that the report started at.
`report-type`	String	n/a	The type of report. It can be `Audit` or `Tax-ID`.
`filename`	String	n/a	The name of the report file.
`status`	String	n/a	The report's status. It can be one of `Queued`, `Done`, `Failed` or `Processing`.
`created-timestamp`	String	`$date-time`	The time that the report is created that is when processing is done.
`error-message`	String	n/a	If the report failed, the error message is included.
`uuid`	String	`$uuid`	The UUID of the report query.
`parameters`	String	n/a	See Schedule Reports Input Parameters
`finished-timestamp`	String and Null	n/a	The time that report processing finished.

Sample request

curl --request GET \
     --url 'https://reporting-api.marketplace.taxamo.com/api/v3/reports?limit=5&offset=1&status=Done&report_type=Audit&created_after=2024-01-01' \
     --header 'accept: application/json'

Sample response

{
  "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"
    }
  ]
}