"linked": true and cannot be created or deleted via the API.
The account object
on_budget is true for banking and credit accounts (they participate in envelope budgeting) and false for investment and loan accounts.
List accounts
| Query parameter | Type | Description |
|---|---|---|
include_closed | boolean | Include closed accounts. Default false. |
Get an account
Create an account
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Display name |
type | string | yes | Account type (see below) |
initial_balance | string | no | Starting balance as a decimal string |
initial_balance_date | string | no | Date of the starting balance (YYYY-MM-DD, defaults to today) |
banking_checking, banking_savings, banking_cash, banking_cash_management, banking_money_market, banking_cd, banking_other, credit_credit_card, credit_line_of_credit, credit_other, investment_brokerage, investment_401k, investment_ira, investment_roth_ira, investment_roth_401k, investment_hsa, investment_sep_ira, investment_simple_ira, investment_keogh, investment_529_plan, investment_403b, investment_other, loan_auto, loan_business, loan_commercial, loan_construction, loan_home_equity, loan_mortgage, loan_student, loan_other.
Update an account
| Field | Type | Description |
|---|---|---|
name | string | Rename the account |
notes | string | Set the account notes |
closed | boolean | true closes the account (reconciles its cleared transactions), false reopens a closed one |
Delete an account
400. Close the account instead if it has history you want to keep.