Body
Required
-
Plan UUID. Must be a plan belonging to the firm. Required if client_uuid is not provided
-
Client UUID. Must be a client belonging to the firm. Comma seperated list of uuids. Required if plan_uuid is not provided
-
Type of contribution, must be one of these types: initial, increment, decrement, advice_point, pension_transfer and switch
-
Notes for contribution type.
-
Adviser UUID. Must be employee of the firm
-
Type of advice, must be one of these types: advised, execution_only, insistent_investor, existing_provision, direct_offer and client_instruction
-
How the advice was conducted, must be one of these types: correspondence_only, email, face_to_face, internet, other, printed_media_campaign, unknown and telephone
-
Source of funds, must be one of these types: gift, inheritance, isa_transfer, pension_transfer, salary, savings and other
-
Note for other source of funds. Required if source_of_funds is "other"
-
Start date of premium. Required if status is "accepted"
-
Proposal date of the New Business Event
-
Case UUID to link this to a existing case
-
Is this a vulnerable client. Defaults to "no". Must be one of these types: yes, no and possibly
-
Is this replacing an existing plan
-
Existing Plan UUID. Must be a plan belonging to the firm.
-
Details of existing plan. Required if is_replacing_existing_plan is true and existing_plan_uuid is empty
-
Did the client opt out of an employer sponsored pension scheme to take out this plan. Required if related to a plan and is a pension plan
-
The datetime when the pension scheme was opted out of. Required if opted_out_of_pension_scheme_for_plan is true
-
Notes for opting out of pension scheme. Required if opted_out_of_pension_scheme_for_plan is true
-
Staus of the New Business Event. Must be one of these types: accepted and proposed
curl \
--request POST 'https://api.plannrcrm.com/api/v1/new-business-event' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"plan_uuid":"a707238a-2a2d-421b-9dd6-349163a12cdc","client_uuid":"e44eb239-c456-40c9-9f79-241e14a424ec","contribution_type":"initial","contribution_type_notes":"Notes for contribution type","adviser_uuid":"967178da-c86e-4ed7-b216-2fed965fd0e0","advice_type":"advised","conducted_by":"email","source_of_funds":"salary","source_of_funds_note":"Other source of funds","premium_amount":10000,"premium_currency":"GBP","premium_frequency":"monthly","start_date":"2021-01-01","proposal_date":"2020-10-12","case_uuid":"96abe218-a1c0-4274-bceb-ed2d34c3e597","is_vulnerable_client":"possibly","is_replacing_existing_plan":true,"existing_plan_uuid":"78dbae8a-5308-4e19-b32e-8203ea5130d0","existing_plan_details":"Existing plan details","opted_out_of_pension_scheme_for_plan":true,"opted_out_at":"2025-07-17T16:23:25+01:00","opted_out_notes":"Opted out of pension scheme","status":"accepted"}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"plan_uuid": "a707238a-2a2d-421b-9dd6-349163a12cdc",
"client_uuid": "e44eb239-c456-40c9-9f79-241e14a424ec",
"contribution_type": "initial",
"contribution_type_notes": "Notes for contribution type",
"adviser_uuid": "967178da-c86e-4ed7-b216-2fed965fd0e0",
"advice_type": "advised",
"conducted_by": "email",
"source_of_funds": "salary",
"source_of_funds_note": "Other source of funds",
"premium_amount": 10000,
"premium_currency": "GBP",
"premium_frequency": "monthly",
"start_date": "2021-01-01",
"proposal_date": "2020-10-12",
"case_uuid": "96abe218-a1c0-4274-bceb-ed2d34c3e597",
"is_vulnerable_client": "possibly",
"is_replacing_existing_plan": true,
"existing_plan_uuid": "78dbae8a-5308-4e19-b32e-8203ea5130d0",
"existing_plan_details": "Existing plan details",
"opted_out_of_pension_scheme_for_plan": true,
"opted_out_at": "2025-07-17T16:23:25+01:00",
"opted_out_notes": "Opted out of pension scheme",
"status": "accepted"
}
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "ed619aee-68d8-429c-be8c-f7ff925e8c6c",
"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",
"review_at": "2025-07-17T16:23:25+01:00",
"created_at": "2025-07-17T16:23:25+01:00",
"updated_at": "2025-07-17T16:23:25+01:00",
"group_uuids": [
"0fbbee5e-b977-40d2-abb4-9149bfbce4c5"
],
"completed_at": "2025-07-17T16:23:25+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "efbca427-33c2-48b2-9d67-721c38de8980",
"assigned_to_uuids": [
"beb28d54-e8dc-4b20-9cda-6746059e64ce"
],
"participants_count": 4
},
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "0da7e4d2-705b-4db0-9f10-6ee57f6b8188",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-07-17T16:23:25+01:00",
"updated_at": "2025-07-17T16:23:25+01:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#ffffff",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#ffffff",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#ffffff",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_account_email": "#828994",
"portal_sidebar_title": "#11151d",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#e3e5e9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323b4b",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323b4b",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#ffffff",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
},
"plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "a1596f0f-9e04-42ee-bf79-d57b4da1e673",
"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-07-17T16:23:25+01:00",
"valued_at": "2025-07-17T16:23:25+01:00",
"created_at": "2025-07-17T16:23:25+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-07-17T16:23:25+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-07-17T16:23:25+01:00",
"review_date": "2024-07-17",
"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-07-16T16:23:25+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-07-17",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"uuid": "10852fac-cd8e-45b9-9d97-42e9548a8edd",
"status": "accepted",
"adviser": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "34132f1f-62f0-49d4-9a3f-f0671bb80cea",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:25+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:25+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:25+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:25+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-07-17T16:23:25+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:25+01:00"
},
"clients": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "2ca3b45b-7004-4e2d-9b78-cec7022b4652",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:25+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:25+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:25+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:25+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-07-17T16:23:25+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:25+01:00"
},
"premium": {
"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"
}
},
"modelable": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "b296ee03-2c4c-40f4-8b30-55a2a8c60622",
"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-07-17T16:23:25+01:00",
"valued_at": "2025-07-17T16:23:25+01:00",
"created_at": "2025-07-17T16:23:25+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-07-17T16:23:25+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-07-17T16:23:25+01:00",
"review_date": "2024-07-17",
"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-07-16T16:23:25+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-07-17",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"created_at": "2025-07-17T16:23:25+01:00",
"start_date": "2021-09-24",
"updated_at": "2025-07-17T16:23:25+01:00",
"advice_type": "execution_only",
"conducted_by": "email",
"opted_out_at": "2025-07-17T16:23:25+01:00",
"existing_plan": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "73cd5af3-df2b-4bfe-b5f6-488d8fd3c8c8",
"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-07-17T16:23:25+01:00",
"valued_at": "2025-07-17T16:23:25+01:00",
"created_at": "2025-07-17T16:23:25+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-07-17T16:23:25+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-07-17T16:23:25+01:00",
"review_date": "2024-07-17",
"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-07-16T16:23:25+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-07-17",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"proposal_date": "2021-09-01",
"modelable_type": "plan",
"opted_out_notes": "Opted out notes",
"contribution_type": "increment",
"premium_frequency": "monthly",
"is_vulnerable_client": true,
"existing_plan_details": "Existing plan details",
"contribution_type_notes": "Contribution type notes",
"is_replacing_existing_plan": true,
"opted_out_of_pension_scheme_for_plan": true
}