Create a sub-scheme for a group scheme plan
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Path parameters
-
uuid The UUID of the group scheme plan.
Body Required
-
The name for the sub-scheme
-
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.
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"}'
# 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"
}
{
"name": "Johns ISA",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "a5f60d92-441e-40b4-b2d5-45af6d8d264b",
"colour": "#ef4582",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+00:00"
}
],
"type": "cash_account",
"uuid": "31fdcfe5-3248-4149-8c4b-017cf04d33d5",
"wrap": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "a76ba49d-da90-4143-9d45-7ddcdade7202",
"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": "2025-01-12T12:56:00+00:00",
"valued_at": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-01-12T12:56:00+00:00",
"review_date": "2024-01-12",
"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": "2024-01-12",
"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": "6c85f63b-01a3-4f2f-9090-7de8231b78ab",
"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": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+00:00",
"completed_at": "2025-01-12T12:56:00+00:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "2af39875-1e01-423b-9599-9df44aacec14",
"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": "ce67f218-143e-46a9-a033-0e67577aada9",
"client": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+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": "2030-01-12",
"claim_start_date": "2024-01-12"
}
],
"client": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "f0bc175f-369e-421f-a5cc-e52d8782070e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-12T12:56:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-12T12:56:00+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": "2025-01-12T12:56:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-12T12:56:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-12T12:56:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-12T12:56:00+00:00"
},
"covers": [
{
"uuid": "85f387b2-2145-4072-8edb-7901af248fa5",
"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": "2025-01-12T12:56:00+00:00",
"indexation": 1.4,
"updated_at": "2025-01-12T12:56:00+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": "39b79da5-e05e-469a-b59c-d6786fa3e92f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-12T12:56:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-12T12:56:00+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": "2025-01-12T12:56:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-12T12:56:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-12T12:56:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-12T12:56:00+00:00"
},
"status": "inactive",
"on_panel": true,
"provider": {
"name": "AJ Bell",
"slug": "aj-bell",
"uuid": "19cd6cf5-ea2d-4f8d-9b7b-4547786ea901",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+00:00"
},
"sub_type": "lifetime isa",
"opened_at": "2025-01-12T12:56:00+00:00",
"valued_at": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-01-12T12:56:00+00:00",
"review_date": "2024-01-12",
"group_scheme": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "5631b188-4c5c-423a-9337-d3f71c03823b",
"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": "2025-01-12T12:56:00+00:00",
"valued_at": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-01-12T12:56:00+00:00",
"review_date": "2024-01-12",
"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": "2024-01-12",
"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": "dda5b8ae-7d2a-4027-a2fd-dc37d6ff0f89",
"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": "2025-01-12T12:56:00+00:00",
"valued_at": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-01-12T12:56:00+00:00",
"review_date": "2024-01-12",
"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": "2024-01-12",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
}
],
"main_account": {
"name": "John's ISA",
"uuid": "87677b12-5e13-4016-8d4a-3fa7cc9778db",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+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": "a2fdac68-1ec8-414d-8111-f827900cb81a",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+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": "294d8571-d2c8-463e-89f1-5169987c4e09",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+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": "2cbffbc8-6ec2-4624-b037-f311d0006cf5",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-12T12:56:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-12T12:56:00+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": "2025-01-12T12:56:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-12T12:56:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-12T12:56:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-12T12:56:00+00:00"
}
],
"policy_number": "AVIVA-123",
"show_on_joint": true,
"wrap_children": [
{
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "c815313b-55df-43b4-913d-38e0779f607e",
"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": "2025-01-12T12:56:00+00:00",
"valued_at": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-01-12T12:56:00+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-01-12T12:56:00+00:00",
"review_date": "2024-01-12",
"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": "2024-01-12",
"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": "a1488616-5efd-48d7-b833-0276e9e8d6fa",
"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": "2025-01-12T12:56:00+00:00",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+00:00",
"sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
}
],
"proposal_reference": "AB123456",
"agency_in_your_name": true,
"external_references": [
{
"uuid": "90be731c-9930-420a-a6cf-600823cf153d",
"reference": "AB123456",
"created_at": "2025-01-12T12:56:00+00:00",
"updated_at": "2025-01-12T12:56:00+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": "2024-01-12",
"contract_enquiry_account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6057ec32-bdd8-4ea6-bf13-f7ab7b685912",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-12T12:56:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-12T12:56:00+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": "2025-01-12T12:56:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-12T12:56:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-12T12:56:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-12T12:56:00+00:00"
},
"visible_on_client_portal": true,
"include_in_client_valuation": true
}