YYYY-MM, newest first), currency and reporting
stage (ERROR / OPEN / VALIDATED / LOCKED / CLOSED), each with the summed
total_amount in that currency and how many statements it covers. Use it
to answer “how are we managing our statements?” — e.g. whether every past
period is already CLOSED. Amounts are never summed across currencies, so a
period spans several rows when its statements do.
Only the statements you have access to are counted — the same set
list_statements returns.
Amounts are converted into the currency named by currency_mode (each
statement’s payment currency by default). To compare totals across periods,
pass currency_mode='company' so every period reports in the single company
currency you can line up directly — the default (payment) can split one
period across several currency rows, which is not comparable period to period.
Parameters
Body
Body
boolean
When True (default), only periods from the last 12 months (relative to
today) are returned. When False, the full history is returned.
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. Prefer ‘company’ when comparing
or aggregating totals across users or periods. 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.
Response
Body
Body
object[]
One row per (period, currency, stage) combination. Ordered by period
(newest first), then currency, then stage.