period that has statements
(newest first), currency and stage.
Each row covers one month (YYYY-MM), currency and reporting stage (ERROR /
OPEN / VALIDATED / AWAITING_APPROVAL / LOCKED / CLOSED), and gives the
total_amount of its statements in its currency and how many there are. Use
it to see where a month, a quarter or a year stands, for example whether every
past month is already CLOSED.
Only the statements you can see are counted: the same set
list_statements returns.
Totals are never summed across currencies, so a month spans several rows when
its statements do. To compare months, pass currency_mode='company': one
currency, one row per stage. A month whose statements have no rate configured
for the requested currency is refused, naming the missing pair;
list_exchange_rates shows the
rates.
period is required and covers at most 12 months. Pass a month (2026-03), a
quarter (2026-Q3) or a year (2026). Quarters and years follow the company’s
fiscal calendar, so 2026-Q1 does not have to start in January. For example, to
check how far the statements of a fiscal year have moved through validation:
Parameters
Body
Body
string
required
A month (YYYY-MM), a quarter (YYYY-QX) or a year (YYYY); quarters and years
follow the company’s fiscal calendar, as get_identity reports it.
string
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 currency. One of:
company,
payment, calculation.string
Id of a sandbox from list_sandboxes, to read it instead of the live
environment. Omit it for live, the company’s real data, unless the question
is explicitly about a sandbox. Never a name, never the live id.
Response
Body
Body
object[]
One row per (period, currency, stage) combination. Ordered by period
(newest first), then currency, then stage.