Get all charge split schemas

GET /api/v1/charge-split-schema
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Name to filter by

  • filter[valid_for_advisers] boolean

    Only include charge split schemas which are valid for advisers

  • filter[valid_for_clients] boolean

    Only include charge split schemas which are valid for clients

  • filter[valid_for_introducers] boolean

    Only include charge split schemas which are valid for introducers

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • min_percentage integer
      • max_percentage integer
      • default_percentage integer
      • percentage_paid_by_firm integer
      • percentage_paid_by_adviser integer
      • can_change_transfer_fci boolean
      • default_transfer_fci boolean
      • can_change_initial boolean
      • default_initial boolean
      • can_change_ongoing boolean
      • default_ongoing boolean
      • valid_for_advisers boolean
      • valid_for_clients boolean
      • valid_for_introducers boolean
      • visible_to_advisers boolean
GET /api/v1/charge-split-schema 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/charge-split-schema' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Basic Introducer Rate",
      "uuid": "04399ff1-0c72-4ca6-bfa4-9d17ba919a62",
      "created_at": "2025-06-26T11:37:10+01:00",
      "updated_at": "2025-06-26T11:37:10+01:00",
      "max_percentage": 20,
      "min_percentage": 10,
      "default_initial": true,
      "default_ongoing": true,
      "valid_for_clients": true,
      "can_change_initial": true,
      "can_change_ongoing": true,
      "default_percentage": 15,
      "valid_for_advisers": true,
      "visible_to_advisers": true,
      "default_transfer_fci": true,
      "valid_for_introducers": true,
      "can_change_transfer_fci": true,
      "percentage_paid_by_firm": 25,
      "percentage_paid_by_adviser": 75
    }
  ]
}