Summarise budgets
What the budgets screen shows, per month or for the whole window, per direction or per
category. Give period, or both from and to.
Budgets are monthly, so the window widens to whole months. Each row puts the budget
beside what happened. budgeted is the budget. actual is the transactions, the
tracking tab’s Actual column. forecast is the remaining amount of the unrealised
forecasts dated in the period, the tracking tab’s Forecasted column. realised adds the
two and is the figure the planning tab compares with the budget. Outflows are negative.
on_budget is the planning tab’s check or warning icon. It is true when realised
reached an inflow budget or stayed within an outflow budget, and null for a month that
has not started, for a cell without a budget and with interval=total.
The figures cover the categories shown on the budgets screen. In most workspaces the
categories hidden there include the uncategorised and transfer categories, so budget
totals differ from /transactions/summary and /cash-flow/summary for the same months.
Budgets convert to currency at the rate for the first day of their month, transactions
and forecasts at the rate of their own date. totals is the planning tab’s Total column
for each direction.
Without group_by there is one row per direction per period, and balances holds the
planning tab’s final balance row: final_balance once a month has started and
budgeted_final_balance, the balance if the budgets hold, until it has ended.
balances is empty with interval=total, group_by, category_id or direction.
With group_by=category the rows nest as on the screen. A parent category’s row is its
whole branch, so adding a parent and its children counts the children twice. A row
whose id equals its parent_id is the money booked on the parent itself, which the
screen shows as “Others for” the parent. A category appears in a period when something
is budgeted, has moved or is expected for it. category_id narrows the rows and
totals to those categories and the ones nested under them.
Rows are ordered by period. Within a period inflows come before outflows, and categories follow the screen’s order, parents before their children.
Inflows and outflows against the budget this quarter, with balances
This year’s outflows against the budget by category, in total
Authorizations
Query Parameters
A named window, resolved against the workspace's local day and echoed in the response. Takes precedence over from and to.
A named window resolved on the server. last_30_days and last_90_days end today and include it; last_12_months starts the day after today minus twelve months. next_month, next_quarter and next_year cover the whole next calendar month, quarter or year.
this_month, last_month, this_quarter, last_quarter, this_year, last_year, month_to_date, quarter_to_date, year_to_date, last_30_days, last_90_days, last_12_months, next_month, next_quarter, next_year The period rows are grouped into. month for each calendar month, total for the whole window as one period.
A period bucket for budget and scenario rows, which are monthly. total reports the whole window as one period, as the budgets screen's Total column does.
month, total Response
The summary.