Forecasts
Cash and profit forecasts from the books, with what-if scenarios.
GET /forecasts/cashCash forecast, week by weekGET /forecasts/profitProfit forecast by monthGET /forecast-scenariosList what-if scenarios
Cash forecast, week by week
GET /forecasts/cash
Sends Vortex-Entity.
Starts from the cash in the bank and cash accounts on as_of (default today). Open invoices come in and open bills go out in the week they're due; anything past due lands in the first week. All other cash movement (sales, payroll, expenses paid straight from the bank) comes in and goes out at its weekly average over the 13 weeks before as_of, leaving out invoice and bill payments. scenario_id applies a saved what-if scenario. A projection from the books, not a promise. Requires reports:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
as_of | query | string (date) | |
weeks | query | integer | |
scenario_id | query | string (uuid) |
Answers
Profit forecast by month
GET /forecasts/profit
Sends Vortex-Entity.
Income and expenses by account for each month from start_month (default this month). Months that are over show what the books say (actual true); the rest are projected from the same month a year earlier (basis last_year) or from the latest budget (basis budget). scenario_id applies a saved what-if scenario to the projected months. Requires reports:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
start_month | query | string | |
months | query | integer | |
basis | query | string | |
as_of | query | string (date) | |
scenario_id | query | string (uuid) |
Answers
List what-if scenarios
GET /forecast-scenarios
Sends Vortex-Entity.
Saved scenarios, made in the app. Each adjustment is one of income_percent or expense_percent (percent, from month), monthly (account_id, amount, from, optional to, label), one_time (account_id, amount, month, label), cash_once (amount, date, label) or cash_monthly (amount, from, optional to, label). Cash amounts are positive for money in. Saving a scenario with a name already used returns 409 duplicate_scenario; a scenario whose stored changes can't be read lists with readable false and, applied to a forecast, returns 422 scenario_unreadable. Requires reports:read.

