Get all client plans Run in API Explorer
Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [fields, client, cases, tags, sub_accounts, latest_valuations, latest_valuations.sub_account, wrap, wrap_children, wrap_children.latest_valuations, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].
-
Filter by a comma separated list of UUIDs.
-
If filter is provided then we will also return any other plans the client is linked to [asset, liability, protection]
-
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 plan names to search against, can include partial matches.
-
Comma separated list of client 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 names or provider UUIDs to search against, can include partial matches.
-
Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]
-
Comma separated list of adviser names or adviser UUIDs of who sold the plan to search against, can include partial matches.
-
Comma separated list of adviser names or adviser UUIDs of who is actively managing the plan to search against, can include partial matches.
-
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'.
-
filter the plans by if they have agency in your name
-
Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/plans' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
[
{
"uuid": "dd427dd3-d56b-4901-8229-7b39ae4d8686",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"opened_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-29",
"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-29",
"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": "7684458a-9afe-4880-bdee-4461402d7c50",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "624806b6-b245-4007-bf18-79d65dd9db16",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "028ef546-9ddd-48ea-aa8a-6a0ea3cfdc06",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"name": "AJ Bell",
"slug": "aj-bell"
},
"covers": [
{
"uuid": "d36340ed-4323-42c5-8246-62785ddc8b4e",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "2cbddb6f-f6c8-42ba-9d04-301d24ecf8c0",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29",
"claim_end_date": "2031-04-29",
"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": "25f69dc2-7ec9-421d-b77a-021b2215ed74",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"valued_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"original_valued_at": "2026-04-28T16:54:32+01:00",
"client": {
"uuid": "3bfa2407-865b-478f-a14f-5554f7ee3e0a",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "7c927aee-02fe-4857-aa45-e16f6def29db",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "d9059977-b3eb-4226-9209-9863b86fdb99",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "c026eb6b-e701-4fd2-a720-87ad1c25d2ef",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "c14e9bec-ae62-4ffa-9af4-1f645c10a8f3",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"opened_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-29",
"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-29",
"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-29T16:54:32+01:00",
"original_valued_at": "2026-04-28T16:54:32+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": "946b976e-5548-4b16-b5b0-de66fa8b675e",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "5fb48acb-6ae2-497a-80de-73fbde543c44",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"statistics": {
"recent_growth": 100
},
"cases": [
{
"uuid": "bfee1946-6e89-4aa1-ab60-c2d467864773",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"name": "finance",
"slug": "finance",
"status": "App\\Http\\Resources\\CasesStatusResource",
"type": "App\\Http\\Resources\\CasesTypeResource",
"review_at": "2026-04-29T16:54:32+01:00",
"assigned_to_uuids": [
"4ed2fba4-f6b8-43be-b2f9-ace2a23708e6"
],
"group_uuids": [
"f5ba8f79-28a5-47bf-b798-be6799f9374c"
],
"completed_at": "2026-04-29T16:54:32+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": "79d945b4-963e-46c6-8916-287ab5c57280",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource"
}
],
"tags": [
{
"uuid": "d2e8a373-9c57-4bb3-a507-6bbd98a0eb63",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": {
"uuid": "e7fad8ea-c683-447f-bc0a-b320a0983be1",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"opened_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-29",
"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-29",
"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-29T16:54:32+01:00",
"original_valued_at": "2026-04-28T16:54:32+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": "d348d2e8-e250-449b-8c2f-b813d9ab64a8",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"opened_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-29",
"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-29",
"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-29T16:54:32+01:00",
"original_valued_at": "2026-04-28T16:54:32+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": "9cf60a86-8146-49c3-bc83-4abc410699cc",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"linked_policy_number": "ABC123-X",
"plan": "App\\Http\\Resources\\Plans\\PlanResource"
}
],
"can_be_deleted": "false",
"contract_enquiry_account": {
"uuid": "fb994aca-005e-45dc-a470-f84686f3163c",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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-29T16:54:32+01:00",
"next_review_date": "2026-04-29T16:54:32+01:00",
"previous_review_date": "2026-04-29T16:54:32+01:00",
"anniversary_review_date": "2026-04-29T16:54:32+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-29",
"last_interaction_at": "2026-04-29 16:54:32",
"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": "901f3e56-b28a-4533-a171-7a5f99492f69",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+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": "ab880a12-fefa-4dba-8430-3bf55d50aace",
"created_at": "2026-04-29T16:54:32+01:00",
"updated_at": "2026-04-29T16:54:32+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}
]
]
}