Balance Forecast
ynab_balance_forecastProject your combined account balance over the next N days using scheduled transactions, revealing end-of-day running balances and the lowest point to spot upcoming shortfalls.
Instructions
Projects the combined balance of your accounts over the next N days (from today in UTC) from scheduled transactions only: the starting balance, the scheduled events, the end-of-day running balance and the lowest point. Income or spending that is not scheduled in YNAB is not in the forecast. Transfers between two included accounts (credit card payments too) net to zero; a transfer to an account outside the forecast counts as money leaving, and one from an account outside it as money arriving. Split schedules are counted leg by leg. Occurrences whose date has passed but that YNAB has not entered yet count on the first day, marked overdue with their scheduled_date and summarised in overdue_schedules. Where YNAB does not give the second date of a twice-a-month schedule, it is approximated as 15 days after the first. Events are capped by limit; the running balance, low point and ending balance always cover every day. For past income versus spending, use ynab_cash_flow; to list the schedules themselves, use ynab_list_scheduled_transactions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | How many days ahead to project (default: 30, max: 365) | |
| limit | No | Maximum number of events to return, earliest first (default: 100; 0 leaves them out). event_count, the running balance, low point and ending balance always cover every event. | |
| planId | No | The plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias) | |
| budgetId | No | Deprecated alias of planId (still accepted) | |
| accountIds | No | Accounts to include (IDs from ynab_list_accounts). Defaults to every open on-budget account. |