Automated scheduling generates Detailed Settlement Reports on a recurring schedule.

Detailed Settlement Reports generated by the Schedule Detailed Settlement Reports request are available through the API integration and in the user interface.

List the scheduled reports

To retrieve a list of reports generated from a recurring schedule, send a GET request to the following endpoint:

{service_uri}/api/v2/reports/schedule/report-list?report-type=settlement-detailed&offset={offset}

Details

Detail	Value
Endpoint	`/api/v2/reports/schedule/report-list`
Method	GET

Parameters

Parameter	Description
`report_type`	Always set to `settlement-detailed`.
`offset`	The pagination offset that defines the starting report position. For example, if there are 11 reports and the offset is 10, the report begins on the tenth report.
`limit`	The number of reports to return. The maximum value is 1,000.
`scheduler-uuid`	The scheduler universally unique identifier (UUID).
`status`	The report status: `done`, `processing`, `queued`, or `failed`.
`month_from`	The first month in the selection in `yyyy-mm` format.
`month_to`	The last month in the selection in `yyyy-mm` format.

Examples

This example retrieves a list of reports generated from a recurring schedule.

Request

GET {service_uri}/api/v2/reports/schedule/report-list?report-type=settlement-detailed&offset=0

Response

{
  "reports": [
    {
      "scheduler_uuid": "123456789-1234-5678-9000-123456789000",
      "tax_region": "AU",
      "report_id": "123456",
      "report_date_end": "2026-01-15",
      "report_type": "settlement-detailed",
      "status": "done",
      "url": "{service_uri}/api/v2/reports/object-storage/{name}.csv?report_type=settlement-detailed",
      "created_timestamp": "2026-01-15T00:00:02Z",
      "report_date_start": "2026-01-15",
      "report_file_key": "{name}.csv"
    }
  ]
}

List the failed reports

To retrieve a list of failed reports from a recurring schedule, send a GET request to the following endpoint:

{service_uri}/api/v2/reports/schedule/report-list?report-type=settlement-detailed&status=failed