currency_mode='company' so every amount lands in one currency, and report
that single total — never sum amounts in different currencies. The default
(payment) leaves each amount in the user’s own pay currency, which is not
comparable across a multi-currency team.
Each row exposes a resource_url that opens that single statement. The result
also carries a list-level application_url that reopens the statements board
on the queried period. It is always set because period is required.
Parameters
Body
Body
string
required
Period in YYYY-MM format (e.g. 2026-03). Required.
string
Free-text filter matched against the statement’s user (name or email), same
matching as list_users search.
string
Status filter. One of ongoing (open / not yet locked), locked (frozen but
not paid), paid (sent to payroll), or error (the calculation errored out).
The error condition is bundled into this single field.
boolean
If True, only statements with at least one manual amount adjustment
(overwritten).
boolean
If True, only statements that have at least one linked request you can
access.
string
Keep only statements computed from the compensation plan with this id — the
id list_plans returns.
string
Id of the statement view to narrow the rows to its users, from get_identity
(the views of your statement access). A filtering aid only: it never widens
what you can see.
string
Id of the manager whose team to narrow to — everyone below them in the
hierarchy (all levels, not just direct reports). The id list_users returns,
or the manager’s exact email. It only filters within what you can already
see — a teammate outside your access stays hidden.
string
Which currency each total_amount is converted into and labelled with:
‘payment’ (default) — the currency the user is paid in; ‘calculation’ — the
currency the plan computes in; ‘company’ — the company’s global currency.
The amount and its currency always agree. One of:
company, payment,
calculation.string
Id of the sandbox to read instead of the live environment — the id
list_sandboxes returns. Omit it to read the live environment, the company’s
real compensation data, which is the right choice unless the question is
explicitly about a sandbox. Only a sandbox id is accepted here — never a
sandbox name, and never the live environment’s own id.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this
page. Any offset >= 0 is accepted; it does not have to be a multiple of
limit, so you can start from an arbitrary row. Pass the next_offset returned
by the previous call to walk the pages, or None for the first page.