POST /api/v1/plans/{plan_uuid}/sub-group-schemes
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

  • name string Required

    The name for the sub-scheme

  • 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. Available options: 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 and other

    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 sub scheme has separate policy numbers per member.

  • on_risk_at string(date)

    Date when the policy went "on risk".

  • inactive_at string(date)

    Date when the policy was made inactive.

  • employer_percentage number(float)

    Employer percentage being paid in to pension plan.

    Minimum value is 0.0, maximum value is 100.0.

  • employer_frequency string

    Frequency of the employer percentage being paid in to pension plan.

  • employee_percentage number(float)

    Employee percentage being paid in to pension plan.

    Minimum value is 0.0, maximum value is 100.0.

  • employee_frequency string

    Frequency of the employee percentage being paid in to pension plan.

    Value Description
    daily Daily
    weekly Weekly
    fortnightly Fortnightly
    four_weekly Four Weekly
    monthly Monthly
    bimonthly Bimonthly
    quarterly Quarterly
    biannually Biannually
    annually Annually
    adhoc Adhoc
    one_off One Off

    Values are daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc, or one_off.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • opened_at string

      Timestamp of when the plan was originally opened

    • name string

      Name of the plan

    • type string

      Type of plan, this will indicate what to expect from the fields attribute

    • sub_type string

      Plan sub type

    • abstract_type string

      describes if the plan is an asset, protection or liability

    • policy_number string

      The policy number on the main sub account of the plan

    • proposal_reference string

      The proposal reference on the main sub account of the plan

    • status string

      Plan status

    • inactive_at string

      Timestamp of when the plan became inactive

    • inactive_reason string

      Reason for inactivity

    • agency_in_your_name boolean

      Denotes if plan has agency in your name

    • agency_in_your_name_from string

      Date the agency was in your name from

    • originally_sold_by_firm boolean

      Denotes if the plan was originally sold by your firm

    • under_advice boolean

      Denotes if plan is under advice

    • visible_on_client_portal boolean

      Denotes if this plan is visible to clients on the client portal

    • include_in_client_valuation boolean

      Denotes if this plan should be included in the client valuation

    • show_on_joint boolean

      Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

    • shown_on_circles boolean

      Determines if plan should be shown on a circle

    • review_date string

      Review date

    • on_panel boolean

      On panel

    • is_group_scheme boolean

      Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

    • is_sub_group_scheme boolean

      Denotes if the plan is sub scheme of the group scheme plan.

    • is_group_scheme_member boolean

      Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

    • advice_area string

      The advice area of the plan based on the plan's sub type.

    • main_account object

      Plans main account

      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]

      Plans sub accounts

      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

      The plan's provider

      Hide provider attributes Show provider attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
    • covers array[object]

      Covers of the plan

      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]

      Claims of the plan

      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

      Total amount benefit of all covers

      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

      Total benefits broken down in to cover types

      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]

      The plan's latest valuations (Included when the "latest_valuations" relationship is included)

      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

      Total value of the plan

      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

      When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

    • original_valued_at string

      When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

    • client object

      [DEPRACATED] Please use accounts instead. The plan's client

      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
      • 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
      • custom_fields string
      • external_references string
    • accounts array[object]

      The plan's accounts

      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
      • 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
      • custom_fields string
      • external_references string
    • seller object

      Adviser who sold the plan

      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
      • 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
      • custom_fields string
      • external_references string
    • linked_owners array[object]

      Other clients who have been linked to this plan

      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
      • 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
      • custom_fields string
      • external_references string
    • linked_plans array[object]

      Other plans that have been linked to this plan

      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
    • visible_to_circles object

      Circles which members of circles can see the plan as long as they have the right access level for the circle

      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

      The statistics on a plan. Only displayed when you retrieve an individual plan

      Hide statistics attribute Show statistics attribute object
      • recent_growth integer
    • cases array[object]

      Cases this plan belongs to

      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]

      Tags this plan have been tagged with

      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

      Determines if the plan is a wrap plan

    • is_wrap_child boolean

      Determines if the plan is a wrap child

    • wrap object

      Parent wrap plan. if this plan is linked to a wrap product

      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]

      List of child plans on a wrap product

      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]

      Linked policy numbers

      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

      Denotes if the plan can be deleted

    • contract_enquiry_account object

      The specific account used to make contract enquiry requests.

      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
      • 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
      • custom_fields string
      • external_references string
    • custom_fields array[object]

      Any custom fields on the model.

      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]

      The external references that have been added to the client.

      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

      The group scheme that the sub scheme is part of.

      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
