Get a charge split schema

GET /api/v1/charge-split-schema/{chargeSplitSchema_uuid}

Responses

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

      Introducer split name

    • min_percentage integer

      Minimum percentage of overall charge introducer can be entitled to

    • max_percentage integer

      Maximum percentage of overall charge introducer can be entitled to

    • default_percentage integer

      Default percentage of overall charge introducer can be entitled to. Must be between minimum and maximum

    • percentage_paid_by_firm integer

      Percentage of the introducer's cut of the expected amount to be paid by the firm

    • percentage_paid_by_adviser integer

      Percentage of the introducer's cut of the expected amount to be paid by the selling adviser

    • can_change_transfer_fci boolean

      Whether the value for FCI contributions can be changed. Will only apply to advisers

    • default_transfer_fci boolean

      Default value to whether the introducer will be recognised for FCI contributions. Will only apply to advisers

    • can_change_initial boolean

      Whether the value for initial charges can be changed

    • default_initial boolean

      Default value to whether this charge split schema will be applied to initial charges

    • can_change_ongoing boolean

      Whether the value for ongoing charges can be changed

    • default_ongoing boolean

      Default value to whether this charge split schema will be applied to ongoing charges

    • valid_for_advisers boolean

      Whether this charge split schema can be applied for adviser accounts

    • valid_for_clients boolean

      Whether this charge split schema can be applied for client accounts

    • valid_for_introducers boolean

      Whether this charge split schema can be applied for introducer accounts

    • visible_to_advisers boolean

      Whether this charge split schema is visible to advisers to use
GET /api/v1/charge-split-schema/{chargeSplitSchema_uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/charge-split-schema/chargeSplitSchema_uuid \
 -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) 
{
  "name": "Basic Introducer Rate",
  "uuid": "0476afd2-f53d-4c6a-acd6-f8d3d28d93da",
  "created_at": "2024-10-16T11:10:17+01:00",
  "updated_at": "2024-10-16T11:10:17+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
}