Store an illustration Run in API Explorer
Ask AI
Body
-
The name of the illustration.
-
The client UUID to associate the illustration with. (deprecated: use accounts instead)
-
An array of client account UUIDs to associate the illustration with.
-
The requested by account UUID to associate the illustration with. If not passed, this will default to the assigned adviser on the client account.
-
The plan UUID to associate the illustration with. If not provided and is_draft is false, a new proposed plan will be created using the request_data.
-
The request data used to generate the illustration.
Additional properties are allowed.
-
Whether the illustration is a draft or not. If draft, it will not be sent to the platform.
-
The platform used to generate the illustration.
-
Whether to generate the illustration. Defaults to true.
POST
/api/v1/illustration
curl \
--request POST 'https://api.plannrcrm.com/api/v1/illustration' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"SuperSaver 2024","client_uuid":"ccfee9c3-afc7-432d-bb03-2948e9f458f1","accounts":["c0e251d9-5f0e-430e-9f6b-589b1478f63d","3758371e-36da-4661-af95-bc5a8f1fb9e9","739b7605-730c-492f-9b10-f6ba91f2503b"],"requested_by_uuid":"1bae8e56-a4ce-488c-a2c5-98aaabcd5b11","plan_uuid":"ee2ea53f-211a-414e-8931-d5ab79c27fc7","request_data":{},"is_draft":false,"platform":"seccl","generate":true}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "SuperSaver 2024",
"client_uuid": "ccfee9c3-afc7-432d-bb03-2948e9f458f1",
"accounts": [
"c0e251d9-5f0e-430e-9f6b-589b1478f63d",
"3758371e-36da-4661-af95-bc5a8f1fb9e9",
"739b7605-730c-492f-9b10-f6ba91f2503b"
],
"requested_by_uuid": "1bae8e56-a4ce-488c-a2c5-98aaabcd5b11",
"plan_uuid": "ee2ea53f-211a-414e-8931-d5ab79c27fc7",
"request_data": {},
"is_draft": false,
"platform": "seccl",
"generate": true
}
Response examples (200)
{
"name": "Illustration Name",
"plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "2e322f1a-cb4b-4e50-8987-409589f6bb98",
"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",
"accounts": "App\\Http\\Resources\\AccountResource",
"on_panel": true,
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"sub_type": "lifetime isa",
"opened_at": "2025-12-24T11:02:59+00:00",
"valued_at": "2025-12-24T11:02:59+00:00",
"created_at": "2025-12-24T11:02:59+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-12-24T11:02:59+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-12-24T11:02:59+00:00",
"review_date": "2024-12-24",
"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,
"shown_on_circles": true,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-12-23T11:02:59+00:00",
"proposal_reference": "AB123456",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"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-12-24",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"uuid": "543c4ca0-0daf-42b9-ae9a-86189626573d",
"client": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "18dfa7fd-75bc-4e6d-a579-121657bafdc6",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-12-24T11:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"status": "created",
"accounts": [
{
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "74b098b9-d349-4882-a55b-dccda56b4fdb",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-12-24T11:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"is_draft": true,
"platform": "seccl",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"application": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Illustration Name",
"plan": "App\\Http\\Resources\\Plans\\PlanResource",
"uuid": "261424d4-8277-43fc-8425-1406950e5f5f",
"status": "draft",
"clients": [
"App\\Http\\Resources\\MinimalAccountResource"
],
"platform": "seccl",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"generated_at": "2025-12-24T11:02:59+00:00",
"illustration": "App\\Http\\Resources\\IllustrationResource",
"request_data": [],
"requested_by": "App\\Http\\Resources\\MinimalAccountResource",
"platform_illustration_id": "ABC0123456789"
},
"generated_at": "2025-12-24T11:02:59+00:00",
"request_data": [],
"requested_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "ab54edd3-a891-4f2c-b9cd-cb79203daf68",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-24T11:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+00:00",
"with_login": true,
"inactive_at": "2025-12-24",
"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-12-24T11:02:59+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:02:59",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:02:59+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:02:59+00:00"
},
"account_opening_allowed": true,
"platform_illustration_id": "ABC0123456789"
}