Accounts: Update account
update_account Update an existing financial account.
Args:
account_id: The account ID to update
name: New account name (optional)
account_type: New account type (optional). One of: checking, savings,
cash, credit_card, loan, mortgage, student_loan, heloc, arm,
investment, other_asset, other_debt
balance: New balance amount (optional, use with caution)
institution: New institution name (optional)
currency: New currency code. App is locked to USD pre-launch — any
other value is rejected. (See docs/CURRENCY_RESTORE_TODO.md.)
is_active: Set account active/inactive (optional). True on an archived
account restores it, subject to the plan's account limit and to no
other active account having the same name.
interest_rate: New interest rate for debt accounts (optional)
credit_limit: New credit limit for credit cards (optional)
minimum_payment: New minimum payment for debt accounts (optional)
term_months: Original loan term in months (optional)
loan_start_date: Loan origination date YYYY-MM-DD (optional)
loan_end_date: Loan payoff target date YYYY-MM-DD (optional)
original_balance: Original loan amount when first taken out (optional)
monthly_escrow_tax: Monthly property tax escrow, mortgage only (optional)
monthly_escrow_insurance: Monthly insurance escrow, mortgage only (optional)
draw_period_months: HELOC draw-phase duration in months (optional)
draw_amount_per_month: HELOC monthly draw amount (optional)
rate_2: 2nd-term rate as percentage, HELOC/ARM (optional)
term_2_months: 2nd-term duration in months, HELOC/ARM (optional)
arm_initial_period_months: ARM fixed-rate period in months (optional)
include_in_debt_paydown: Include this debt in the payoff calculator
and dashboard payoff card (optional). Set False for a debt you
pay in full each month so it doesn't distort the plan; does NOT
affect net worth, total debt, or the balance sheet.
low_balance_alert_threshold: Per-account low-balance alert
threshold in dollars — "alert me when this account drops below
$X" (checking/savings/cash). Overrides the monitoring plan's
global threshold for this account only.
clear_low_balance_threshold: Set True to remove a per-account
threshold and fall back to the plan's global default.
mute_low_balance_alerts: True = no low-balance alerts on this
account (daily brief + notifications) — "stop reminding me,
I know this account is low". False = re-enable alerts.
institution_login_url: Where the user logs in at this institution
(https only, e.g. "https://chase.com"; bare domains are
normalized to https). An empty string removes the link. Intended
for a URL the user provided, not a guessed or invented one.
Returns:
Updated account details
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| rate_2 | No | ||
| balance | No | ||
| currency | No | ||
| is_active | No | ||
| account_id | Yes | ||
| institution | No | ||
| term_months | No | ||
| account_type | No | ||
| credit_limit | No | ||
| interest_rate | No | ||
| loan_end_date | No | ||
| term_2_months | No | ||
| loan_start_date | No | ||
| minimum_payment | No | ||
| original_balance | No | ||
| draw_period_months | No | ||
| monthly_escrow_tax | No | ||
| draw_amount_per_month | No | ||
| institution_login_url | No | ||
| include_in_debt_paydown | No | ||
| mute_low_balance_alerts | No | ||
| monthly_escrow_insurance | No | ||
| arm_initial_period_months | No | ||
| clear_low_balance_threshold | No | ||
| low_balance_alert_threshold | No |