POST /api/v1/plans/{plan_uuid}/group-scheme-members
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required

    uuid The UUID of the group scheme plan.

application/json

Body

  • account_uuid string(uuid) Required

    The client account that will be the member on the group scheme. Must already be a staff member on the business client that the plan belongs to.

  • status string Required

    Plan status for the member.

    Value Description
    active Active
    inactive Inactive
    proposed Proposed

    Values are active, inactive, or proposed.

  • inactive_status string

    Optional inactive status when the status is inactive.

    Value Description
    accepted Accepted
    agency_transferred Agency Transferred
    cancelled Cancelled
    claimed Claimed
    complete Complete
    death_event Death Event
    deferred Deferred
    drawdown Drawdown
    expired Expired
    full_drawdown Full Drawdown
    issued Issued
    lapsed Lapsed
    matured Matured
    not_proceeded_with Not Proceeded With
    not_taken_up Not Taken Up
    offered Offered
    paid_up Paid Up
    partial_drawdown Partial Drawdown
    partial_surrender Partial Surrender
    proposed Proposed
    prospect Prospect
    refunded Refunded
    refused Refused
    surrendered Surrendered
    transfer Transfer
    transferred Transferred
    underwriting Underwriting
    vested Vested
    declined Declined
    encashment Encashment
    left_service Left Service
    premium_holiday Premium Holiday
    other Other

    Values are accepted, agency_transferred, cancelled, claimed, complete, death_event, deferred, drawdown, expired, full_drawdown, issued, lapsed, matured, not_proceeded_with, not_taken_up, offered, paid_up, partial_drawdown, partial_surrender, proposed, prospect, refunded, refused, surrendered, transfer, transferred, underwriting, vested, declined, encashment, left_service, premium_holiday, or other.

  • policy_number string

    Optional policy number if the group scheme has separate policy numbers per member.

    Maximum length is 255.

  • on_risk_at string(date) | null

    Date when the policy went "on risk".

  • inactive_at string(date)

    Date when the policy was made inactive.

  • pensionable_salary integer

    Optional "pensionable" salary used for group scheme pensions. Value must be in pennies for example £70,000 is 7000000

  • workplace_location string

    Optional workplace location for the group scheme member.

  • employment_division string

    Optional employment division for the group scheme member.

