YYYY-MM), newest first, with a per-status
breakdown of how many statements are in each stage and the sum of their payment
split by currency. Use it to answer “how are we managing our statements?” — e.g.
to see whether every past period is already closed (CLOSED) so attention can
move to the current one.
Only the statements you have access to are counted — the same set
list_statements returns.
Payments are converted into the currency named by currency_mode (each
statement’s payment currency by default) and reported as a {currency: amount} map per period and per status, never summed across currencies.
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_payment 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.Response
Body
Body
object[]