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.
-
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
-
filter the plans by if they have agency in your name
-
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/v1/plans' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
[
{
"uuid": "75b94edd-8761-47c0-94c6-11eebdc8717e",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"opened_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-30",
"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-30",
"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": "55a74b8e-7ff8-4e28-a3dc-5172e70dd0aa",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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": "ddd7381d-b3a9-4fe1-a93f-9f71184e752d",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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": "da47e4b5-b15c-4164-9718-0be32a6ffcd8",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"name": "AJ Bell",
"slug": "aj-bell"
},
"covers": [
{
"uuid": "76a0f36a-ae63-4bb6-a271-06a2dd141578",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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": "05c962a6-2603-45a4-ac56-f9d7f2a7df1d",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30",
"claim_end_date": "2031-04-30",
"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": "eb723a4e-78db-41a4-8bed-aba97b02675d",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"valued_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"original_valued_at": "2026-04-29T14:48:32+01:00",
"client": {
"uuid": "ab8b8a28-71de-4b0a-81f3-378c3e0a67d2",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"next_review_date": "2026-04-30T14:48:32+01:00",
"previous_review_date": "2026-04-30T14:48:32+01:00",
"anniversary_review_date": "2026-04-30T14:48: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-30",
"last_interaction_at": "2026-04-30 14:48: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": "62e72a45-807b-4bd6-89ad-7229470e8802",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"next_review_date": "2026-04-30T14:48:32+01:00",
"previous_review_date": "2026-04-30T14:48:32+01:00",
"anniversary_review_date": "2026-04-30T14:48: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-30",
"last_interaction_at": "2026-04-30 14:48: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": "abb8394a-c9da-41e4-b99b-3a37dc44d27f",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"next_review_date": "2026-04-30T14:48:32+01:00",
"previous_review_date": "2026-04-30T14:48:32+01:00",
"anniversary_review_date": "2026-04-30T14:48: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-30",
"last_interaction_at": "2026-04-30 14:48: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": "ba729e11-b613-496a-801a-45e7bfb8c4f7",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"next_review_date": "2026-04-30T14:48:32+01:00",
"previous_review_date": "2026-04-30T14:48:32+01:00",
"anniversary_review_date": "2026-04-30T14:48: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-30",
"last_interaction_at": "2026-04-30 14:48: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": "284604e4-d0af-4264-9b37-04c845e0563a",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"opened_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-30",
"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-30",
"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-30T14:48:32+01:00",
"original_valued_at": "2026-04-29T14:48: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": "e31eb38e-3d47-466c-9544-7d16f25d3b81",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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": "cbac4652-cfbb-4d88-8713-d5c4dd62d582",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"statistics": {
"recent_growth": 100
},
"cases": [
{
"uuid": "a34db543-e5c7-463f-9c9f-5e31cfa0eda5",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"name": "finance",
"slug": "finance",
"status": "App\\Http\\Resources\\CasesStatusResource",
"type": "App\\Http\\Resources\\CasesTypeResource",
"review_at": "2026-04-30T14:48:32+01:00",
"assigned_to_uuids": [
"3e9c05a1-55d6-4f13-a42d-1a3dba7fda39"
],
"group_uuids": [
"61b102b3-26b6-4a4d-b6fa-0e1d9e81fb36"
],
"completed_at": "2026-04-30T14:48: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": "6846cfb4-5509-4c5a-91ad-42ad589d6043",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource"
}
],
"tags": [
{
"uuid": "d0ec7a1c-aa51-4a61-8cac-53ac80caf923",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": {
"uuid": "533029cd-f749-454d-addc-3ca7c7bfb3ee",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"opened_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-30",
"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-30",
"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-30T14:48:32+01:00",
"original_valued_at": "2026-04-29T14:48: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": "4f7ad893-8914-4263-b6e0-3367e19e646c",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"opened_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-04-30",
"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-30",
"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-30T14:48:32+01:00",
"original_valued_at": "2026-04-29T14:48: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": "46a73796-9789-4c9e-b797-f8dc09a18321",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"linked_policy_number": "ABC123-X",
"plan": "App\\Http\\Resources\\Plans\\PlanResource"
}
],
"can_be_deleted": "false",
"contract_enquiry_account": {
"uuid": "678d81b8-d21d-4a28-a881-0e21fde4c08b",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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-30T14:48:32+01:00",
"next_review_date": "2026-04-30T14:48:32+01:00",
"previous_review_date": "2026-04-30T14:48:32+01:00",
"anniversary_review_date": "2026-04-30T14:48: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-30",
"last_interaction_at": "2026-04-30 14:48: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": "3a42b0b1-6388-44d3-ac00-eaf90f797198",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48: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": "9338379a-337d-4779-ab44-782eac9fae5f",
"created_at": "2026-04-30T14:48:32+01:00",
"updated_at": "2026-04-30T14:48:32+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}
]
]
}