Update an Account

Provide an account to update. Then entire account object must be provided to the PUT request.

Editable Fields:

  • benchmark_ids
  • fee_structure_ids
  • billing_split_ids
  • notes
  • nickname
  • household_id To remove an account from a household, provide null in this field.
  • target_allocation_id
  • first_performance_date
  • payment_source
  • first_billable_date
  • investment_model_id
  • required_cash
  • unsupervised_securities_ids
  • buy_securities_ids
  • sell_securities_ids
  • do_not_buy_securities_ids
  • do_not_sell_securities_ids
  • required_cash_frequency
Path Params
integer
required

Unique ID for the object

Body Params
integer

Unique ID for this account object

string

Populated from custodian data

integer

ID of the owning firm

string
deprecated

See Entity ID Prefixes

integer

Household Id this account belongs to

string
deprecated

The account short name or "SNAM"

date-time

Date of account inception, if applicable. May differ from opening date.

date-time
deprecated

Date the account was closed, if applicable

string
enum
deprecated

Status of the account object. It can be funded, papered, closed or slate. Funded account is considered active account, Papered or Closed account is inactive, and Stale is unknown

Allowed:
benchmarks_ids
array of integers

List of ids for benchmarks associated with the account

Benchmark id list
boolean

Is this entity an account? (Yes)

boolean

Is this entity a household? (No)

string

Account number

string
enum

Custodian the account data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services

string

First line address

string

Second line address

string

Third line address

string

City of the account-holder

string

State of the account-holder

string

Zip code of the account-holder

string

Country of the account-holder

string

Type of account. Example, IRA Roth, 401k, etc.

boolean

True if this account is tax deferrable. This data is typically provided by the financial institution

boolean

True if this account is taxable. This data is typically provided by the financial institution

string
enum

C=billed at the custodian D=billed directly

Allowed:
date-time

The date at which this account begins accruing advisor fees

billing_splits_ids
array of integers

List of ids of splits associated with this account

Billing splits id list
fee_structures_ids
array of integers

List of ids of fee structures associated with this account

Fee structure id list
string

Display name of the account

string

Display number of the account

boolean

Is this account directly billed?

boolean

Is this account billed at the custodian level?

boolean
deprecated

Is this an active account?

boolean
deprecated

Is this a closed account?

string

Full name of the custodian the account data comes from

boolean

Does this account have a custodian name?

date-time

First date when cost basis information is known for this account

date-time

Most recent date when cost basis information is known for this account

date

First date when positions information is known for this account

date

Most recent date when positions information is known for this account

date
deprecated

Earliest date at which this account was quarantined for data reconciliation, or null if it's not currently quarantined

date

Lastest date when the reporting information was recorded for this account

date

First date when transaction information was recorded for this account

date

Latest date when transaction information was recorded for this account

date-time
deprecated

Date when the account was first funded

integer

Target allocation id associated with this account

integer

Investment model id associated with this account

number

Required cash amount in dollars to be set aside for withdrawals

string
deprecated

[Deprecated] Please refer to the advisor_codes field. advisor_code will be removed in future versions.

advisor_codes
array of strings

The list of Advisor Codes that the account is associated with.

Advisor Codes
buy_securities_ids
array of integers

Securities specifically to buy

Buy securities ids
do_not_buy_securities_ids
array of integers

Securities specifically to not buy

Do not buy securities ids
sell_securities_ids
array of integers

Securities specifically to sell

Sell securiteis ids
do_not_sell_securities_ids
array of integers

Securities specifically to not sell

Do not sell securities ids
string

General notes on account entered by user

unsupervised_securities_ids
array of integers

Securities to be excluded in trading integrations (e.g. rebalancing calculations)

Unsupervised securities ids
string
enum

Required cash frequency for this account object. M for monthly, Q for quarterly, O for one time

Allowed:
date-time

First performance date for this account

date-time
deprecated

Date when the account was first papered

date-time

Date for the last portfolio data for this account object

string

Tokenized representation of the account's owning tax ID.

boolean

Boolean that determines whether or not an account is a pledged account.

string

Raw margin account designation as received directly from the custodian. Values vary by custodian (e.g., True/False for SWB, "1"/"R"/"T"/"Z"/blank for NFS, "Y"/"N" for PER, "Margin"/"Portfolio Margin"/"Cash" for IBK).

restrictions
array of objects

List of restriction descriptions or restriction codes as provided by the custodian.

Account Restrictions
string

The prime brokerage indicator passed through from the custodian (if they provide it).

Please consulte the data dictionary for details about possible values from the custodian.

string

Raw account type passed through from custodians.

string

Raw registration type passed through from custodians.

registration_lines_reported
array of strings

Raw registration lines passed through from custodians.

Registration Lines Reported
date-time

Timestamp for when the record was created

date-time

Timestamp for when the record was updated

Responses

Language
Credentials
Bearer
Bearer
Response
Choose an example:
application/json