Loki Docs
Tools › Budgets › Get budgets

Get budgets

get_budgetsReads
What it does
Reads only. Changes nothing.
Permission
Budgets, read budgets:read

What your assistant is told

List the calling user's category budgets for one month, with the actual expense spend rolled up against each cap. month is "YYYY-MM". Returns one row per category that HAS a cap set for that month (categories with no cap are omitted — an empty list means no budgets were set, not that spend was zero). Each row has the cap and the actual spend in minor units, both in that row's own currency: actualMinor counts ONLY the category's expenses in the cap's currency, never a cross-currency sum, and excludedCount is how many of its expenses were in another currency and so are not measured against this cap. Read-only.

Parameters

  • monthtext, requiredMonth as "YYYY-MM", e.g. "2026-06".