Body Required

• name string

  Descriptive name of the plan

• client_uuid string Required

  [DEPRACATED] Please use accounts instead. Account uuid linked with the plan

• accounts array[string]

  Accounts that own this plan, along with their percentage ownership. Any percentages that have not be defined will be split equally against the remaining percentage.

• type string Required

  Type of plan, must be one of these types: annuity, cash_account, fixed_asset, general_insurance, group_protection, investment, loan_credit, mortgage, pension and protection_policy

• sub_type string Required

  Plan sub type

• provider_uuid string Required

  uuid of the provider

• policy_number string

  Main policy number for the plan, will be stored as the main accounts policy number

• proposal_reference string

  Main proposal reference for the plan, will be stored as the main accounts proposal reference

• opened_at string

  date when the plan was purchased or account was opened

• status string Required

  Status of plan, must be one of these types: active, inactive and proposed

• inactive_at date

  Date when plan went inactive

• inactive_reason string

  Reason of inactivity, must be one of these types: 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

• agency_in_your_name boolean

  Agency in your name

• agency_in_your_name_from date

  Date agency was in your name from

• originally_sold_by_firm boolean

  Whether the plan was originally sold by your firm

• under_advice boolean

  Under advice

• visible_on_client_portal boolean

  Whether this plan will be shown to clients in their client portal. Will default to true if not provided.

• include_in_client_valuation boolean

  Include in client valuation. Will default to true if not provided.

• show_on_joint boolean

  If the plan belongs to an individual account, then you can opt to also show this plan on any joint accounts the individual client belongs to, otherwise value is ignored. Will default to false if not provided.

• review_date date

  Next review date

• on_panel boolean Required

  On panel

• seller_uuid string

  Employee account that sold this plan

• active_adviser_uuid string

  Employee account that is managing this plan

• adviser_split_uuid string

  A plan adviser split to be applied to charges to this plan

• cases array[string]

  Array of case uuids

• linked_owners array[string]

  Linked clients who should be added as extra owners of the plan.

• visible_to_circles_uuids array[string]

  Circles UUIDs that can view the plan when filtering plans by circles. Leaving blank means the plan will be visible for all circles which contains the plan owners.

• current_value integer

  The current value of the plan in pennies. Can be provided with current_value_at to specify the date that the plan was valued at.

• current_value_at date

  Optional date to be used with current_value. If left blank it will default to the current day.

• is_group_scheme boolean

  Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes. Only business clients can have group schemes. Will default to false if not provided.

• is_wrap_product boolean

  Denotes if the plan is a wrap product, and can have plans linked under it. Will default to false if not provided.

• wrap_uuid string

  The UUID of the wrap product to link this plan too

• contract_enquiry_account_uuid string

  The UUID of the account used for contract enquiry.

• beneficiaries array[string]

  The beneficiaries of the plan.

• platform_provider string

  platform_provider field, this is found on types (annuity cash_account investment pension)

• life_assured string

  life_assured field, this is found on types (annuity)

• sum_assured string

  sum_assured field, this is found on types (annuity)

• term_type string

  term_type field, this is found on types (annuity cash_account general_insurance group_protection investment loan_credit mortgage pension protection_policy)

• term_maturity_date string

  term_maturity_date field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)

• term_age string

  term_age field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)

• term_maturity_value string

  term_maturity_value field, this is found on types (annuity)

• guaranteed_term string

  guaranteed_term field, this is found on types (annuity)

• payment_type string

  payment_type field, this is found on types (annuity)

• income_amount string

  income_amount field, this is found on types (annuity)

• income_frequency string

  income_frequency field, this is found on types (annuity)

• income_from string

  income_from field, this is found on types (annuity)

• income_escalation string

  income_escalation field, this is found on types (annuity)

• initial_purchase_amount string

  initial_purchase_amount field, this is found on types (annuity)

• interest_type string

  interest_type field, this is found on types (cash_account investment loan_credit mortgage)

• interest_rate string

  interest_rate field, this is found on types (cash_account investment loan_credit mortgage)

• address_1 string

  address_1 field, this is found on types (fixed_asset)

• address_2 string

  address_2 field, this is found on types (fixed_asset)

• address_3 string

  address_3 field, this is found on types (fixed_asset)

• address_4 string

  address_4 field, this is found on types (fixed_asset)

• town_city string

  town_city field, this is found on types (fixed_asset)

• county string

  county field, this is found on types (fixed_asset)

• postcode string

  postcode field, this is found on types (fixed_asset)

• country string

  country field, this is found on types (fixed_asset)

• new_property string

  new_property field, this is found on types (fixed_asset)

• price_listed string

  price_listed field, this is found on types (fixed_asset)

• purchase_price string

  purchase_price field, this is found on types (fixed_asset)

• asset_description string

  asset_description field, this is found on types (fixed_asset)

• asset_image string

  asset_image field, this is found on types (fixed_asset)

• ncd string

  ncd field, this is found on types (general_insurance)

• ncd_protected string

  ncd_protected field, this is found on types (general_insurance)

• ncd_years string

  ncd_years field, this is found on types (general_insurance)

• renewal_date string

  renewal_date field, this is found on types (general_insurance group_protection)

• offshore string

  offshore field, this is found on types (investment)

• in_trust string

  in_trust field, this is found on types (investment protection_policy)

• trustee_details string

  trustee_details field, this is found on types (investment protection_policy)

• original_balance string

  original_balance field, this is found on types (loan_credit mortgage)

• outstanding_balance string

  outstanding_balance field, this is found on types (loan_credit mortgage)

• loan_amount string

  loan_amount field, this is found on types (loan_credit)

• repayment_amount string

  repayment_amount field, this is found on types (loan_credit)

• repayment_frequency string

  repayment_frequency field, this is found on types (loan_credit)

