Create a sub-scheme for a group scheme plan

POST /api/v1/plans/{plan_uuid}/sub-group-schemes

Headers

Path parameters

plan_uuid string Required

uuid The UUID of the group scheme plan.

application/json

Body Required

name string Required

The name for the sub-scheme
status string Required

Plan status for the member. Available options: active, inactive and 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
policy_number string

Optional policy number if the sub scheme has separate policy numbers per member.
on_risk_at date

Date when the policy went "on risk".
inactive_at date

Date when the policy was made inactive.
employer_percentage number

Employer percentage being paid in to pension plan.
employer_frequency string

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

Employee percentage being paid in to pension plan.
employee_frequency string

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

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 originall 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
- 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
  
  Additional properties are allowed.
- sub_accounts array[object]
  
  Plans sub accounts
  
  Additional properties are allowed.
- provider object
  
  The plan's provider
  
  Additional properties are allowed.
- covers array[object]
  
  Covers of the plan
  
  Additional properties are allowed.
- claims array[object]
  
  Claims of the plan
  
  Additional properties are allowed.
- total_benefit_amount object
  
  Total amount benefit of all covers
  
  Additional properties are allowed.
- total_benefits object
  
  Total benefits broken down in to cover types
  
  Additional properties are allowed.
- latest_valuations array[object]
  
  The plan's latest valuations (Included when the "latest_valuations" relationship is included)
  
  Additional properties are allowed.
- value object
  
  Total value of the plan
  
  Additional properties are allowed.
- valued_at string
  
  When the plan was last valued
- client object
  
  The plan's client
  
  Additional properties are allowed.
- seller object
  
  Adviser who sold the plan
  
  Additional properties are allowed.
- linked_owners array[object]
  
  Other clients who have been linked to this plan
  
  Additional properties are allowed.
- linked_plans array[object]
  
  Other plans that have been linked to this plan
  
  Additional properties are allowed.
- statistics object
  
  The statistics on a plan. Only displayed when you retrieve an individual plan
  
  Additional properties are allowed.
- cases array[object]
  
  Cases this plan belongs to
  
  Additional properties are allowed.
- tags array[object]
  
  Tags this plan have been tagged with
  
  Additional properties are allowed.
- 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
  
  Additional properties are allowed.
- wrap_children array[object]
  
  List of child plans on a wrap product
  
  Additional properties are allowed.
- can_be_deleted string
  
  Denotes if the plan can be deleted
- contract_enquiry_account object
  
  The specific account used to make contract enquiry requests.
  
  Additional properties are allowed.
- custom_fields array[object]
  
  Any custom fields on the model.
  
  Additional properties are allowed.
- external_references array[object]
  
  The external references that have been added to the client.
  
  Additional properties are allowed.
- group_scheme object
  
  The group scheme that the sub scheme is part of.
  
  Additional properties are allowed.

POST /api/v1/plans/{plan_uuid}/sub-group-schemes

curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-group-schemes \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Families","status":"active","inactive_status":"paid_up","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":"monthly"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Families",
  "status": "active",
  "inactive_status": "paid_up",
  "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": "monthly"
}

Response examples (200)

