Loki Docs
Tools › Transactions › Get the monthly summary

Get the monthly summary

get_monthly_summaryReads
What it does
Reads only. Changes nothing.
Permission
Transactions, read transactions:read

What your assistant is told

Headline financial summary for one calendar month: total income, total expense, and net (income − expense) in minor units, plus the per-category breakdown. month is "YYYY-MM". Use this for the month overview ("did I save money in June?"). Read-only. The figure is SINGLE-CURRENCY: it covers exactly one currency — the returned currency names which, either the one you asked for or the user's display currency — and amounts in other currencies are NOT summed in, because minor units of different currencies are not addable. excludedCount is how many of the month's transactions were in another currency (excludedCurrencies lists which); when it is above zero say so rather than presenting the totals as the whole month, and call this again with that currency to see the rest. Nothing here is converted between currencies. Covers every account unless you pass account (e.g. to see the business on its own).

Parameters

  • monthtext, requiredMonth as "YYYY-MM", e.g. "2026-06".
  • currencytext, optionalOptional 3-letter ISO currency to report in. Omit for the user's display currency (then EUR).
  • accounttext, optionalOptional account id, alias or IBAN to restrict to (e.g. only the business account). Omit for every account.