• details string

  details field, this is found on types (loan_credit)

• property_type string

  property_type field, this is found on types (mortgage)

• payment_amount string

  payment_amount field, this is found on types (mortgage)

• payment_frequency string

  payment_frequency field, this is found on types (mortgage)

• initial_interest string

  initial_interest field, this is found on types (mortgage)

• initial_period_end string

  initial_period_end field, this is found on types (mortgage)

• initial_payment string

  initial_payment field, this is found on types (mortgage)

• equity_released string

  equity_released field, this is found on types (mortgage)

• loan_quote string

  loan_quote field, this is found on types (mortgage)

• loan_type string

  loan_type field, this is found on types (mortgage)

• mig_added string

  mig_added field, this is found on types (mortgage)

• mig_premium string

  mig_premium field, this is found on types (mortgage)

• repayment_type string

  repayment_type field, this is found on types (mortgage)

• repayment_method string

  repayment_method field, this is found on types (mortgage)

• repayment_term string

  repayment_term field, this is found on types (mortgage)

• other_repayment_method string

  other_repayment_method field, this is found on types (mortgage)

• scheme_fixed_date string

  scheme_fixed_date field, this is found on types (mortgage)

• transaction_details string

  transaction_details field, this is found on types (mortgage)

• base_payment string

  base_payment field, this is found on types (mortgage)

• has_transfer_penalties string

  has_transfer_penalties field, this is found on types (mortgage)

• is_portable_mortgage string

  is_portable_mortgage field, this is found on types (mortgage)

• transfer_consent string

  transfer_consent field, this is found on types (mortgage)

• transfer_penalty string

  transfer_penalty field, this is found on types (mortgage)

• contract_exchanged string

  contract_exchanged field, this is found on types (mortgage)

• date_complete string

  date_complete field, this is found on types (mortgage)

• date_confirmed string

  date_confirmed field, this is found on types (mortgage)

• date_exchanged string

  date_exchanged field, this is found on types (mortgage)

• date_submitted string

  date_submitted field, this is found on types (mortgage)

• mortgage_completed string

  mortgage_completed field, this is found on types (mortgage)

• offer_confirmed string

  offer_confirmed field, this is found on types (mortgage)

• offer_confirmed_date string

  offer_confirmed_date field, this is found on types (mortgage)

• offer_date string

  offer_date field, this is found on types (mortgage)

• offer_issued string

  offer_issued field, this is found on types (mortgage)

• on_risk string

  on_risk field, this is found on types (mortgage)

• proposal_date string

  proposal_date field, this is found on types (mortgage)

• submitted string

  submitted field, this is found on types (mortgage)

• declined_notes string

  declined_notes field, this is found on types (mortgage)

• accrual_rate string

  accrual_rate field, this is found on types (pension)

• year_accrued string

  year_accrued field, this is found on types (pension)

• retirement_date string

  retirement_date field, this is found on types (pension)

• pensionable_salary string

  pensionable_salary field, this is found on types (pension)

• transfer_value string

  transfer_value field, this is found on types (pension)

• date_of_transfer_valuation string

  date_of_transfer_valuation field, this is found on types (pension)

• widows_percentage string

  widows_percentage field, this is found on types (pension)

• contracted_out string

  contracted_out field, this is found on types (pension)

• had_avc string

  had_avc field, this is found on types (pension)

• in_house_avc_amount string

  in_house_avc_amount field, this is found on types (pension)

• in_house_avc_percentage string

  in_house_avc_percentage field, this is found on types (pension)

• death_benefit_amount string

  death_benefit_amount field, this is found on types (pension)

• projected_income string

  projected_income field, this is found on types (pension)

• plan_retirement_age string

  plan_retirement_age field, this is found on types (pension)

• state_retirement_age string

  state_retirement_age field, this is found on types (pension)

• salary_sacrifice string

  salary_sacrifice field, this is found on types (pension)

• waiver string

  waiver field, this is found on types (pension)

• is_crystallised string

  is_crystallised field, this is found on types (pension)

• crystallisation_amount string

  crystallisation_amount field, this is found on types (pension)

• crystallisation_benefit string

  crystallisation_benefit field, this is found on types (pension)

• crystallisation_fund string

  crystallisation_fund field, this is found on types (pension)

• crystallisation_start_date string

  crystallisation_start_date field, this is found on types (pension)

• crystallisation_end_date string

  crystallisation_end_date field, this is found on types (pension)

• crystallisation_frequency string

  crystallisation_frequency field, this is found on types (pension)

• fund_amount string

  fund_amount field, this is found on types (pension)

• uncrystallised_fund string

  uncrystallised_fund field, this is found on types (pension)

• income_taken_amount string

  income_taken_amount field, this is found on types (pension)

• maximum_income_amount string

  maximum_income_amount field, this is found on types (pension)

• tax_free_amount string

  tax_free_amount field, this is found on types (pension)

• lifetime_allowance_percentage string

  lifetime_allowance_percentage field, this is found on types (pension)

• lta_applied string

  lta_applied field, this is found on types (pension)

• mpaa_trigger string

  mpaa_trigger field, this is found on types (pension)

• pcls_percentage string

  pcls_percentage field, this is found on types (pension)

• reason string

  reason field, this is found on types (pension)

• has_pre_existing_conditions string

  has_pre_existing_conditions field, this is found on types (protection_policy)

• pre_existing_conditions_notes string

  pre_existing_conditions_notes field, this is found on types (protection_policy)

• external_reference array[string]

  A third-party external reference to attach when creating the model. The third party must be one of the following: adviser_office, aj_bell, be_iq_organisation, conquest, filehaven, finio, fundment, intelliflo_office, octopus_money, nucleus, p1, parmenion, seccl, smartsearch, soderberg and transact_remuneration