Automated scheduling generates Detailed Settlement Reports on a recurring schedule.

To enable automated scheduling, you must enable change data capture (CDC) reporting. Automated scheduling isn't compatible with the standard reporting system.

Create a scheduler

To create a recurring schedule, send a POST request to the following endpoint:

{service_uri}/api/v2/reports/schedule

Details

Detail	Value
Endpoint	`/api/v2/reports/schedule/`
Method	POST

Parameters

Parameter	API Details	Description
`schedule_frequency`	Data Type: String Default: None	Specifies how often to generate the reports. For example, `monthly`, `bi-monthly`, or `quarterly`.
`tax-country-code`	Data Type: String Default: None	Specifies the two-letter country code for the tax entity. For example, `US` for the United States.
`currency-code`	Data Type: String Default: Region currency	Converts all amounts to the specified three-letter currency code. For example, `USD` for the United States Dollar or `EUR` for Euros.
`refund-date-kind-override`	Data Type: String Default: Region default	Specifies how the report includes refunds. Set to `order_date` to show only refunds for the transactions in the reporting period. Set to `refund_timestamp` to show refunds created in the reporting period.
`fx-currency-rounding`	Data Type: Boolean Default: `false`	Applies currency rounding based on minor currency units. For example, `true` or `false`.
`fx-date-type`	Data Type: String Default: Region default	Specifies which date to use for FX conversion. For example: • `day`–The order date. • `prev-day`–The day before the order date. • `end`–The last day of the selected date range.
`informative-lines-setting`	Data Type: String Default: Excludes informative lines	Includes informative lines in the report. For example, `include-informative`.
`fx-refund-date-type`	Data Type: String Default: Region default	Specifies which date to use for refund FX conversion. For example: • `sale`–The original sale date. • `sale-day`–The order date. • `sale-prev-day`–The day before the order date. • `refund-day`–The refund date. • `refund-prev-day`–The day before the refund date. • `end`–The last day of the selected date range.
`skip-mos`	Data Type: Boolean Default: `true`	Excludes lines where the tax country matches the OSS registration country and merchant country. For example, `true` or `false`.
`product-classes`	Data Type: String Default: None	Specifies the product classes in the report. For example: • `P`–For physical goods. • `D`–For digital goods. • `PD`–Both physical and digital goods.
`country-subdivision`	Data Type: String Default: Includes all subdivisions	Specifies the two-letter subdivision code. For example, `PA` for Pennsylvania in the United States (US).
`transaction-scope`	Data Type: String Default: `T`	Specifies which transactions to include in the report. For example: • `T`–Taxed transactions. • `U`–Untaxed transactions. • `A`–All transactions.
`notify-email`	Data Type: Boolean Default: None	Sends the report to the user's email address. For example, `true` or `false`.
`tax-names`	Data Type: Array[String] Default: Includes all tax names	Returns transactions for the specified tax names. Applies only to Canada. For example, `[GST, HST]`.
`custom-fields`	Data Type: Array[String] Default: Excludes custom fields	Returns up to five custom fields. For example, `[field_one, field_two, field_three]`.

Examples

This example creates a recurring schedule for a specified report.

Request

{
  "job_name": "Australia - AU",
  "schedule_frequency": "monthly",
  "report_type": "settlement-detailed-report",
  "parameters": {
    "tax-country-code": "AU",
    "currency-code": "USD",
    "product-classes": "D",
    "informative-lines-setting": "include-informative",
    "refund-date-kind-override": "refund_timestamp",
    "transaction-scope": "A" 
    }
}

Response

[
  {
    "schedule_frequency": "monthly",
    "next_execution": "2026-01-15T00:00:00Z",
    "job_name": "Australia - AU",
    "last_execution": "2026-01-15T10:54:59Z",
    "report_type": "settlement-detailed-report",
    "status": "enabled",
    "created_timestamp": "2026-01-15T10:16:12Z",
    "uuid": "123456789-1234-5678-9000-123456789000",
    "parameters": {
      "tax_country_code": "AU",
      "currency_code": "USD",
      "product_classes": "D",
      "informative_lines_setting": "include-informative",
      "refund_date_kind_override": "refund_timestamp",
      "transaction_scope": "A"
    }
  }
]

Get a scheduler

To retrieve a specific recurring schedule, send a GET request to the following endpoint:

{service_uri}/api/v2/reports/schedule/{uuid}

Details

Detail	Value
Endpoint	`/api/v2/reports/schedule/`
Method	GET

Parameters

Parameter	Description
`uuid`	The universally unique identifier (UUID) for the report.

Examples

This example retrieves a specified recurring schedule.

Request

GET https://{service_uri}/api/v2/reports/schedule/123456789-1234-5678-9000-123456789000

Response

{
  "schedule_frequency": "monthly",
  "next_execution": "2026-01-15T00:00:00Z",
  "job_name": "Australia - AU",
  "last_execution": "2026-04-01T00:00:02Z",
  "report_type": "settlement-detailed-report",
  "status": "enabled",
  "created_timestamp": "2026-01-15T11:47:23Z",
  "uuid": "123456789-1234-5678-9000-123456789000",
  "parameters": {
    "tax_country_code": "AU",
    "product_classes": "D",
    "informative_lines_setting": "include-informative",
    "refund_date_kind_override": "refund_timestamp"
  }
}

Delete a scheduler

To delete a specific recurring schedule, send a DELETE request to the following endpoint:

{service_uri}/api/v2/reports/schedule/{uuid}

Details

Detail	Value
Endpoint	`/api/v2/reports/schedule/`
Method	DELETE

Parameters

Parameter	Description
`uuid`	The universally unique identifier (UUID) for the report.

Examples

This example deletes a specified recurring schedule.

Request

DELETE https://{service_uri}/api/v2/reports/schedule/123456789-1234-5678-9000-123456789000

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": "https://{service_url}/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 schedulers

To retrieve a list of recurring schedules, send a GET request to the following endpoint:

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

Details

Detail	Value
Endpoint	`/api/v2/reports/schedule/`
Method	GET

Parameters

Parameter	Description
`report-type`	Always set to `settlement-detailed-report`.
`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.

Examples

This example lists all the recurring schedules for a specified report.

Request

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

Response

{
  "schedules": [
    {
      "schedule_frequency": "monthly",
      "next_execution": "2026-01-15T00:00:00Z",
      "job_name": "Australia - AU",
      "last_execution": null,
      "report_type": "settlement-detailed-report",
      "status": "enabled",
      "created_timestamp": "2026-01-15T11:42:04Z",
      "uuid": "123456789-1234-5678-9000-123456789000",
      "parameters": {
        "tax_country_code": "AU",
        "currency_code": "USD",
        "product_classes": "D",
        "informative_lines_setting": "include-informative",
        "refund_date_kind_override": "refund_timestamp"
      }
    }
  ]
}

Post processing

Use the List Scheduled Detailed Settlement Reports request to retrieve an automatically scheduled report.