Skip to main content
POST
Run an inline report definition synchronously

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Body

application/json

The report-definition document — one contract drives sync runs, exports, saved definitions and schedules. See docs/API.md for the full rules.

dataset
string
required

A dataset name from GET /datasets

select
object[]
required
Required array length: 1 - 50 elements
filters
object

Filter tree node: exactly one of and/or/not (branch, depth ≤ 3) or field+op (leaf). value is type-checked against the field.

groupBy
string[] | null

Required iff any select entry aggregates; every plain select entry must appear here, referenced by field name or alias

orderBy
object[] | null
limit
integer<int32> | null

Clamped to 10,000 (sync) / 5,000,000 (export)

Response

Report result set (row cap 10,000 — truncated flag set when hit)

runId
string
required
columns
object[]
required
rows
((any | null)[])[]
required

Cell value; decimals arrive as strings

rowCount
integer<int32>
required
truncated
boolean
required

true → the sync row cap was hit; use an export

statusScope
string
required

Which payslip statuses applied: FINAL (implicit default) | PREVIEW | ALL

executionMs
integer<int64>
required