Budgets and reserves

budgets.overview

Read spending budgets, reviewed actuals, upcoming tax and accountant obligations, reserve coverage, and future recurring purchase forecasts. Use sections to load only due, spending, reserves or recurring; omitted sections return empty arrays and recurringForecast null. No sections returns all. Recurring forecasts reuse reviewed charges, saved subscription status and accepted same-currency merges, with evidence, amount basis, uncertainty and per-currency totals. They are speculative future costs, kept separate from actual spend, tax liabilities and funding obligations. Reuses official compliance dates and reviewed GST/HST workpapers. Unknown tax amounts and stale or missing balances remain unknown; each reserve is counted once.

GETPOST/api/v1/accounting/budgets.overview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_budgets_overview

Fields

  • fromstring (date)

    The first date to include, as YYYY-MM-DD.

  • tostring (date)

    The last date to include, as YYYY-MM-DD.

  • sectionsarray of enum values
    duespendingreservesrecurring

    1–4 items

Example

curl https://app.getoatmilk.com/api/v1/accounting/budgets.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY"
Response
{
  "data": { … }
}

Try it

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

GET/api/v1/accounting/budgets.overview
curl https://app.getoatmilk.com/api/v1/accounting/budgets.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY"

More in Budgets and reserves.