Scenarios: Create a what-if scenario
create_scenario Create a what-if scenario and return its projected impact.
A scenario bundles one or more hypothetical changes (buy a car, take a
mortgage, open a credit card, sell the house). It auto-saves for 60
days; committing it later turns its add items into real accounts.
Each item is a dict:
- add_debt: {action:"add_debt", account_type (credit_card / loan /
mortgage / student_loan / heloc / arm / other_debt), name, balance,
interest_rate, minimum_payment, term_months; for HELOC/ARM also the
full two-phase set rate_2 + term_2_months + draw_period_months or
arm_initial_period_months}
- add_asset: {action:"add_asset", account_type (cash / checking /
savings / investment / other_asset), name, balance}
- remove: {action:"remove", target_account_id} — sells/drops an
existing account from the projection.
Args:
name: Short label for the scenario (e.g. "Buy a 2026 Honda").
items: List of change dicts (see shapes above).
description: Optional notes.
strategy: Paydown strategy for the projection (default highest_rate
/ avalanche).
extra_monthly: Extra monthly payment applied to the projection.
Returns:
{scenario: {...}, analysis: {...}} or {"error": "..."}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| items | Yes | ||
| strategy | No | highest_rate | |
| description | No | ||
| extra_monthly | No |