Responses

  • 200 application/json
    Hide response attributes Show response 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
    • shown_on_circles 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 object
      Hide main_account attributes Show main_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation string
      • is_main_account boolean
      • active_portfolio string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
    • sub_accounts array[object]
      Hide sub_accounts attributes Show sub_accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation string
      • is_main_account boolean
      • active_portfolio string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
    • provider object
      Hide provider attributes Show provider attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
    • covers array[object]
      Hide covers attributes Show covers attributes object
      • uuid string
      • created_at string
      • updated_at string
      • cover_type string
      • benefit_amount object
        Hide benefit_amount attributes Show 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
      • benefit_frequency string
      • benefit_status string
      • excess object
        Hide excess attributes Show excess 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
      • indexation number
      • client string
    • claims array[object]
      Hide claims attributes Show claims attributes object
      • uuid string
      • created_at string
      • updated_at string
      • claim_amount object
        Hide claim_amount attributes Show claim_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
      • claim_start_date string
      • claim_end_date string
      • claim_notes string
      • client 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 array[object]
      Hide latest_valuations attributes Show latest_valuations attributes object
      • uuid string
      • created_at string
      • updated_at string
      • valued_at 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
      • sub_account 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 object
      Hide client attributes Show client attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url 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
      • business_unit 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • accounts array[object]
      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url 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
      • business_unit 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • seller object
      Hide seller attributes Show seller attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url 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
      • business_unit 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • linked_owners array[object]
      Hide linked_owners attributes Show linked_owners attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url 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
      • business_unit 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • linked_plans array[object]
      Hide linked_plans attributes Show linked_plans 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
      • shown_on_circles 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
      • visible_to_circles 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
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
      • group_scheme string
      • group_scheme_member_detail object
        Hide group_scheme_member_detail attributes Show group_scheme_member_detail attributes object
        • workplace_location string
        • employment_division string
    • visible_to_circles object
      Hide visible_to_circles attributes Show visible_to_circles attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • photo_url string
      • bg_colour string
      • accounts string
      • groups string
      • joint_account_uuid string
      • login_access_level string
      • external_references string
    • statistics object
      Hide statistics attribute Show statistics attribute object
      • recent_growth integer
    • cases array[object]
      Hide cases attributes Show cases attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status string
      • type string
      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at 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
      • status_position integer
      • participants_count integer
      • participants string
      • task_board_uuid string
      • plans string
      • custom_fields string
    • tags array[object]
      Hide tags attributes Show tags attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • colour string
    • is_wrap_product boolean
    • is_wrap_child boolean
    • wrap object
      Hide wrap attributes Show wrap 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
      • shown_on_circles 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
      • visible_to_circles 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
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • wrap_children array[object]
      Hide wrap_children attributes Show wrap_children 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
      • shown_on_circles 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
      • visible_to_circles 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
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • linked_policy_numbers array[object]
      Hide linked_policy_numbers attributes Show linked_policy_numbers attributes object
      • uuid string
      • created_at string
      • updated_at string
      • linked_policy_number string
      • plan string
    • can_be_deleted string
    • contract_enquiry_account object
      Hide contract_enquiry_account attributes Show contract_enquiry_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
      • photo_url 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
      • business_unit 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • custom_fields array[object]
      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
    • external_references array[object]
      Hide external_references attributes Show external_references attributes object
      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string
    • group_scheme object
      Hide group_scheme attributes Show group_scheme 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
      • shown_on_circles 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
      • visible_to_circles 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
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
      • group_scheme string
      • group_scheme_member_detail object
        Hide group_scheme_member_detail attributes Show group_scheme_member_detail attributes object
        • workplace_location string
        • employment_division string
    • group_scheme_member_detail object
      Hide group_scheme_member_detail attributes Show group_scheme_member_detail attributes object
      • workplace_location string
      • employment_division string
