PUT /api/v1/charge/{uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • seller_uuid string(uuid)

    Employee that will be earning the revenue for this charge

  • payment_origin string

    Who is expected to pay this charge.

    Value Description
    client Client
    provider Provider
    unknown Unknown

    Values are client, provider, or unknown.

  • type string

    Expectation type.

    Value Description
    fee Fee
    commission Commission

    Values are fee or commission.

  • category string

    Expectation category.

  • recurring boolean

    Whether or not this charge recurring on a frequent basis

  • frequency string

    Expected 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)

    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

    Denotes whether the charge is exempt from tax.

  • tax number(float)

    Percentage tax to be added on to net amount of charge. Will use firms 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

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

  • advice_type string

    Advice type for the charge.

    Value Description
    independent Independent
    restricted Restricted

    Values are independent or restricted.

  • service_type string

    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.

  • advice_area object

    RMAR advice area values. All advice types are required when updating amounts or advice area amounts 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.
PUT /api/v1/charge/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/charge/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"seller_uuid":"7582789a-d172-4b53-ae47-bc548ac63d64","payment_origin":"client","type":"fee","category":"commission","recurring":true,"frequency":"daily","start_date":"2025-09-24","end_date":"2026-10-24","amount":10000,"percentage":10.0,"percentage_frequency":"daily","tax_exempt":true,"tax":17.5,"exclude_from_rmar":false,"advice_type":"independent","service_type":"initial","rmar_type":"adviser_charge","advice_area":{"deposit":7500,"unknown":0,"non_rmar":0,"non_regulated":0,"retail_investment":0,"regulated_mortgage":2500,"other_fca_regulated":0,"non_investment_insurance":0}}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "seller_uuid": "7582789a-d172-4b53-ae47-bc548ac63d64",
  "payment_origin": "client",
  "type": "fee",
  "category": "commission",
  "recurring": true,
  "frequency": "daily",
  "start_date": "2025-09-24",
  "end_date": "2026-10-24",
  "amount": 10000,
  "percentage": 10.0,
  "percentage_frequency": "daily",
  "tax_exempt": true,
  "tax": 17.5,
  "exclude_from_rmar": false,
  "advice_type": "independent",
  "service_type": "initial",
  "rmar_type": "adviser_charge",
  "advice_area": {
    "deposit": 7500,
    "unknown": 0,
    "non_rmar": 0,
    "non_regulated": 0,
    "retail_investment": 0,
    "regulated_mortgage": 2500,
    "other_fca_regulated": 0,
    "non_investment_insurance": 0
  }
}