Get all charge split schemas

GET /api/v1/charge-split-schema

Headers

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]
  
  Additional properties are allowed.

GET /api/v1/charge-split-schema

curl \
 -X GET https://api.plannrcrm.com/api/v1/charge-split-schema \
 -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}"

Response examples (200)

{
  "data": [
    {
      "name": "Basic Introducer Rate",
      "uuid": "03a5dc5e-f133-4fc6-a5a5-7ac27e5101d7",
      "created_at": "2024-11-20T13:24:04+00:00",
      "updated_at": "2024-11-20T13:24:04+00: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
    }
  ]
}