Accounts

An account is one of your firm's custodian accounts, such as an IRA or an individual brokerage account. An account belongs to one household at most, given by its householdId. The console shows accounts on the Accounts tab of the Clients page and on the Portfolio tab of a household.

To find accounts by name, household, model, type, balance or cash, call List accounts with a query in q. To list the accounts of one household, call List the accounts of a household. To change which household an account belongs to, see Accounts assigned to households.

📄️List accounts

Returns your firm's active accounts, in order of name. Send `includeInactive=true` to include inactive accounts, and `id` to return only the accounts with those IDs. Send `balances=true` to add each account's current holdings, balance, cash, cash weight and risk allocation; `riskAllocation.target` is always `{}` here, and **Get an account** returns it. Send `q` to return only the accounts that match a query, and `sort` to order them; `totalCount` counts only the accounts that match.

📄️Get an account

Returns the account with the given ID, with its current holdings and its current and target allocation to your firm's risk levels. `riskAllocation.target` comes from the model assigned to the account, and is `{}` when no model is assigned to it; the model of its household does not count. Send `balances=true` to add its current balance and cash. If your firm has no account with that ID, the response is `404`.

📄️Update an account

Replaces the model, capital gains budgets, lot selection method, tax rates, tax budget, billing settings and security restrictions of the account with the given ID with the ones in the request body, and returns the account as **Get an account** returns it. Send every required field. A field you leave out or send as `null` is cleared. The billing splits, asset exclusions and security restrictions you send replace all of the account's. `address` is not read. When the account's `existsInBridge` is `true`, its billing start date is also sent to the custodial data feed. If your firm has no account with that ID, the response is `404`.

📄️List the holdings of an account

Returns the securities the account with the given ID held over a period, in order of security ID: each position as of `end-date`, with the dividends and interest the security paid and its realized gains and losses of the period. A security the account sold in the period and does not hold as of `end-date` is included with `units` and `value` `0`. If your firm has no account with that ID, the response is `404`.

📄️Get the AUM history of an account

Returns the total, cash and securities value of the account with the given ID on each date of the period that has a balance, oldest first. If your firm has no account with that ID, the response is `404`.

📄️Get the performance history of an account

Returns the cumulative return of the account with the given ID on each date of the period that has a balance, oldest first: its return from the first date of the period to that date. If your firm has no account with that ID, the response is `404`.

📄️Get the asset allocation of an account

Returns the allocation of the account with the given ID to asset classes: its current allocation, from its holdings, and its target allocation, from the model assigned to the account, or else to its household. `target` is `[]` when neither has a model. If your firm has no account with that ID, the response is `404`.

📄️Create a note for the household of an account

Creates a note with the text in `content` on the CRM records linked to the household of the account with the given ID: its Wealthbox household, then the head of its Redtail family. The household's Slant record gets no note. The response is the note created last, or `data: null` when no note was created, for example when the household is linked to Redtail only and its Redtail family has no members. If your firm has no account with that ID, the response is `404`. Send the ID of an account whose household is linked to Wealthbox or Redtail; see **Update household data connections**.

📄️Assign a tax registration to accounts

Sets the tax registration of each account in `accountIds` to `taxRegistration`, and returns each account it set. The console calls the tax registration the tax classification. An ID that is not one of your firm's accounts is skipped, and the response leaves it out.

📄️Assign a model to accounts

Assigns the model in `modelId` to each account whose ID is a key of `accounts`, and returns each account it assigned. Every key is assigned, whatever its value. A key that is not the ID of one of your firm's accounts is skipped, and the response leaves it out. Send the ID of one of your firm's models in `modelId`.

📄️Update the name of an account

Changes the name of the account with the given ID to `name`, and returns the account as **Get an account** returns it without `balances`. When the account's `existsInBridge` is `true`, the name is also sent to the custodial data feed. If your firm has no account with that ID, the response is `404`.

📄️Update whether an account is taxable

