Create an adviser split

POST /api/v1/adviser-split

Headers

application/json

Body Required

name string Required

The name of the adviser split
firm_percentage number Required

The percentage held by the firm on a charge
adviser_percentage number Required

The percentage held by the selling adviser on a charge
type string Required

Valid types are 'plan' or 'adviser'. Whehther or not this adviser split will be assigned directly to an adviser, or at a plan level to override the selling adviser's adviser split.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  The name of the adviser split
- firm_percentage integer
  
  The percentage held by the firm on a charge
- adviser_percentage integer
  
  The percentage held by the selling adviser on a charge
- type string
  
  Whether this adviser split is for an adviser or a plan charge

POST /api/v1/adviser-split

curl \
 -X POST https://api.plannrcrm.com/api/v1/adviser-split \
 -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 '{"name":"Trainee Rate","firm_percentage":30.0,"adviser_percentage":70.0,"type":"plan"}'

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
{
  "name": "Trainee Rate",
  "firm_percentage": 30.0,
  "adviser_percentage": 70.0,
  "type": "plan"
}

Response examples (201)

{
  "name": "Trainee Rate",
  "type": "adviser",
  "uuid": "7bf49f1a-8031-431a-936e-702f49194b0d",
  "created_at": "2024-10-16T11:10:17+01:00",
  "updated_at": "2024-10-16T11:10:17+01:00",
  "firm_percentage": 30,
  "adviser_percentage": 30
}