Skip to main content
POST
Run a saved 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).

Path Parameters

id
string
required

Report definition id (ULID)

Response

Report result set

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