cash_flow_forecast
Forward-looking account-level balance projections using PocketSmith's forecasting engine. Shows where each account is heading and identifies danger zones where balances drop below a configurable threshold. Filter by account types (bank, cash, credits, stocks, mortgage, loans, retirement) or specific account IDs. Accounts without linked scenarios will have no forecast data. Credit cards naturally have negative balances — adjust danger_threshold accordingly when checking credit accounts. The forecast horizon is limited only by the user's subscription plan date limits — multi-year projections (e.g. loan payoff dates) are fine; use monthly resolution for long horizons. navigate_to_cashflows is the matching page link to offer alongside any projection answer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | The unique identifier of the user. If omitted, automatically resolved from the authenticated user. | |
| resolution | No | Time resolution for balance data points: daily, weekly, monthly. Default: weekly. | |
| account_ids | No | Comma-separated specific account IDs to include. Overrides account_types filter if provided. | |
| months_ahead | No | Number of months to forecast ahead from today. Default: 3. No fixed cap — the horizon is limited only by the user's subscription plan date limits. Use monthly resolution for multi-year horizons to keep the response manageable. | |
| account_types | No | Comma-separated account types to include (bank, cash, credits, stocks, mortgage, loans, retirement). Default: all types. | |
| danger_threshold | No | Balance level below which an account is flagged as a danger zone. Default: 0 (flags only negative balances). |