{
  "name": "Johns ISA",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "812ed1b4-017a-4ae0-88bf-34edb2b27d0a",
      "colour": "#ef4582",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00"
    }
  ],
  "type": "cash_account",
  "uuid": "b5526e55-1b73-45f2-b1d4-0bfef5a18905",
  "wrap": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "ad169413-c495-4c15-a917-e9ff06986550",
    "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
    "cases": "App\\Http\\Resources\\CasesResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
    "client": "App\\Http\\Resources\\AccountResource",
    "covers": "App\\Http\\Resources\\Plans\\CoverResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "status": "inactive",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2024-11-20T13:24:03+00:00",
    "valued_at": "2024-11-20T13:24:03+00:00",
    "created_at": "2024-11-20T13:24:03+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:03+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:03+00:00",
    "review_date": "2023-11-20",
    "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
    "under_advice": true,
    "abstract_type": "asset",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "is_wrap_child": false,
    "linked_owners": "App\\Http\\Resources\\AccountResource",
    "policy_number": "AVIVA-123",
    "show_on_joint": true,
    "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
    "can_be_deleted": "false",
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        }
      }
    },
    "inactive_reason": "claimed",
    "is_group_scheme": false,
    "is_wrap_product": false,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "proposal_reference": "AB123456",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": false,
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      }
    },
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2023-11-20",
    "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": "b9c0945a-2e28-459c-a970-1e0b5564ad57",
      "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",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "completed_at": "2024-11-20T13:24:03+00:00",
      "participants": "App\\Http\\Resources\\AccountResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "status_position": 4,
      "task_board_uuid": "8abe1719-6a34-4deb-8cb1-288e08694537",
      "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": "deb66b36-5914-4aa0-839c-8f6926b75e47",
      "client": "App\\Http\\Resources\\AccountResource",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+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": "2029-11-20",
      "claim_start_date": "2023-11-20"
    }
  ],
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7bbcf8f7-274b-41d7-a110-c99bea294fa6",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "covers": [
    {
      "uuid": "80530043-d6d4-4775-b5d2-ae42e1bd9c9f",
      "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": "2024-11-20T13:24:03+00:00",
      "indexation": 1.4,
      "updated_at": "2024-11-20T13:24:03+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": "3d7a0286-d7e6-4714-8b3a-b190fcb04186",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "status": "inactive",
  "on_panel": true,
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "274c3e0f-dd73-4a12-a1e6-ce94319869c6",
    "created_at": "2024-11-20T13:24:03+00:00",
    "updated_at": "2024-11-20T13:24:03+00:00"
  },
  "sub_type": "lifetime isa",
  "opened_at": "2024-11-20T13:24:03+00:00",
  "valued_at": "2024-11-20T13:24:03+00:00",
  "created_at": "2024-11-20T13:24:03+00:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2024-11-20T13:24:03+00:00",
  "advice_area": "non_investment_insurance",
  "inactive_at": "2024-11-20T13:24:03+00:00",
  "review_date": "2023-11-20",
  "group_scheme": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "97965aa7-eb13-4266-9d17-7eac380946a2",
    "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
    "cases": "App\\Http\\Resources\\CasesResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
    "client": "App\\Http\\Resources\\AccountResource",
    "covers": "App\\Http\\Resources\\Plans\\CoverResource",
    "seller": "App\\Http\\Resources\\AccountResource",
    "status": "inactive",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2024-11-20T13:24:03+00:00",
    "valued_at": "2024-11-20T13:24:03+00:00",
    "created_at": "2024-11-20T13:24:03+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:03+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:03+00:00",
    "review_date": "2023-11-20",
    "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,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "proposal_reference": "AB123456",
    "agency_in_your_name": true,
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "is_sub_group_scheme": 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"
      }
    },
    "is_group_scheme_member": false,
    "originally_sold_by_firm": true,
    "agency_in_your_name_from": "2023-11-20",
    "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": "dcd38284-fc10-425c-8619-c70e3cc9bffe",
      "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
      "cases": "App\\Http\\Resources\\CasesResource",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        }
      },
      "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
      "client": "App\\Http\\Resources\\AccountResource",
      "covers": "App\\Http\\Resources\\Plans\\CoverResource",
      "seller": "App\\Http\\Resources\\AccountResource",
      "status": "inactive",
      "on_panel": true,
      "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
      "sub_type": "lifetime isa",
      "opened_at": "2024-11-20T13:24:03+00:00",
      "valued_at": "2024-11-20T13:24:03+00:00",
      "created_at": "2024-11-20T13:24:03+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2024-11-20T13:24:03+00:00",
      "advice_area": "non_investment_insurance",
      "inactive_at": "2024-11-20T13:24:03+00:00",
      "review_date": "2023-11-20",
      "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,
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "proposal_reference": "AB123456",
      "agency_in_your_name": true,
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "is_sub_group_scheme": 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"
        }
      },
      "is_group_scheme_member": false,
      "originally_sold_by_firm": true,
      "agency_in_your_name_from": "2023-11-20",
      "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
      "visible_on_client_portal": true,
      "include_in_client_valuation": true
    }
  ],
  "main_account": {
    "name": "John's ISA",
    "uuid": "19105b23-d85a-4293-b35a-00a7f610a8fe",
    "created_at": "2024-11-20T13:24:03+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:03+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": "8c243645-70cd-4c95-a9df-ce470e67c140",
      "created_at": "2024-11-20T13:24:03+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2024-11-20T13:24:03+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": "e3eba13b-7bc3-4e71-ba8a-b05424738348",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+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": "06159723-1a7d-4baf-aa5f-abcbbd78551b",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2024-11-20T13:24:03+00:00",
      "first_name": "Gareth",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "with_login": true,
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2024-11-20T13:24:03+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2024-11-20T13:24:03+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2024-11-20T13:24:03+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2024-11-20T13:24:03+00:00"
    }
  ],
  "policy_number": "AVIVA-123",
  "show_on_joint": true,
  "wrap_children": [
    {
      "name": "Johns ISA",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "cash_account",
      "uuid": "9ac90ae7-3b4f-4e4d-905c-8296cd3bf412",
      "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
      "cases": "App\\Http\\Resources\\CasesResource",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        }
      },
      "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
      "client": "App\\Http\\Resources\\AccountResource",
      "covers": "App\\Http\\Resources\\Plans\\CoverResource",
      "seller": "App\\Http\\Resources\\AccountResource",
      "status": "inactive",
      "on_panel": true,
      "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
      "sub_type": "lifetime isa",
      "opened_at": "2024-11-20T13:24:03+00:00",
      "valued_at": "2024-11-20T13:24:03+00:00",
      "created_at": "2024-11-20T13:24:03+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2024-11-20T13:24:03+00:00",
      "advice_area": "non_investment_insurance",
      "inactive_at": "2024-11-20T13:24:03+00:00",
      "review_date": "2023-11-20",
      "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
      "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
      "under_advice": true,
      "abstract_type": "asset",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "is_wrap_child": false,
      "linked_owners": "App\\Http\\Resources\\AccountResource",
      "policy_number": "AVIVA-123",
      "show_on_joint": true,
      "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
      "can_be_deleted": "false",
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          }
        }
      },
      "inactive_reason": "claimed",
      "is_group_scheme": false,
      "is_wrap_product": false,
      "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
      "proposal_reference": "AB123456",
      "agency_in_your_name": true,
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "is_sub_group_scheme": false,
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "is_group_scheme_member": false,
      "originally_sold_by_firm": true,
      "agency_in_your_name_from": "2023-11-20",
      "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,
  "latest_valuations": [
    {
      "uuid": "8a916b2a-34a3-4459-b46d-3fe3b4c47c19",
      "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": "2024-11-20T13:24:03+00:00",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
    }
  ],
  "proposal_reference": "AB123456",
  "agency_in_your_name": true,
  "external_references": [
    {
      "uuid": "25003e7c-6cc5-4afe-a4d2-735e40a12795",
      "reference": "AB123456",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+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"
    }
  },
  "is_group_scheme_member": false,
  "originally_sold_by_firm": true,
  "agency_in_your_name_from": "2023-11-20",
  "contract_enquiry_account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "1bb7822d-8e08-4d09-abdf-5fee12b9635f",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "visible_on_client_portal": true,
  "include_in_client_valuation": true
}