Skip to main content
POST
Create a custom run with explicit UTC period boundaries (CARF calendar year or treasury-statement day/month/year)

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Body

application/json
workflow_id
string<uuid>
required
period_start
string<date-time>
required

Inclusive start with an explicit timezone. Template-specific: CARF requires January 1 UTC midnight (year ≥ 1970); treasury-statement requires any UTC midnight day boundary within a ≤366-day half-open interval.

Example:

"2024-01-01T00:00:00Z"

period_end
string<date-time>
required

Exclusive end with an explicit timezone. Template-specific: CARF requires the following January 1 UTC midnight; treasury-statement requires a later UTC midnight within the supported span.

Example:

"2025-01-01T00:00:00Z"

Response

202 - application/json
id
string<uuid>
required
workflow_id
string<uuid>
required
occurrence_at
string<date-time> | null
required
rerun_of
string<uuid> | null
required
requested_cutoff
string<date-time>
required

Inclusive observation bound; period.end is the exclusive end of the stored half-open period.

execution_status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled,
skipped
tx_sync_status
enum<string>
required
Available options:
not_applicable,
waiting,
completed,
expired
delivery_status
enum<string>
required
Available options:
not_required,
pending,
sending,
sent,
failed,
cancelled
created_at
string<date-time>
required
cases
object[]
required
period
object
required
warnings
string[]
required
reason
string | null
required
queued_at
string<date-time>
required
started_at
string<date-time> | null
required
Example:

null

Last modified on October 2, 2026