Create a charge split

POST /api/v1/charge-split

Headers

application/json

Body Required

splitable_type string Required

The model type the charge split is being added to. Valid options are: client, plan, charge
splitable_uuid string Required

The model UUID belonging to the splitable_type the charge split is being added to
account_uuid string Required

The account UUID of who will be receiving this charge split
charge_split_schema_uuid string Required

The charge split schema that defines the parameters of this charge split
percentage number Required

Percentage of charge that the introducer will receive. Must be within the provided charge split schema min and max percentage bounds
transfer_fci boolean Required

Whether the account will receive FCI recognition for this charge split. Provided charge split schema must allow option to be changed
initial boolean Required

Whether this charge split will be applied to initial charges. Provided charge split schema must allow option to be changed
ongoing boolean Required

Whether this charge split will be applied to ongoing charges. Provided charge split schema must allow option to be changed
apply_to_plans boolean

When adding a charge split against a client, you can choose whether to automatically apply to the client's plans too. Must be null or false for a plan splitable_type

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.
- splitable_type string
  
  The model type this charge split belongs to.
- splitable object
  
  Model this charge split belongs to e.g. plan
  
  Additional properties are allowed.
- account object
  
  Account who will be receiving this charge split
  
  Additional properties are allowed.
- charge_split_schema object
  
  The charge split schema model that defined the parameters of this charge split
  
  Additional properties are allowed.
- percentage number
  
  How much of the expectation the given account is expected to receive
- percentage_paid_by_firm integer
  
  How much of the charge split amount will be paid by the firm
- percentage_paid_by_adviser integer
  
  How much of the charge split amount will be paid by the adviser
- transfer_fci string
  
  Whether the account will receive FCI recognition for this expectation amount
- initial string
  
  Whether the charge split will apply to initial charges
- ongoing string
  
  Whether the charge split will apply to ongoing charges
- apply_to_plans boolean
  
  When adding this charge split to a client, setting this to true will automatically apply the charge split to all of the client's plans

POST /api/v1/charge-split

curl \
 -X POST https://api.plannrcrm.com/api/v1/charge-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 '{"splitable_type":"plan","splitable_uuid":"38c477c1-33b8-4495-86d8-33013fcd1bbe","account_uuid":"69cb5895-8994-48c0-8fc0-6fd3f93f0a26","charge_split_schema_uuid":"d386a7ad-054d-4d13-8c50-8fa20686c55d","percentage":12.5,"transfer_fci":true,"initial":true,"ongoing":true,"apply_to_plans":true}'

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
{
  "splitable_type": "plan",
  "splitable_uuid": "38c477c1-33b8-4495-86d8-33013fcd1bbe",
  "account_uuid": "69cb5895-8994-48c0-8fc0-6fd3f93f0a26",
  "charge_split_schema_uuid": "d386a7ad-054d-4d13-8c50-8fa20686c55d",
  "percentage": 12.5,
  "transfer_fci": true,
  "initial": true,
  "ongoing": true,
  "apply_to_plans": true
}

Response examples (201)

{
  "uuid": "ea044593-cfab-4216-8c24-d4333d1fc378",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "18be4b19-aad9-48c3-b47c-d6cf0620a4ef",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:32+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:32+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-01-17T11:18:32+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:32+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:32+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:32+00:00"
  },
  "initial": "example",
  "ongoing": "example",
  "splitable": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "1b9614ec-5acb-4977-b344-356b0ca9ef3d",
    "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
    "cases": "App\\Http\\Resources\\CasesResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
    "client": "App\\Http\\Resources\\AccountResource",
    "covers": "App\\Http\\Resources\\Plans\\CoverResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "status": "inactive",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2025-01-17T11:18:32+00:00",
    "valued_at": "2025-01-17T11:18:32+00:00",
    "created_at": "2025-01-17T11:18:32+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-01-17T11:18:32+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-01-17T11:18:32+00:00",
    "review_date": "2024-01-17",
    "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "under_advice": true,
    "abstract_type": "asset",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "is_wrap_child": false,
    "linked_owners": "App\\Http\\Resources\\AccountResource",
    "policy_number": "AVIVA-123",
    "show_on_joint": true,
    "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
    "can_be_deleted": "false",
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        }
      }
    },
    "inactive_reason": "claimed",
    "is_group_scheme": false,
    "is_wrap_product": false,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "proposal_reference": "AB123456",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": false,
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      }
    },
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2024-01-17",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "created_at": "2025-01-17T11:18:32+00:00",
  "percentage": 12.5,
  "updated_at": "2025-01-17T11:18:32+00:00",
  "transfer_fci": "example",
  "apply_to_plans": true,
  "splitable_type": "plan",
  "charge_split_schema": {
    "name": "Basic Introducer Rate",
    "uuid": "ed709ffe-4b5b-4683-a8a1-625c492a6e1a",
    "created_at": "2025-01-17T11:18:32+00:00",
    "updated_at": "2025-01-17T11:18:32+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
  },
  "percentage_paid_by_firm": 0,
  "percentage_paid_by_adviser": 100
}