Retrieve a scheduled report run
GET
/scheduled-report-runs/{runId}This endpoint allows you to retrieve one of your scheduled report runs.
Path Parameters
runIdstringrequired
Response
OK
idstring<uuid>
report_type"fp_account_statement"
frequency"daily" | "monthly"
period_startstring<date-time>
Inclusive start of the reporting period (half-open interval [period_start, period_end)).
period_endstring<date-time>
Exclusive end of the reporting period (half-open interval [period_start, period_end)).
filesobject[]
Generated files, each with its download access_url. Null until the run has completed.
status"pending" | "processing" | "error" | "completed"
created_atstring<date-time>
updated_atstring<date-time>
Error defines errors may be returned from the system.
messagestring
errorsobject[]
Error defines errors may be returned from the system.
messagestring
errorsobject[]
Error defines errors may be returned from the system.
messagestring
errorsobject[]
API Reference › Local Currency Payouts API › scheduled-report-runs