Create a new business event

POST /api/v1/new-business-event

Headers

application/json

Body Required

  • plan_uuid string

    Plan UUID. Must be a plan belonging to the firm. Required if client_uuid is not provided

  • client_uuid string

    Client UUID. Must be a client belonging to the firm. Required if plan_uuid is not provided

  • contribution_type string Required

    Type of contribution, must be one of these types: initial, increment, decrement, advice_point, pension_transfer and switch

  • contribution_type_notes string

    Notes for contribution type.

  • adviser_uuid string Required

    Adviser UUID. Must be employee of the firm

  • advice_type string Required

    Type of advice, must be one of these types: advised, execution_only, insistent_investor, existing_provision, direct_offer and client_instruction

  • conducted_by string Required

    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 string Required

    Source of funds, must be one of these types: gift, inheritance, isa_transfer, pension_transfer, salary and other

  • source_of_funds_note string

    Note for other source of funds. Required if source_of_funds is "other"

  • premium_amount integer

    Premium amount in pence. 10000 = £100.00

  • premium_currency string

    Premium currency. Defaults to "GBP". Must be one of these types: GBP

  • premium_frequency string

    Premium frequency, must be one of these types: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off

  • start_date date

    Start date of premium. Required if status is "accepted"

  • proposal_date date

    Proposal date of the New Business Event

  • case_uuid string

    Case UUID to link this to a existing case

  • is_vulnerable_client string

    Is this a vulnerable client. Defaults to "no". Must be one of these types: yes, no and possibly

  • is_replacing_existing_plan boolean

    Is this replacing an existing plan

  • existing_plan_uuid string

    Existing Plan UUID. Must be a plan belonging to the firm.

  • existing_plan_details string

    Details of existing plan. Required if is_replacing_existing_plan is true and existing_plan_uuid is empty

  • opted_out_of_pension_scheme_for_plan boolean

    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

  • opted_out_at date

    The datetime when the pension scheme was opted out of. Required if opted_out_of_pension_scheme_for_plan is true

  • opted_out_notes string

    Notes for opting out of pension scheme. Required if opted_out_of_pension_scheme_for_plan is true

  • status string Required

    Staus of the New Business Event. Must be one of these types: accepted and proposed

Responses

POST /api/v1/new-business-event 
curl \
 -X POST https://api.plannrcrm.com/api/v1/new-business-event \
 -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 '{"plan_uuid":"76ddfbf6-ae16-4c00-b5e5-b24ef014fc98","client_uuid":"d36d7584-1b28-4970-ba46-58331f1a47eb","contribution_type":"initial","contribution_type_notes":"Notes for contribution type","adviser_uuid":"342e0694-b6aa-4296-a70f-7da2ec9345eb","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":"3e00aa7b-f89f-4f11-880c-242d5f3cdc24","is_vulnerable_client":"possibly","is_replacing_existing_plan":true,"existing_plan_uuid":"5ebf7cc6-2943-4c0e-b526-10fbb4f20afb","existing_plan_details":"Existing plan details","opted_out_of_pension_scheme_for_plan":true,"opted_out_at":"2024-11-20T13:24:04+00:00","opted_out_notes":"Opted out of pension scheme","status":"accepted"}'
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
{
  "plan_uuid": "76ddfbf6-ae16-4c00-b5e5-b24ef014fc98",
  "client_uuid": "d36d7584-1b28-4970-ba46-58331f1a47eb",
  "contribution_type": "initial",
  "contribution_type_notes": "Notes for contribution type",
  "adviser_uuid": "342e0694-b6aa-4296-a70f-7da2ec9345eb",
  "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": "3e00aa7b-f89f-4f11-880c-242d5f3cdc24",
  "is_vulnerable_client": "possibly",
  "is_replacing_existing_plan": true,
  "existing_plan_uuid": "5ebf7cc6-2943-4c0e-b526-10fbb4f20afb",
  "existing_plan_details": "Existing plan details",
  "opted_out_of_pension_scheme_for_plan": true,
  "opted_out_at": "2024-11-20T13:24:04+00:00",
  "opted_out_notes": "Opted out of pension scheme",
  "status": "accepted"
}
Response examples (201) 
{
  "case": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "b4423e33-912b-4164-9fd8-2530f865d9cc",
    "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": "2024-11-20T13:24:04+00:00",
    "updated_at": "2024-11-20T13:24:04+00:00",
    "completed_at": "2024-11-20T13:24:04+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "21a8d6a5-48e7-40df-984a-247ccee53088",
    "participants_count": 4
  },
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "5aeb2e78-4439-44c1-9391-4d23f70e2133",
    "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": "2024-11-20T13:24:04+00:00",
    "updated_at": "2024-11-20T13:24:04+00: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",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "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!"
  },
  "uuid": "27d042ad-45be-4599-b8f9-a94cdf3d7973",
  "status": "accepted",
  "adviser": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "4d03cc48-6cde-40ef-a056-a16d48ae5546",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:04+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:04+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": "2024-11-20T13:24:04+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:04+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:04+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:04+00: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": "560f622e-39a8-45fd-bcb0-682b45b572c6",
    "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": "2024-11-20T13:24:04+00:00",
    "valued_at": "2024-11-20T13:24:04+00:00",
    "created_at": "2024-11-20T13:24:04+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:04+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:04+00:00",
    "review_date": "2023-11-20",
    "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": "2023-11-20",
    "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
    "visible_on_client_portal": true,
    "include_in_client_valuation": true
  },
  "created_at": "2024-11-20T13:24:04+00:00",
  "start_date": "2021-09-24",
  "updated_at": "2024-11-20T13:24:04+00:00",
  "advice_type": "execution_only",
  "conducted_by": "email",
  "opted_out_at": "2024-11-20T13:24:04+00:00",
  "existing_plan": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "1347ac9e-39ac-4a80-96e2-55d0eef4cb05",
    "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": "2024-11-20T13:24:04+00:00",
    "valued_at": "2024-11-20T13:24:04+00:00",
    "created_at": "2024-11-20T13:24:04+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2024-11-20T13:24:04+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2024-11-20T13:24:04+00:00",
    "review_date": "2023-11-20",
    "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": "2023-11-20",
    "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
}