Account cash settings

Account cash settings are the cash target, cash triggers and cash split of each of your firm's accounts. The console shows them on the Accounts tab of the Cash page, and on the Cash & Billing tab of an account.

An account can be assigned a cash setting, cashSettingId, and also stores its own cash target and cash triggers. For an account that is assigned a cash setting, List account cash settings gives the cash target and cash triggers of the cash setting, while Get the cash settings of an account gives the values stored on the account. Assigning a cash setting does not change the values stored on the account. The cash split is always the account's own.

The fields have the units and ranges of Cash settings: percents from 0 to 100, sent in responses as decimal strings, and dollar amounts in US dollars.

📄️List account cash settings

Returns the cash settings of your firm's active accounts, in order of account ID. For an account that is assigned a cash setting, the cash target and cash triggers are those of the cash setting, and the cash split is the account's own. For an account with no cash setting, all values are the account's own.

📄️Assign a cash setting to accounts

Assigns the cash setting in `cashSettingId` to each of your firm's active accounts in `accountIds`, or leaves them with no cash setting when `cashSettingId` is `null`. The cash target, cash triggers and cash split stored on each account do not change. An account ID that is not one of your firm's active accounts is left unchanged, and `updatedCount` does not count it. If your firm has no cash setting with the ID in `cashSettingId`, the response is `404` and nothing changes.

📄️Get the cash settings of an account

Returns the cash target, cash triggers and cash split stored on the account with the given ID, and the ID of the cash setting assigned to it. For an account that is assigned a cash setting, these are the values stored on the account, not those of the cash setting; **List account cash settings** gives the cash target and cash triggers of the cash setting. If your firm has no account with that ID, the response is `404`.

📄️Update the cash settings of an account

Replaces the cash target, cash triggers and cash split stored on the account with the given ID with the ones in the request body, and assigns the account the cash setting in `cashSettingId`. Send every required field. A dollar amount, percent or cash split you leave out is cleared, and a `cashSettingId` you leave out or send as `null` leaves the account with no cash setting. Returns the cash settings of the account as **Get the cash settings of an account** returns them. If your firm has no account with that ID, or no cash setting with the ID in `cashSettingId`, the response is `404` and nothing changes.