Body

• chargeable_type string Required

  Model type that can have charges added to them.

  Values are client or plan.

• chargeable_uuid string(uuid) Required

  UUID of chargeable model.

• seller_uuid string(uuid) Required

  Employee that will be earning the revenue for this charge

• payment_origin string Required

  Who is expected to pay this.

  Value	Description
  client	Client
  provider	Provider
  unknown	Unknown

  Values are client, provider, or unknown.

• type string Required

  Expectation type.

  Value	Description
  fee	Fee
  commission	Commission

  Values are fee or commission.

• category string Required

  Expectation category.

  Value	Description
  adhoc	Adhoc
  administration	Administration
  adjustment	Adjustment
  bond_renewal	Bond Renewal
  clawback	Clawback
  dss_rebate	Dss Rebate
  fund	Fund
  indemnity	Indemnity
  initial_fee	Initial Fee
  level	Level
  non_indemnity	Non Indemnity
  one_off	One Off
  ongoing_fee	Ongoing Fee
  other_fee	Other Fee
  procuration_fee	Procuration Fee
  protected_rights	Protected Rights
  renewal	Renewal
  switch	Switch
  unknown	Unknown

  Values are adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch, or unknown.

• recurring boolean Required

  Determines whether the charge recurs at a set frequency. False for a one off statement transactions

• frequency string

  Charge frequency from the given start date.

  Value	Description
  daily	Daily
  weekly	Weekly
  fortnightly	Fortnightly
  four_weekly	Four Weekly
  monthly	Monthly
  bimonthly	Bimonthly
  quarterly	Quarterly
  biannually	Biannually
  annually	Annually

  Values are daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, or annually.

• start_date string(date) Required

  Date the recurring charge starts from.

• end_date string(date)

  Date the recurring statement transactions will stop. Leave blank for indefinitely or until charge schedule is deleted.

• amount integer

  The fixed amount value as an integer in pennies. Required when not providing a percentage or when chargeable_type is client.

• percentage number(float)

  Percentage of plans value as a charge. Required when not providing a fixed amount. Cannot use percentage for a client chargeable_type.

  Minimum value is 0.0, maximum value is 100.0.

• percentage_frequency string

  Frequency that describes what the percentage is calculated from.

  Value	Description
  daily	Daily
  weekly	Weekly
  fortnightly	Fortnightly
  four_weekly	Four Weekly
  monthly	Monthly
  bimonthly	Bimonthly
  quarterly	Quarterly
  biannually	Biannually
  annually	Annually

  Values are daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, or annually.

• tax_exempt boolean Required

  Denotes whether the charge is exempt from tax.

• tax number(float)

  Percentage tax to be added on to net amount of charge. Will use fims default tax rate if not provided and charge is not tax exempt.

  Minimum value is 0.0, maximum value is 100.0.

• exclude_from_rmar boolean Required

  Whether or not to exclude this charge and its expectations from RMAR reporting.

• advice_type string Required

  Advice type for the charge.

  Value	Description
  independent	Independent
  restricted	Restricted

  Values are independent or restricted.

• service_type string Required

  Service type for the charge. Recurring charges must be "ongoing"

  Value	Description
  initial	Initial
  one_off	One Off
  ongoing	Ongoing

  Values are initial, one_off, or ongoing.

• rmar_type string

  RMAR type for the charge. Can only be set for adjustments and unknown charge categories. All other categories are automatically calculated. Recurring charges must be "ongoing"

  Value	Description
  adviser_charge	Adviser Charge
  clawback	Clawback
  commission	Commission
  other_fee	Other Fee
  unknown	Unknown

  Values are adviser_charge, clawback, commission, other_fee, or unknown.

• premium_uuid string(uuid)

  UUID of premium a percentage charge is based from.

• advice_area object

  RMAR advice area values. Required for charges made directly on a client. All amounts are in pennies and must total the charge net amount.

  Hide advice_area attributes Show advice_area attributes object

  • deposit integer

    Amount for deposit advice area.

  • non_regulated integer

    Amount for non regulated advice area.

  • non_rmar integer

    Amount for non RMAR advice area.

  • non_investment_insurance integer

    Amount for non investment insurance advice area.

  • regulated_mortgage integer

    Amount for regulated mortgage advice area.

  • retail_investment integer

    Amount for retail investment advice area.

  • other_fca_regulated integer

    Amount for other FCA regulated advice area.

  • unknown integer

    Amount for unknown advice area.

• notes string

  Notes to add on to the charge.