Fee structures
A fee structure sets how AdviceCloud calculates and collects the fee of each account or household assigned to it. In the console, fee structures are on the Fee Structures tab of the Billing page. You assign fee structures to accounts and households, and choose your firm's default fee structure, in the console; the operations of this tag do not assign fee structures.
The calculation type sets which fields give the fee:
Flat Rate: an annual fee rate,flatRateFlat Account FeeandFlat Group Fee: an annual fee in US dollars,flatDollarFeeDrop ThroughandTiered: balance ranges, each with its annual fee rate,tiersNo FeeandNo Fee - Excl from AUM: no fee
Fee rates are percents, from 0 to 100. Balances and flat fees are in US dollars. A tier with no upper limit has max 999999999. The tiers of a fee structure come in no set order; sort them by min.
The request body names three values differently from the response: billingFrequency is returned as frequency, billingCycle as annualCycle or quarterCycle, and feeValue as flatRate or flatDollarFee.
To change a fee structure, call Update a fee structure, which replaces the whole fee structure, tiers included. Before you delete a fee structure, make sure that no account or household is assigned it, as Delete a fee structure describes.
List fee structures
Returns your firm's fee structures in the order they were created, each with its tiers.
Create a fee structure
Creates a fee structure. Send `feeValue` for a `Flat Rate`, `Flat Account Fee` or `Flat Group Fee` fee structure, and `tiers` for a `Drop Through` or `Tiered` one. `tiers` is required: send `[]` for a calculation type that uses no tiers.
Get a fee structure
Returns the fee structure with the given ID, with its tiers. If your firm has no fee structure with that ID, the response is `404`.
Update a fee structure
Replaces the fee structure with the given ID with the one in the request body. Send every required field, as for **Create a fee structure**. A `billingCycle` or `feeValue` you leave out is cleared, and the tiers you send replace all of the current tiers. Accounts and households assigned the fee structure keep it. If your firm has no fee structure with that ID, the response is `404` and nothing changes.
Delete a fee structure
Deletes the fee structure with the given ID and its tiers. Returns `200` with `deleted: true`, or `404` if your firm has no fee structure with that ID. Before you delete a fee structure, make sure that no account or household is assigned it and that it is not your firm's default fee structure.