Create a new financial account.
Args:
name: Account name (e.g., "Chase Checking", "Visa Credit Card")
account_type: One of: checking, savings, cash, credit_card, loan, mortgage,
student_loan, heloc, arm, investment, other_asset, other_debt
balance: Opening balance (default: 0.00, can be negative for debt accounts)
institution: Bank or financial institution name
institution_login_url: Where the user logs in at this institution
(https only, e.g. "https://chase.com"; bare domains are
normalized to https). Optional; intended for a URL the user
provided, not a guessed or invented one. Plaid-linked accounts
get one automatically.
currency: Currency code. App is locked to USD pre-launch — any other
value is rejected. (See docs/CURRENCY_RESTORE_TODO.md to re-enable
multi-currency.)
interest_rate: Annual interest rate as percentage (0-100). For HELOC, this
is the draw-phase rate. For ARM, this is the initial fixed rate.
credit_limit: Credit limit (for credit card accounts)
minimum_payment: Minimum monthly payment (for debt accounts)
term_months: Original loan term in months (e.g. 360 for a 30-year mortgage)
loan_start_date: Loan origination date (YYYY-MM-DD)
loan_end_date: Loan payoff target date (YYYY-MM-DD)
original_balance: Original loan/debt amount when first taken out
monthly_escrow_tax: Monthly property-tax escrow (mortgage only)
monthly_escrow_insurance: Monthly insurance escrow (mortgage only)
draw_period_months: Number of months in the HELOC draw-down phase
draw_amount_per_month: Monthly draw amount during HELOC draw-down phase
rate_2: 2nd-term annual interest rate as percentage — HELOC repayment
rate or ARM adjusted rate
term_2_months: 2nd-term duration in months — HELOC repayment term or
ARM remaining term after the adjustment
arm_initial_period_months: Fixed-rate period in months before ARM
adjustment (e.g. 60 for a 5/1 ARM)
include_in_debt_paydown: Whether this debt is part of the payoff
calculator and the dashboard payoff card (default True). Set
False for a debt you pay in full every month (e.g. a credit
card that carries no balance month to month) so it doesn't distort the
plan. Ignored for asset accounts; does NOT affect net worth,
total debt, or the balance sheet.
low_balance_alert_threshold: Per-account low-balance alert
threshold in dollars (checking/savings/cash only). Omit to use
the monitoring plan's global threshold.
mute_low_balance_alerts: Suppress low-balance alerts on this account
(daily brief + notifications). For accounts the user
intentionally keeps low. Default False.
Returns:
Created account details