POST /api/v1/plans/{plan_uuid}/sub-group-schemes 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-group-schemes' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Families","status":"active","inactive_status":"accepted","policy_number":"AVIVA-123","on_risk_at":"2023-03-26","inactive_at":"2024-03-26","employer_percentage":1.24,"employer_frequency":"monthly","employee_percentage":9.65,"employee_frequency":"daily"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Families",
  "status": "active",
  "inactive_status": "accepted",
  "policy_number": "AVIVA-123",
  "on_risk_at": "2023-03-26",
  "inactive_at": "2024-03-26",
  "employer_percentage": 1.24,
  "employer_frequency": "monthly",
  "employee_percentage": 9.65,
  "employee_frequency": "daily"
}
Response examples (200) 
{
  "name": "Johns ISA",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "8f19dd0e-e6ee-48a8-8a3b-13be10fff5ff",
      "colour": "#ef4582",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00"
    }
  ],
  "type": "cash_account",
  "uuid": "7821ec45-ebe8-4901-ab45-28d7d42d5c93",
  "wrap": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "72d01537-29b7-40fe-b980-aad2544c17b9",
    "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": "2026-02-06T09:09:44+00:00",
    "valued_at": "2026-02-06T09:09:44+00:00",
    "created_at": "2026-02-06T09:09:44+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2026-02-06T09:09:44+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2026-02-06T09:09:44+00:00",
    "review_date": "2025-02-06",
    "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,
    "shown_on_circles": true,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "original_valued_at": "2026-02-05T09:09:44+00:00",
    "proposal_reference": "AB123456",
    "visible_to_circles": "App\\Http\\Resources\\CircleResource",
    "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"
      }
    },
    "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2025-02-06",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "cases": [
    {
      "name": "finance",
      "slug": "finance",
      "type": "App\\Http\\Resources\\CasesTypeResource",
      "uuid": "e02d9936-0739-47f0-9934-e146c72a9097",
      "plans": "App\\Http\\Resources\\Plans\\PlanResource",
      "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"
        }
      },
      "status": "App\\Http\\Resources\\CasesStatusResource",
      "review_at": "2026-02-06T09:09:44+00:00",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "group_uuids": [
        "0bba8fc7-197e-43e0-a9f9-48d435b473c3"
      ],
      "completed_at": "2026-02-06T09:09:44+00:00",
      "participants": "App\\Http\\Resources\\AccountResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "status_position": 4,
      "task_board_uuid": "7a64ea0d-9851-4020-b69e-41259e8f677c",
      "assigned_to_uuids": [
        "e2df335a-19b8-419c-b606-669969612022"
      ],
      "participants_count": 4
    }
  ],
  "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": [
    {
      "uuid": "6b232b3b-9983-422b-ab03-3f9853228127",
      "client": "App\\Http\\Resources\\AccountResource",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "claim_notes": "Claim notes",
      "claim_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"
        }
      },
      "claim_end_date": "2031-02-06",
      "claim_start_date": "2025-02-06"
    }
  ],
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "46bad55b-e932-480c-993f-ed3037e119cc",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-02-06T09:09:44+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-06T09:09:44+00:00",
    "with_login": true,
    "inactive_at": "2026-02-06",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-02-06T09:09:44+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-02-06T09:09:44+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-02-06 09:09:44",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-02-06T09:09:44+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-02-06T09:09:44+00:00"
  },
  "covers": [
    {
      "uuid": "7b335c28-f735-4c41-b96b-b8ec38226052",
      "client": "App\\Http\\Resources\\AccountResource",
      "excess": {
        "amount": {
          "example": "10000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£100.00",
          "description": "Money amount formatted with currency"
        }
      },
      "cover_type": "critical_illness",
      "created_at": "2026-02-06T09:09:44+00:00",
      "indexation": 1.4,
      "updated_at": "2026-02-06T09:09:44+00:00",
      "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"
        }
      },
      "benefit_status": "active",
      "benefit_frequency": "monthly"
    }
  ],
  "seller": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "b25fd879-6dff-433e-a76f-b971c0df48b6",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-02-06T09:09:44+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-06T09:09:44+00:00",
    "with_login": true,
    "inactive_at": "2026-02-06",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-02-06T09:09:44+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-02-06T09:09:44+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-02-06 09:09:44",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-02-06T09:09:44+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-02-06T09:09:44+00:00"
  },
  "status": "inactive",
  "accounts": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "59c7f157-dd2d-4ddc-b9b2-fa31a00a348c",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2026-02-06T09:09:44+00:00",
      "first_name": "Gareth",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "with_login": true,
      "inactive_at": "2026-02-06",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "referral_code": "ABC12345",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2026-02-06T09:09:44+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2026-02-06T09:09:44+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2026-02-06 09:09:44",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2026-02-06T09:09:44+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2026-02-06T09:09:44+00:00"
    }
  ],
  "on_panel": true,
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "c4832a2b-8095-4516-869c-ff1d35e716d4",
    "created_at": "2026-02-06T09:09:44+00:00",
    "updated_at": "2026-02-06T09:09:44+00:00"
  },
  "sub_type": "lifetime isa",
  "opened_at": "2026-02-06T09:09:44+00:00",
  "valued_at": "2026-02-06T09:09:44+00:00",
  "created_at": "2026-02-06T09:09:44+00:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2026-02-06T09:09:44+00:00",
  "advice_area": "non_investment_insurance",
  "inactive_at": "2026-02-06T09:09:44+00:00",
  "review_date": "2025-02-06",
  "group_scheme": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "1c696d31-61a2-41bf-991b-f3ca460f3baa",
    "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": "2026-02-06T09:09:44+00:00",
    "valued_at": "2026-02-06T09:09:44+00:00",
    "created_at": "2026-02-06T09:09:44+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2026-02-06T09:09:44+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2026-02-06T09:09:44+00:00",
    "review_date": "2025-02-06",
    "group_scheme": "App\\Http\\Resources\\Plans\\SubGroupSchemeResource",
    "linked_plans": "App\\Http\\Resources\\Plans\\SubGroupSchemeResource",
    "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,
    "shown_on_circles": true,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "original_valued_at": "2026-02-05T09:09:44+00:00",
    "proposal_reference": "AB123456",
    "visible_to_circles": "App\\Http\\Resources\\CircleResource",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": true,
    "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"
      }
    },
    "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2025-02-06",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "linked_plans": [
    {
      "name": "Johns ISA",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "cash_account",
      "uuid": "c908d8da-f2c4-46e3-a5ab-348541a04aab",
      "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": "2026-02-06T09:09:44+00:00",
      "valued_at": "2026-02-06T09:09:44+00:00",
      "created_at": "2026-02-06T09:09:44+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2026-02-06T09:09:44+00:00",
      "advice_area": "non_investment_insurance",
      "inactive_at": "2026-02-06T09:09:44+00:00",
      "review_date": "2025-02-06",
      "group_scheme": "App\\Http\\Resources\\Plans\\SubGroupSchemeResource",
      "linked_plans": "App\\Http\\Resources\\Plans\\SubGroupSchemeResource",
      "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,
      "shown_on_circles": true,
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "original_valued_at": "2026-02-05T09:09:44+00:00",
      "proposal_reference": "AB123456",
      "visible_to_circles": "App\\Http\\Resources\\CircleResource",
      "agency_in_your_name": true,
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "is_sub_group_scheme": true,
      "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"
        }
      },
      "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
      "is_group_scheme_member": false,
      "originally_sold_by_firm": true,
      "agency_in_your_name_from": "2025-02-06",
      "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
      "visible_on_client_portal": true,
      "include_in_client_valuation": true
    }
  ],
  "main_account": {
    "name": "John's ISA",
    "uuid": "d374061e-e5c9-4b2a-ae34-0f01172e0249",
    "created_at": "2026-02-06T09:09:44+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2026-02-06T09:09:44+00:00",
    "policy_number": "AVI-4837",
    "is_main_account": false,
    "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
    "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
  },
  "sub_accounts": [
    {
      "name": "John's ISA",
      "uuid": "e7ed28e5-f86f-4e07-901b-83aa7bbda65e",
      "created_at": "2026-02-06T09:09:44+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2026-02-06T09:09:44+00:00",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
      "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
    }
  ],
  "under_advice": true,
  "abstract_type": "asset",
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "276e5d9f-b90a-4e3d-a604-025dfdeb7804",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "is_wrap_child": false,
  "linked_owners": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "d1587847-3b4b-49a5-aa4d-df8cc0dfbeb6",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2026-02-06T09:09:44+00:00",
      "first_name": "Gareth",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "with_login": true,
      "inactive_at": "2026-02-06",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "referral_code": "ABC12345",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2026-02-06T09:09:44+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2026-02-06T09:09:44+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2026-02-06 09:09:44",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2026-02-06T09:09:44+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2026-02-06T09:09:44+00:00"
    }
  ],
  "policy_number": "AVIVA-123",
  "show_on_joint": true,
  "wrap_children": [
    {
      "name": "Johns ISA",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "cash_account",
      "uuid": "603a6d31-bb3e-403c-8258-7d50f1a528ed",
      "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": "2026-02-06T09:09:44+00:00",
      "valued_at": "2026-02-06T09:09:44+00:00",
      "created_at": "2026-02-06T09:09:44+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2026-02-06T09:09:44+00:00",
      "advice_area": "non_investment_insurance",
      "inactive_at": "2026-02-06T09:09:44+00:00",
      "review_date": "2025-02-06",
      "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,
      "shown_on_circles": true,
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "original_valued_at": "2026-02-05T09:09:44+00:00",
      "proposal_reference": "AB123456",
      "visible_to_circles": "App\\Http\\Resources\\CircleResource",
      "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"
        }
      },
      "linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
      "is_group_scheme_member": false,
      "originally_sold_by_firm": true,
      "agency_in_your_name_from": "2025-02-06",
      "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
      "visible_on_client_portal": true,
      "include_in_client_valuation": true
    }
  ],
  "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,
  "shown_on_circles": true,
  "latest_valuations": [
    {
      "uuid": "c6bee117-1909-4442-9b5a-bd59178943ed",
      "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"
        }
      },
      "valued_at": "2026-02-06T09:09:44+00:00",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
    }
  ],
  "original_valued_at": "2026-02-05T09:09:44+00:00",
  "proposal_reference": "AB123456",
  "visible_to_circles": {
    "name": "Jones Family",
    "uuid": "1c3bf985-dbbc-459e-9157-66cecafa0f2e",
    "groups": "App\\Http\\Resources\\GroupResource",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "bg_colour": "#35f4e1",
    "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
    "created_at": "2026-02-06T09:09:44+00:00",
    "updated_at": "2026-02-06T09:09:44+00:00",
    "joint_account_uuid": "4aacdbca-a690-417c-9e84-c8a9d5832678",
    "login_access_level": "write",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "agency_in_your_name": true,
  "external_references": [
    {
      "uuid": "0915b6e9-0533-4bdf-8443-971f570653b5",
      "reference": "AB123456",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "third_party": "nucleus"
    }
  ],
  "is_sub_group_scheme": true,
  "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"
    }
  },
  "linked_policy_numbers": [
    {
      "plan": "App\\Http\\Resources\\Plans\\PlanResource",
      "uuid": "31d59c3a-ce91-40ee-9985-546e3d02cda1",
      "created_at": "2026-02-06T09:09:44+00:00",
      "updated_at": "2026-02-06T09:09:44+00:00",
      "linked_policy_number": "ABC123-X"
    }
  ],
  "is_group_scheme_member": false,
  "originally_sold_by_firm": true,
  "agency_in_your_name_from": "2025-02-06",
  "contract_enquiry_account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "410e0d48-fd38-44db-99ae-788826d05702",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-02-06T09:09:44+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-06T09:09:44+00:00",
    "with_login": true,
    "inactive_at": "2026-02-06",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-02-06T09:09:44+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-02-06T09:09:44+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-02-06 09:09:44",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-02-06T09:09:44+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-02-06T09:09:44+00:00"
  },
  "visible_on_client_portal": true,
  "include_in_client_valuation": true
}