Update a charge split

PUT /api/v1/charge-split/{chargeSplit_uuid}

Personal access token & O auth2

Headers

Path parameters

chargeSplit_uuid string Required

application/json

Body

percentage number

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

Whether the account will receive FCI recognition for this charge split
initial boolean

Whether this charge split will be applied to initial charges
ongoing boolean

Whether this charge split will be applied to ongoing charges
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

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.
- splitable_type string
  
  The model type this charge split belongs to.
- splitable object
  
  Model this charge split belongs to e.g. plan
- account object
  
  Account who will be receiving this charge split
- charge_split_schema object
  
  The charge split schema model that defined the parameters of this charge split
- 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

PUT /api/v1/charge-split/{chargeSplit_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/charge-split/chargeSplit_uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"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
{
  "percentage": 12.5,
  "transfer_fci": true,
  "initial": true,
  "ongoing": true,
  "apply_to_plans": true
}

Response examples (200)

{
  "uuid": "ed3f1c88-9fb2-438c-a3e0-aba8dadc389b",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "6920d849-40e0-4266-97b8-9443e79f9893",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:21+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:21+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:21+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:21+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-22T13:44:21+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:21+01:00"
  },
  "initial": "example",
  "ongoing": "example",
  "splitable": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "f0941e92-e956-422c-a65d-8e4d1fee145c",
    "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",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2025-04-22T13:44:21+01:00",
    "valued_at": "2025-04-22T13:44:21+01:00",
    "created_at": "2025-04-22T13:44:21+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-22T13:44:21+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-04-22T13:44:21+01:00",
    "review_date": "2024-04-22",
    "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",
    "original_valued_at": "2025-04-21T13:44:21+01:00",
    "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-04-22",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "created_at": "2025-04-22T13:44:21+01:00",
  "percentage": 12.5,
  "updated_at": "2025-04-22T13:44:21+01:00",
  "transfer_fci": "example",
  "apply_to_plans": true,
  "splitable_type": "plan",
  "charge_split_schema": {
    "name": "Basic Introducer Rate",
    "uuid": "31a7e200-d1ec-4f87-ad83-997b4d2a1e60",
    "created_at": "2025-04-22T13:44:21+01:00",
    "updated_at": "2025-04-22T13:44:21+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
  },
  "percentage_paid_by_firm": 0,
  "percentage_paid_by_adviser": 100
}