POST /api/v1/plans/{plan_uuid}/group-scheme-members 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/group-scheme-members' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuid":"5ec11c1d-722c-4699-8dd9-9285231404ae","status":"active","inactive_status":"accepted","policy_number":"AVIVA-123","on_risk_at":"2023-03-26","inactive_at":"2024-03-26","pensionable_salary":7000000,"workplace_location":"London","employment_division":"Management"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "5ec11c1d-722c-4699-8dd9-9285231404ae",
  "status": "active",
  "inactive_status": "accepted",
  "policy_number": "AVIVA-123",
  "on_risk_at": "2023-03-26",
  "inactive_at": "2024-03-26",
  "pensionable_salary": 7000000,
  "workplace_location": "London",
  "employment_division": "Management"
}
Response examples (200) 
[
  {
    "uuid": "2ec9cd5d-f472-4a19-8ea7-8234da358b59",
    "created_at": "2026-05-01T11:37:31+01:00",
    "updated_at": "2026-05-01T11:37:31+01:00",
    "opened_at": "2026-05-01T11:37:31+01:00",
    "name": "Johns ISA",
    "type": "cash_account",
    "sub_type": "lifetime isa",
    "abstract_type": "asset",
    "policy_number": "AVIVA-123",
    "proposal_reference": "AB123456",
    "status": "inactive",
    "inactive_at": "2026-05-01T11:37:31+01:00",
    "inactive_reason": "claimed",
    "agency_in_your_name": true,
    "agency_in_your_name_from": "2025-05-01",
    "originally_sold_by_firm": true,
    "under_advice": true,
    "visible_on_client_portal": true,
    "include_in_client_valuation": true,
    "show_on_joint": true,
    "shown_on_circles": true,
    "review_date": "2025-05-01",
    "on_panel": true,
    "is_group_scheme": false,
    "is_sub_group_scheme": false,
    "is_group_scheme_member": true,
    "advice_area": "non_investment_insurance",
    "main_account": {
      "uuid": "826547ed-9f85-4484-b5ae-e46c03691afb",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "name": "John's ISA",
      "policy_number": "AVI-4837",
      "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource",
      "is_main_account": false,
      "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
      "statistics": {
        "recent_growth": 100
      }
    },
    "sub_accounts": [
      {
        "uuid": "bb4e70a4-9ba6-467f-aead-deb231076d47",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "name": "John's ISA",
        "policy_number": "AVI-4837",
        "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource",
        "is_main_account": false,
        "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
        "statistics": {
          "recent_growth": 100
        }
      }
    ],
    "provider": {
      "uuid": "3cbf85ab-f03b-4970-bc67-4d2cc27c9950",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "name": "AJ Bell",
      "slug": "aj-bell"
    },
    "covers": [
      {
        "uuid": "e2dc99ca-c12e-4b98-ae6a-015909665073",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "cover_type": "critical_illness",
        "benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "benefit_frequency": "monthly",
        "benefit_status": "active",
        "excess": {
          "amount": {
            "example": "10000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "indexation": 1.4,
        "client": "App\\Http\\Resources\\AccountResource"
      }
    ],
    "claims": [
      {
        "uuid": "3d90e52f-1a70-437a-840b-ad529df86369",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "claim_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "claim_start_date": "2025-05-01",
        "claim_end_date": "2031-05-01",
        "claim_notes": "Claim notes",
        "client": "App\\Http\\Resources\\AccountResource"
      }
    ],
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      }
    },
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      }
    },
    "latest_valuations": [
      {
        "uuid": "be4c25d7-a5f8-4dc7-ab51-d6cc33b130c6",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "valued_at": "2026-05-01T11:37:31+01:00",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
      }
    ],
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      }
    },
    "valued_at": "2026-05-01T11:37:31+01:00",
    "original_valued_at": "2026-04-30T11:37:31+01:00",
    "client": {
      "uuid": "2a1205fe-1c12-4353-abd2-14410edaf59b",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "firm": "App\\Http\\Resources\\FirmResource",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "first_contact_date": "2026-05-01T11:37:31+01:00",
      "next_review_date": "2026-05-01T11:37:31+01:00",
      "previous_review_date": "2026-05-01T11:37:31+01:00",
      "anniversary_review_date": "2026-05-01T11:37:31+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "inactive_at": "2026-05-01",
      "last_interaction_at": "2026-05-01 11:37:31",
      "referral_code": "ABC12345",
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    },
    "accounts": [
      {
        "uuid": "37326ebc-8b4c-4adf-9a38-48c8da591609",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": "App\\Http\\Resources\\FirmResource",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
        "groups": "App\\Http\\Resources\\GroupResource",
        "tags": "App\\Http\\Resources\\TagResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "first_contact_date": "2026-05-01T11:37:31+01:00",
        "next_review_date": "2026-05-01T11:37:31+01:00",
        "previous_review_date": "2026-05-01T11:37:31+01:00",
        "anniversary_review_date": "2026-05-01T11:37:31+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "circles": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "inactive_at": "2026-05-01",
        "last_interaction_at": "2026-05-01 11:37:31",
        "referral_code": "ABC12345",
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      }
    ],
    "seller": {
      "uuid": "42cfc66d-91fa-4a79-854e-02a488026667",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "firm": "App\\Http\\Resources\\FirmResource",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "first_contact_date": "2026-05-01T11:37:31+01:00",
      "next_review_date": "2026-05-01T11:37:31+01:00",
      "previous_review_date": "2026-05-01T11:37:31+01:00",
      "anniversary_review_date": "2026-05-01T11:37:31+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "inactive_at": "2026-05-01",
      "last_interaction_at": "2026-05-01 11:37:31",
      "referral_code": "ABC12345",
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    },
    "linked_owners": [
      {
        "uuid": "89ccff44-592c-4ccf-a5b7-6d567d72fd34",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": "App\\Http\\Resources\\FirmResource",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
        "groups": "App\\Http\\Resources\\GroupResource",
        "tags": "App\\Http\\Resources\\TagResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "first_contact_date": "2026-05-01T11:37:31+01:00",
        "next_review_date": "2026-05-01T11:37:31+01:00",
        "previous_review_date": "2026-05-01T11:37:31+01:00",
        "anniversary_review_date": "2026-05-01T11:37:31+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "circles": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "inactive_at": "2026-05-01",
        "last_interaction_at": "2026-05-01 11:37:31",
        "referral_code": "ABC12345",
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      }
    ],
    "linked_plans": [
      {
        "uuid": "dcba9394-1b4e-43e7-9b94-e465d20063e0",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "opened_at": "2026-05-01T11:37:31+01:00",
        "name": "Johns ISA",
        "type": "cash_account",
        "sub_type": "lifetime isa",
        "abstract_type": "asset",
        "policy_number": "AVIVA-123",
        "proposal_reference": "AB123456",
        "status": "inactive",
        "inactive_at": "2026-05-01T11:37:31+01:00",
        "inactive_reason": "claimed",
        "agency_in_your_name": true,
        "agency_in_your_name_from": "2025-05-01",
        "originally_sold_by_firm": true,
        "under_advice": true,
        "visible_on_client_portal": true,
        "include_in_client_valuation": true,
        "show_on_joint": true,
        "shown_on_circles": true,
        "review_date": "2025-05-01",
        "on_panel": true,
        "is_group_scheme": false,
        "is_sub_group_scheme": false,
        "is_group_scheme_member": true,
        "advice_area": "non_investment_insurance",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          }
        },
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "valued_at": "2026-05-01T11:37:31+01:00",
        "original_valued_at": "2026-04-30T11:37:31+01:00",
        "client": "App\\Http\\Resources\\AccountResource",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "linked_plans": "App\\Http\\Resources\\Plans\\GroupSchemeMemberResource",
        "visible_to_circles": "App\\Http\\Resources\\CircleResource",
        "statistics": {
          "recent_growth": 100
        },
        "cases": "App\\Http\\Resources\\CasesResource",
        "tags": "App\\Http\\Resources\\TagResource",
        "is_wrap_product": false,
        "is_wrap_child": false,
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
        "can_be_deleted": "false",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "group_scheme": "App\\Http\\Resources\\Plans\\GroupSchemeMemberResource",
        "group_scheme_member_detail": {
          "workplace_location": "London",
          "employment_division": "Management"
        }
      }
    ],
    "visible_to_circles": {
      "uuid": "82b4d4be-60d2-4025-8cca-4cb725b37a15",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "name": "Jones Family",
      "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
      "bg_colour": "#35f4e1",
      "accounts": "App\\Http\\Resources\\AccountResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "joint_account_uuid": "b7c82932-2afb-4195-86dc-0e716870b389",
      "login_access_level": "write",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    },
    "statistics": {
      "recent_growth": 100
    },
    "cases": [
      {
        "uuid": "96b7e070-c184-4d56-b6d0-85e4b328f243",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "name": "finance",
        "slug": "finance",
        "status": "App\\Http\\Resources\\CasesStatusResource",
        "type": "App\\Http\\Resources\\CasesTypeResource",
        "review_at": "2026-05-01T11:37:31+01:00",
        "assigned_to_uuids": [
          "7c456a42-1481-4515-b0b9-cdeca146592f"
        ],
        "group_uuids": [
          "2a6c176c-4046-4732-b179-a58796779915"
        ],
        "completed_at": "2026-05-01T11:37:31+01:00",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "status_position": 4,
        "participants_count": 4,
        "participants": "App\\Http\\Resources\\AccountResource",
        "task_board_uuid": "779dd893-d90e-4caa-8caf-d3094bfac508",
        "plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource"
      }
    ],
    "tags": [
      {
        "uuid": "89d129e2-6557-46fc-8171-2e809f1819c3",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "name": "Mortgage",
        "slug": "mortgage",
        "colour": "#ef4582"
      }
    ],
    "is_wrap_product": false,
    "is_wrap_child": false,
    "wrap": {
      "uuid": "a9d8116c-1fe2-4361-a22b-c88e3decf484",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "opened_at": "2026-05-01T11:37:31+01:00",
      "name": "Johns ISA",
      "type": "cash_account",
      "sub_type": "lifetime isa",
      "abstract_type": "asset",
      "policy_number": "AVIVA-123",
      "proposal_reference": "AB123456",
      "status": "inactive",
      "inactive_at": "2026-05-01T11:37:31+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-05-01",
      "originally_sold_by_firm": true,
      "under_advice": true,
      "visible_on_client_portal": true,
      "include_in_client_valuation": true,
      "show_on_joint": true,
      "shown_on_circles": true,
      "review_date": "2025-05-01",
      "on_panel": true,
      "is_group_scheme": false,
      "is_sub_group_scheme": false,
      "is_group_scheme_member": false,
      "advice_area": "non_investment_insurance",
      "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
      "covers": "App\\Http\\Resources\\Plans\\CoverResource",
      "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        }
      },
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "valued_at": "2026-05-01T11:37:31+01:00",
      "original_valued_at": "2026-04-30T11:37:31+01:00",
      "client": "App\\Http\\Resources\\AccountResource",
      "accounts": "App\\Http\\Resources\\AccountResource",
      "seller": "App\\Http\\Resources\\AccountResource",
      "linked_owners": "App\\Http\\Resources\\AccountResource",
      "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
      "visible_to_circles": "App\\Http\\Resources\\CircleResource",
      "statistics": {
        "recent_growth": 100
      },
      "cases": "App\\Http\\Resources\\CasesResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "is_wrap_product": false,
      "is_wrap_child": false,
      "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
      "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
      "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
      "can_be_deleted": "false",
      "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    },
    "wrap_children": [
      {
        "uuid": "854c3cb8-c210-40a0-a2c8-e29f96500b08",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "opened_at": "2026-05-01T11:37:31+01:00",
        "name": "Johns ISA",
        "type": "cash_account",
        "sub_type": "lifetime isa",
        "abstract_type": "asset",
        "policy_number": "AVIVA-123",
        "proposal_reference": "AB123456",
        "status": "inactive",
        "inactive_at": "2026-05-01T11:37:31+01:00",
        "inactive_reason": "claimed",
        "agency_in_your_name": true,
        "agency_in_your_name_from": "2025-05-01",
        "originally_sold_by_firm": true,
        "under_advice": true,
        "visible_on_client_portal": true,
        "include_in_client_valuation": true,
        "show_on_joint": true,
        "shown_on_circles": true,
        "review_date": "2025-05-01",
        "on_panel": true,
        "is_group_scheme": false,
        "is_sub_group_scheme": false,
        "is_group_scheme_member": false,
        "advice_area": "non_investment_insurance",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          }
        },
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "valued_at": "2026-05-01T11:37:31+01:00",
        "original_valued_at": "2026-04-30T11:37:31+01:00",
        "client": "App\\Http\\Resources\\AccountResource",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "visible_to_circles": "App\\Http\\Resources\\CircleResource",
        "statistics": {
          "recent_growth": 100
        },
        "cases": "App\\Http\\Resources\\CasesResource",
        "tags": "App\\Http\\Resources\\TagResource",
        "is_wrap_product": false,
        "is_wrap_child": false,
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
        "can_be_deleted": "false",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      }
    ],
    "linked_policy_numbers": [
      {
        "uuid": "46d9735d-30a6-4c10-9aeb-bda017e05697",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "linked_policy_number": "ABC123-X",
        "plan": "App\\Http\\Resources\\Plans\\PlanResource"
      }
    ],
    "can_be_deleted": "false",
    "contract_enquiry_account": {
      "uuid": "2579720c-92e1-4221-bc8c-4cb9faf4e2c0",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "firm": "App\\Http\\Resources\\FirmResource",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "first_contact_date": "2026-05-01T11:37:31+01:00",
      "next_review_date": "2026-05-01T11:37:31+01:00",
      "previous_review_date": "2026-05-01T11:37:31+01:00",
      "anniversary_review_date": "2026-05-01T11:37:31+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "inactive_at": "2026-05-01",
      "last_interaction_at": "2026-05-01 11:37:31",
      "referral_code": "ABC12345",
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    },
    "custom_fields": [
      {
        "uuid": "4ad1cae5-bba2-451c-929a-d7c0a6a85c01",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "type": "string",
        "name": "Favourite Drink",
        "reference": "favourite_drink",
        "is_required": false,
        "value": "Coffee",
        "selection_options": [
          "Coffee",
          "Tea",
          "Water"
        ],
        "help_text": "This is the client's favourite drink."
      }
    ],
    "external_references": [
      {
        "uuid": "565f0b83-5123-4f07-8a35-07c3c530eac2",
        "created_at": "2026-05-01T11:37:31+01:00",
        "updated_at": "2026-05-01T11:37:31+01:00",
        "third_party": "nucleus",
        "reference": "AB123456"
      }
    ],
    "group_scheme": {
      "uuid": "0a4a975f-ba7a-46e7-9dde-b5b9c941d6d6",
      "created_at": "2026-05-01T11:37:31+01:00",
      "updated_at": "2026-05-01T11:37:31+01:00",
      "opened_at": "2026-05-01T11:37:31+01:00",
      "name": "Johns ISA",
      "type": "cash_account",
      "sub_type": "lifetime isa",
      "abstract_type": "asset",
      "policy_number": "AVIVA-123",
      "proposal_reference": "AB123456",
      "status": "inactive",
      "inactive_at": "2026-05-01T11:37:31+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-05-01",
      "originally_sold_by_firm": true,
      "under_advice": true,
      "visible_on_client_portal": true,
      "include_in_client_valuation": true,
      "show_on_joint": true,
      "shown_on_circles": true,
      "review_date": "2025-05-01",
      "on_panel": true,
      "is_group_scheme": false,
      "is_sub_group_scheme": false,
      "is_group_scheme_member": true,
      "advice_area": "non_investment_insurance",
      "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
      "covers": "App\\Http\\Resources\\Plans\\CoverResource",
      "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        }
      },
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "valued_at": "2026-05-01T11:37:31+01:00",
      "original_valued_at": "2026-04-30T11:37:31+01:00",
      "client": "App\\Http\\Resources\\AccountResource",
      "accounts": "App\\Http\\Resources\\AccountResource",
      "seller": "App\\Http\\Resources\\AccountResource",
      "linked_owners": "App\\Http\\Resources\\AccountResource",
      "linked_plans": "App\\Http\\Resources\\Plans\\GroupSchemeMemberResource",
      "visible_to_circles": "App\\Http\\Resources\\CircleResource",
      "statistics": {
        "recent_growth": 100
      },
      "cases": "App\\Http\\Resources\\CasesResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "is_wrap_product": false,
      "is_wrap_child": false,
      "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
      "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
      "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
      "can_be_deleted": "false",
      "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "group_scheme": "App\\Http\\Resources\\Plans\\GroupSchemeMemberResource",
      "group_scheme_member_detail": {
        "workplace_location": "London",
        "employment_division": "Management"
      }
    },
    "group_scheme_member_detail": {
      "workplace_location": "London",
      "employment_division": "Management"
    }
  }
]