Store an illustration

POST /api/v1/illustration
Personal access token & O auth2

Headers

application/json

Body Required

  • name string Required

    The name of the illustration.

  • client_uuid string Required

    The client UUID to associate the illustration with.

  • requested_by_uuid string Required

    The requested by account UUID to associate the illustration with. If not passed, this will default to the assigned adviser on the client account.

  • plan_uuid string

    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.

  • request_data array[string]

    The request data used to generate the illustration.

  • is_draft boolean Required

    Whether the illustration is a draft or not. If draft, it will not be sent to the platform.

  • platform string Required

    The platform used to generate the illustration.

  • generate boolean

    Whether to generate the illustration. Defaults to true.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • generated_at string

      The timestamp of when the illustration was generated with the platform.

    • status string

      The status of the illustration. Available values: created, generating_illustration and generated_illustration

    • account object

      The account that the illustration belongs to.

    • plan object

      The plan that the illustration belongs to.

    • requested_by object

      The account (adviser) that requested the illustration.

    • name string

      The name of the illustration.

    • request_data array

      The request data used to generate the illustration.

    • platform string

      The platform used to generate the illustration.

    • platform_illustration_id string

      The platform specific illustration id.

    • account_opening_allowed boolean

      Whether the account opening is allowed for the illustration.

    • is_draft boolean

      Whether the illustration is in the created/draft state.
POST /api/v1/illustration 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/illustration' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"SuperSaver 2024","client_uuid":"1d18ca1a-001e-439c-b1ee-4e53d2074bdb","requested_by_uuid":"e924a97d-80f6-4a55-945e-08378e271bd0","plan_uuid":"5281f023-230c-4870-ac67-1e86db8c5689","request_data":["string"],"is_draft":false,"platform":"seccl","generate":true}'
Request examples 
# 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": "SuperSaver 2024",
  "client_uuid": "1d18ca1a-001e-439c-b1ee-4e53d2074bdb",
  "requested_by_uuid": "e924a97d-80f6-4a55-945e-08378e271bd0",
  "plan_uuid": "5281f023-230c-4870-ac67-1e86db8c5689",
  "request_data": [
    "string"
  ],
  "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": "f8ce12a4-1461-4e2d-bc2e-4441a2562840",
    "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-04-22T13:44:17+01:00",
    "valued_at": "2025-04-22T13:44:17+01:00",
    "created_at": "2025-04-22T13:44:17+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-22T13:44:17+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-04-22T13:44:17+01:00",
    "review_date": "2024-04-22",
    "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",
    "original_valued_at": "2025-04-21T13:44:17+01:00",
    "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-04-22",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "uuid": "b7e13108-ce13-4dd6-b33b-9d9b3114006e",
  "status": "created",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "ad6a7404-850c-452d-9ab5-a1c724bf9c38",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "is_draft": true,
  "platform": "seccl",
  "created_at": "2025-04-22T13:44:17+01:00",
  "updated_at": "2025-04-22T13:44:17+01:00",
  "generated_at": "2025-04-22T13:44:17+01:00",
  "request_data": [],
  "requested_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "449a7d89-7718-4395-bee5-cd3c8c8a6b0a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "account_opening_allowed": true,
  "platform_illustration_id": "ABC0123456789"
}