Summarise a scenario
What a scenario’s tab on the scenarios screen shows, per month or for the whole window,
per period or per category. Give period, or both from and to, or neither for the
scenario’s own months.
The window widens to whole months and is clipped to the scenario’s months. A window outside them is rejected with 400. Amounts are in the workspace currency and are never converted. Outflows are negative.
Without group_by there is one row per period with inflow, outflow and net, and
the balance lines of the tab. final_balance is starting_balance plus net, as the
tab computes it. opened_accounts, transfers and excluded appear beside it and do
not enter it. A dynamic scenario has every line. A snapshot has opened_accounts,
transfers and excluded unless the line is zero in every month. A blank scenario has
only final_balance. Lines the tab does not show are null.
totals covers the whole window: the flows and the balance lines added up, the first
period’s starting_balance and the last period’s final_balance.
With group_by=category there is one row per category per period, nested as on the
screen. A parent category’s row is its whole branch, so adding a parent and its
children counts the children twice. edited is true where the scenario sets the
amount itself rather than taking it from the cash flow. A category appears in a period
when it has an amount or the scenario edited it. category_id narrows the rows and
totals to those categories and the ones nested under them, and the balance fields
are then null.
A scenario month by month
A scenario by category over its whole window
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 scenario's tab.