Get all charge splits

GET /api/v1/charge-split/{splitableType}/{splitableUuid}

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • splitableType string Required
  • splitableUuid string Required

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

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

  • 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
      • splitable_type string
      • splitable object
        Hide splitable attributes Show splitable attributes object
        • uuid string
        • created_at string
        • updated_at string
        • opened_at string
        • name string
        • type string
        • sub_type string
        • abstract_type string
        • policy_number string
        • proposal_reference string
        • status string
        • inactive_at string
        • inactive_reason string
        • agency_in_your_name boolean
        • agency_in_your_name_from string
        • originally_sold_by_firm boolean
        • under_advice boolean
        • visible_on_client_portal boolean
        • include_in_client_valuation boolean
        • show_on_joint boolean
        • review_date string
        • on_panel boolean
        • is_group_scheme boolean
        • is_sub_group_scheme boolean
        • is_group_scheme_member boolean
        • advice_area string
        • main_account string
        • sub_accounts string
        • provider string
        • covers string
        • claims string
        • total_benefit_amount object
          Hide total_benefit_amount attributes Show total_benefit_amount attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • total_benefits object
          Hide total_benefits attributes Show total_benefits attributes object
          • critical_illness object
            Hide critical_illness attributes Show critical_illness attributes object
            • amount object
              Hide amount attributes Show amount attributes object
              • example string
              • description string
            • formatted object
              Hide formatted attributes Show formatted attributes object
              • example string
              • description string
            • currency object
              Hide currency attributes Show currency attributes object
              • example string
              • description string
          • family_income_benefit object
            Hide family_income_benefit attributes Show family_income_benefit attributes object
            • amount object
              Hide amount attributes Show amount attributes object
              • example string
              • description string
            • formatted object
              Hide formatted attributes Show formatted attributes object
              • example string
              • description string
            • currency object
              Hide currency attributes Show currency attributes object
              • example string
              • description string
        • latest_valuations string
        • value object
          Hide value attributes Show value attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • valued_at string
        • original_valued_at string
        • client string
        • accounts string
        • seller string
        • linked_owners string
        • linked_plans string
        • statistics object
          Hide statistics attribute Show statistics attribute object
          • recent_growth integer
        • cases string
        • tags string
        • is_wrap_product boolean
        • is_wrap_child boolean
        • wrap string
        • wrap_children string
        • can_be_deleted string
        • contract_enquiry_account string
        • custom_fields string
        • external_references string
      • account object
        Hide account attributes Show account attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email string
        • firm string
        • primary_phone_number string
        • primary_email string
        • current_time_entry string
        • assigned_adviser string
        • assigned_administrator string
        • assigned_paraplanner string
        • introduced_by string
        • groups string
        • tags string
        • owners string
        • first_contact_date string
        • next_review_date string
        • previous_review_date string
        • anniversary_review_date string
        • with_login boolean
        • has_joint_account boolean
        • can_be_deleted string
        • joint_account_circle string
        • ownership_percentage integer
        • inactive_at string
        • custom_fields string
        • external_references string
      • charge_split_schema object
        Hide charge_split_schema attributes Show charge_split_schema 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
      • percentage number
      • percentage_paid_by_firm integer
      • percentage_paid_by_adviser integer
      • transfer_fci string
      • initial string
      • ongoing string
      • apply_to_plans boolean
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/charge-split/architecto/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    {
      "uuid": "172ef2df-1603-457d-bf19-1f12d460a7fc",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ec3cd86f-e6db-49fd-b825-930702d45b04",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-25T15:10:47+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:47+01:00",
        "with_login": true,
        "inactive_at": "2025-06-25",
        "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-06-25T15:10:47+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-25T15:10:47+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-06-25T15:10:47+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-25T15:10:47+01:00"
      },
      "initial": "example",
      "ongoing": "example",
      "splitable": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "c5ac41e4-9c75-4266-b603-c20c7aa98827",
        "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-06-25T15:10:47+01:00",
        "valued_at": "2025-06-25T15:10:47+01:00",
        "created_at": "2025-06-25T15:10:47+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-06-25T15:10:47+01:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-06-25T15:10:47+01:00",
        "review_date": "2024-06-25",
        "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-06-24T15:10:47+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-06-25",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "created_at": "2025-06-25T15:10:47+01:00",
      "percentage": 12.5,
      "updated_at": "2025-06-25T15:10:47+01:00",
      "transfer_fci": "example",
      "apply_to_plans": true,
      "splitable_type": "plan",
      "charge_split_schema": {
        "name": "Basic Introducer Rate",
        "uuid": "c29791bb-9e0b-4bd4-8ffa-78e94df45e6d",
        "created_at": "2025-06-25T15:10:47+01:00",
        "updated_at": "2025-06-25T15:10:47+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
    }
  ]
}