Create a charge

POST /api/v1/charge

Create recurring charge for a given plan or client. Amount can be a fixed amount or a percentage of a plans value.

Headers

application/json

Body Required

  • chargeable_type string Required

    Model type that can have charges added to them. Valid types are: client, plan

  • chargeable_uuid string Required

    UUID of chargeable model.

  • seller_uuid string Required

    Employee that will be earning the revenue for this charge

  • payment_origin string Required

    Who is expected to pay this. Values are: client, provider and unknown

  • type string Required

    Expectation type. Possible values are: fee and commission

  • category string Required

    Expectation category. Possible 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 and unknown

  • recurring boolean Required

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

  • frequency string Required

    Expected charge frequency from the given start date. Valid frequencies are: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, and annually

  • start_date date Required

    Date the recurring charge starts from.

  • end_date 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

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

  • tax_exempt boolean Required

    Denotes whether the charge is exempt from tax.

  • exclude_from_rmar string Required

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

  • advice_type string Required

    Advice type for the charge. Possible values are: independent and restricted

  • service_type string Required

    Service type for the charge. Possible values are: initial, one_off and ongoing. Recurring charges must be "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. Possible values are: adviser_charge, clawback, commission, other_fee and unknown. Recurring charges must be "ongoing"

  • advice_area array[string]

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

  • notes string

    Notes to add on to the charge.
POST /api/v1/charge 
curl \
 -X POST https://api.plannrcrm.com/api/v1/charge \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"chargeable_type":"plan","chargeable_uuid":"ab132445-9e5c-4f21-847a-a43e1df130d3","seller_uuid":"f90d2816-c0d1-4d32-a605-bd134897c5d4","payment_origin":"81a7c056-20b1-4cb4-a659-81d2d66a1cbb","type":"fee","category":"ongoing_fee","recurring":true,"frequency":"monthly","start_date":"2024-07-16","end_date":"2025-08-16","amount":10000,"percentage":0.75,"tax_exempt":true,"exclude_from_rmar":"string","advice_type":"independent","service_type":"ongoing","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}],"notes":"Ut sunt et amet nulla tempor aliquip."}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "chargeable_type": "plan",
  "chargeable_uuid": "ab132445-9e5c-4f21-847a-a43e1df130d3",
  "seller_uuid": "f90d2816-c0d1-4d32-a605-bd134897c5d4",
  "payment_origin": "81a7c056-20b1-4cb4-a659-81d2d66a1cbb",
  "type": "fee",
  "category": "ongoing_fee",
  "recurring": true,
  "frequency": "monthly",
  "start_date": "2024-07-16",
  "end_date": "2025-08-16",
  "amount": 10000,
  "percentage": 0.75,
  "tax_exempt": true,
  "exclude_from_rmar": "string",
  "advice_type": "independent",
  "service_type": "ongoing",
  "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
    }
  ],
  "notes": "Ut sunt et amet nulla tempor aliquip."
}