Get all plans Run in API Explorer
This endpoint will return all plans in the firm relevant to the user accessing them.
Query parameters
-
Date in format Y-m-d to get the plan's value at the date. Defaults to current date if not provided.
-
When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.
-
Comma separated list of relationships to include in the response. Valid relationships are [cases, tags, sub_accounts, wrap, wrap_children, wrap_children.provider, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].
-
Filter by a comma separated list of UUIDs.
-
Comma separated list of abstract types. Valid abstract types are [asset, liability, protection]
-
Comma separated list of types. Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]
-
Comma separated list of sub types.
-
Comma separated list of plan names to search against, can include partial matches.
-
Comma separated list of client UUIDs to search against.
-
Comma separated list of accounts UUIDs that are all the owners of a plan.
-
Comma separated list of circle UUIDs to search against.
-
Comma separated list of policy numbers to search against, can include partial matches.
-
Comma separated list of provider provider UUIDs to search against.
-
Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]
-
Comma separated list of adviser UUIDs of who sold the plan to search against.
-
Comma separated list of adviser UUIDs of who is actively managing the plan to search against.
-
Comma separated list of case UUIDs
-
Amount in pennies to filter where latest valuation is greater than.
-
Amount in pennies to filter where latest valuation is less than.
-
Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin
-
filter the plans by if they are a wrap product
-
Used to hide the wrap children from the primary list of plans.
-
Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.
-
Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET 'https://api.plannrcrm.com/api/v2/plans' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
{
"uuid": "30cfdba5-8f98-4d43-aa13-2b611a491f07",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"opened_at": "2026-04-24T17:14:55+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-04-24T17:14:55+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-24",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-04-24",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": {
"uuid": "a8da8d9c-421d-4b4f-8490-99b18f81bc64",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "John's ISA",
"policy_number": "AVI-4837",
"latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource",
"is_main_account": false,
"active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
"statistics": {
"recent_growth": 100
}
},
"sub_accounts": [
{
"uuid": "c076458b-2c74-4b7a-9cc5-3ce9d67c8113",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "John's ISA",
"policy_number": "AVI-4837",
"latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource",
"is_main_account": false,
"active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
"statistics": {
"recent_growth": 100
}
}
],
"provider": {
"uuid": "72e274ce-0398-42cf-8da8-363824cb3ebc",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "AJ Bell",
"slug": "aj-bell"
},
"covers": [
{
"uuid": "2c4e00e0-42a9-4f7c-b32c-f72805f3cf0f",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"cover_type": "critical_illness",
"benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"benefit_frequency": "monthly",
"benefit_status": "active",
"excess": {
"amount": {
"example": "10000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"indexation": 1.4,
"client": "App\\Http\\Resources\\AccountResource"
}
],
"claims": [
{
"uuid": "f568a46f-fe0d-4aeb-be68-5317f3dcbdc5",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"claim_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"claim_start_date": "2025-04-24",
"claim_end_date": "2031-04-24",
"claim_notes": "Claim notes",
"client": "App\\Http\\Resources\\AccountResource"
}
],
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
}
},
"latest_valuations": [
{
"uuid": "5ebcd687-75cb-46b0-b427-9685bc9e000a",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"valued_at": "2026-04-24T17:14:55+01:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
}
],
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"valued_at": "2026-04-24T17:14:55+01:00",
"original_valued_at": "2026-04-23T17:14:55+01:00",
"client": {
"uuid": "de8528f2-7c55-4736-b2dd-5f0243e8c92a",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-24T17:14:55+01:00",
"next_review_date": "2026-04-24T17:14:55+01:00",
"previous_review_date": "2026-04-24T17:14:55+01:00",
"anniversary_review_date": "2026-04-24T17:14:55+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:55",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"accounts": [
{
"uuid": "bc092412-5bfe-49ae-b948-17449571b2ac",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-24T17:14:55+01:00",
"next_review_date": "2026-04-24T17:14:55+01:00",
"previous_review_date": "2026-04-24T17:14:55+01:00",
"anniversary_review_date": "2026-04-24T17:14:55+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:55",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"seller": {
"uuid": "6c352914-724c-49a0-bd67-56cf83b335ad",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-24T17:14:55+01:00",
"next_review_date": "2026-04-24T17:14:55+01:00",
"previous_review_date": "2026-04-24T17:14:55+01:00",
"anniversary_review_date": "2026-04-24T17:14:55+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:55",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"linked_owners": [
{
"uuid": "eece960f-461c-4e7f-ad93-5409aa7032f7",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-24T17:14:55+01:00",
"next_review_date": "2026-04-24T17:14:55+01:00",
"previous_review_date": "2026-04-24T17:14:55+01:00",
"anniversary_review_date": "2026-04-24T17:14:55+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:55",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"linked_plans": [
{
"uuid": "466abee3-c832-476f-9e7a-409e661bc5ac",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"opened_at": "2026-04-24T17:14:55+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-04-24T17:14:55+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-24",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-04-24",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
}
},
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"valued_at": "2026-04-24T17:14:55+01:00",
"original_valued_at": "2026-04-23T17:14:55+01:00",
"client": "App\\Http\\Resources\\AccountResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"linked_owners": "App\\Http\\Resources\\AccountResource",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"statistics": {
"recent_growth": 100
},
"cases": "App\\Http\\Resources\\CasesResource",
"tags": "App\\Http\\Resources\\TagResource",
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
"can_be_deleted": "false",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"visible_to_circles": {
"uuid": "e5dbe3cd-a485-42a6-884f-d0bcf74e013d",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"accounts": "App\\Http\\Resources\\AccountResource",
"groups": "App\\Http\\Resources\\GroupResource",
"joint_account_uuid": "856678ca-2809-48a3-9a59-aa1546fb2ca0",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"statistics": {
"recent_growth": 100
},
"cases": [
{
"uuid": "4b39178f-e62b-42fd-8ced-47bc2db57b0a",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "finance",
"slug": "finance",
"status": "App\\Http\\Resources\\CasesStatusResource",
"type": "App\\Http\\Resources\\CasesTypeResource",
"review_at": "2026-04-24T17:14:55+01:00",
"assigned_to_uuids": [
"0404847c-6ba1-4b5f-9865-d98d83bd27b3"
],
"group_uuids": [
"9d53db5a-d250-429c-915b-7f4a3ec39906"
],
"completed_at": "2026-04-24T17:14:55+01:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"status_position": 4,
"participants_count": 4,
"participants": "App\\Http\\Resources\\AccountResource",
"task_board_uuid": "5fdfb972-7718-458d-a847-dd691a84f0e1",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource"
}
],
"tags": [
{
"uuid": "a06d5fd4-aa96-4a49-9047-5570a102f598",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": {
"uuid": "f9563a9c-1f4a-43ba-894f-2d4308b128ec",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"opened_at": "2026-04-24T17:14:55+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-04-24T17:14:55+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-24",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-04-24",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
}
},
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"valued_at": "2026-04-24T17:14:55+01:00",
"original_valued_at": "2026-04-23T17:14:55+01:00",
"client": "App\\Http\\Resources\\AccountResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"linked_owners": "App\\Http\\Resources\\AccountResource",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"statistics": {
"recent_growth": 100
},
"cases": "App\\Http\\Resources\\CasesResource",
"tags": "App\\Http\\Resources\\TagResource",
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
"can_be_deleted": "false",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"wrap_children": [
{
"uuid": "e87149c4-5faa-437f-b9ce-718bb2b15307",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"opened_at": "2026-04-24T17:14:55+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-04-24T17:14:55+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-24",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-04-24",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
}
},
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"valued_at": "2026-04-24T17:14:55+01:00",
"original_valued_at": "2026-04-23T17:14:55+01:00",
"client": "App\\Http\\Resources\\AccountResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"linked_owners": "App\\Http\\Resources\\AccountResource",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"statistics": {
"recent_growth": 100
},
"cases": "App\\Http\\Resources\\CasesResource",
"tags": "App\\Http\\Resources\\TagResource",
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
"can_be_deleted": "false",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"linked_policy_numbers": [
{
"uuid": "1586e622-21e7-400a-96fe-d4d16e3dac85",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"linked_policy_number": "ABC123-X",
"plan": "App\\Http\\Resources\\Plans\\PlanResource"
}
],
"can_be_deleted": "false",
"contract_enquiry_account": {
"uuid": "5bf54573-ab06-4094-9af0-fdbd754d802b",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-24T17:14:55+01:00",
"next_review_date": "2026-04-24T17:14:55+01:00",
"previous_review_date": "2026-04-24T17:14:55+01:00",
"anniversary_review_date": "2026-04-24T17:14:55+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:55",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"custom_fields": [
{
"uuid": "3e0a9fb9-1e8b-4b43-91a2-3ba27d243e24",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
],
"external_references": [
{
"uuid": "838ed1fa-19ac-4ae3-aed7-def69b6a2ac2",
"created_at": "2026-04-24T17:14:55+01:00",
"updated_at": "2026-04-24T17:14:55+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}
]
}