Sets whether the account with the given ID is taxable, and returns the account as **Get an account** returns it without `balances`. If your firm has no account with that ID, the response is `404`.

📄️Update the tax registration of an account

Sets the tax registration of the account with the given ID to `taxRegistration`, and returns the account as **Get an account** returns it without `balances`. The console calls the tax registration the tax classification. Send `null` to clear it. If your firm has no account with that ID, the response is `404`.

📄️Archive an account

Archives the account with the given ID, and returns the account as **Get an account** returns it without `balances`. `archiveDate` is the time of the request, and `isActive` is `false`. An account that is already archived keeps its `archiveDate`. If your firm has no account with that ID, the response is `404`.

📄️Unarchive an account

Makes the account with the given ID active again, and returns the account as **Get an account** returns it without `balances`. `archiveDate` is `null`, and `isActive` is `true`. If your firm has no account with that ID, the response is `404`.

📄️Update the trading settings of an account

Replaces the model, capital gains budgets, lot selection method, tax rates, tax budget and security restrictions of the account with the given ID with the ones in the request body, and returns the account as **Get an account** returns it without `balances`. Send every required field. A field you leave out or send as `null` is cleared. The security restrictions you send replace all of the account's. If your firm has no account with that ID, the response is `404`.

📄️Update the billing settings of an account

Replaces the fee structure, fee location, billing splits, asset exclusions and billing start date of the account with the given ID with the ones in the request body, and returns the account as **Get an account** returns it without `balances`. Send every required field. A field you leave out or send as `null` is cleared. The billing splits and asset exclusions you send replace all of the account's. Other fields are not read. If your firm has no account with that ID, the response is `404`.

📄️Get the performance of an account

Returns the performance of the account with the given ID over a period: its return, its starting and ending balance, its realized and unrealized gains and losses, and the contributions, withdrawals, fees, expenses and income of the period. If your firm has no account with that ID, the response is `404`.

📄️Get the model weights of an account

Returns the target weight of each security of the model assigned to the account with the given ID, or else to its household. The response is `200` with `data: null` when neither the account nor its household has a model, and `model` is `{}` when the account has no model and no household. Each weight is `0` when the account's current value is `0`. If your firm has no account with that ID, the response is `404`.

📄️Assign a fee structure to accounts

Assigns the fee structure in `feeStructureId` to each account in `accountsIds`, and returns each account it assigned. Send `feeStructureId` as `null` to remove the accounts' fee structure. An account ID that is not one of your firm's accounts is skipped, and the response leaves it out. Send the ID of one of your firm's fee structures, as **List fee structures** returns it.

📄️List the accounts of a household

Returns the active accounts of the household with the given ID, in order of account ID. Send `balances=true` to add each account's current holdings, balance, cash and risk allocation. If your firm has no household with that ID, the response is `404`.

📄️Update the accounts of a household

Replaces the accounts of the household with the given ID with the accounts in the request body, and returns the household's active accounts after the change, in order of account ID. The household's accounts you leave out are left with no household. An account ID that is not one of your firm's accounts is skipped. If your firm has no household with that ID, the response is `404` and nothing changes.

📄️Get the lot selection settings of a household's accounts

Returns the lot selection method, capital gains budgets, tax rates and tax budget of each active account of the household with the given ID, in order of account name, and your firm's defaults, which an account uses where it has no value of its own. If your firm has no household with that ID, the response is `404`.

📄️Update the lot selection settings of a household's accounts

Replaces the lot selection method, capital gains budgets, tax rates and tax budget of each account in `accounts` with the ones you send, and returns the lot selection settings of the household with the given ID as **Get the lot selection settings of a household's accounts** returns them. A field you leave out or send as `null` is cleared, and the account uses your firm's default for it. Accounts you leave out do not change. An account ID that is not one of your firm's accounts is skipped. Send the IDs of the household's accounts. If your firm has no household with that ID, the response is `404`.