Body
-
Descriptive name of the plan
-
[DEPRECATED] Please use accounts instead. Account uuid linked with the plan
-
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 of plan.
Value Description annuity Annuity cash_account Cash Account fixed_asset Fixed Asset general_insurance General Insurance group_protection Group Protection investment Investment loan_credit Loan Credit mortgage Mortgage pension Pension protection_policy Protection Policy Values are
annuity,cash_account,fixed_asset,general_insurance,group_protection,investment,loan_credit,mortgage,pension, orprotection_policy. -
Plan sub type
Value Description cash_account Cash Account cash_deposit Cash Deposit isa_mini_cash ISA (Mini Cash) isa_tessa_only ISA (TESSA Only) lifetime_isa_cash Lifetime ISA (Cash) national_savings National Savings national_savings_child_bonus_bond National Savings (Child Bonus Bond) national_savings_fixed_interest_certificate National Savings (Fixed Interest Certificate) national_savings_guaranteed_equity_bond National Savings (Guaranteed Equity Bond) national_savings_income_bond National Savings (Income Bond) national_savings_index_linked_certificate National Savings (Index Linked Certificate) national_savings_national_savings_certificate National Savings (National Savings Certificate) national_savings_premium_bonds National Savings (Premium Bonds) cash_account_unknown Unknown aim_investment_tax_service AIM Investment Tax Service bes BES business_premises_renovation_allowance Business Premises Renovation Allowance child_trust_fund Child Trust Fund collective_investment_account Collective Investment Account commercial_property_purchase_scheme Commercial Property Purchase Scheme debenture Debenture discretionary_managed_service Discretionary Managed Service employee_benefit_trust Employee Benefit Trust enterprise_investment_scheme_non_regulated Enterprise Investment Scheme (Non-Regulated) enterprise_investment_scheme_regulated Enterprise Investment Scheme (Regulated) enterprise_investment_zone_trust Enterprise Investment Zone Trust enterprise_zone_syndicate Enterprise Zone Syndicate equity_holdings Equity Holdings exchange_traded_fund Exchange Traded Fund exempt_property_unit_trust Exempt Property Unit Trust film_partnership Film Partnership geared_investments Geared Investments general_investment_account General Investment Account hedge_fund Hedge Fund investment_bond Investment Bond investment_tax_service Investment Tax Service investment_trust Investment Trust isa_aim ISA (AIM) isa_cash ISA (Cash) isa_help_to_buy ISA (Help To Buy) isa_maxi ISA (Maxi) isa_maxi_mini_transfer ISA (Maxi/Mini Transfer) isa_mini_equity ISA (Mini Equity) isa_nisa ISA (Nisa) isa_stocks_and_shares ISA (Stocks And Shares) junior_isa_cash Junior ISA (Cash) junior_isa_nisa Junior ISA (Nisa) junior_isa_stocks_and_shares Junior ISA (Stocks And Shares) lifetime_isa_stocks_and_shares Lifetime ISA (Stocks And Shares) maximum_investment_plan_investment Maximum Investment Plan non_discretionary_managed_service Non Discretionary Managed Service oeic_unit_trust Oeic/Unit Trust offshore_bond Offshore Bond offshore_deposit Offshore Deposit offshore_oeic_fund Offshore Oeic/Fund offshore_savings_plan Offshore Savings Plan onshore_bond Onshore Bond personal_equity_plan Personal Equity Plan property_holdings Property Holdings property_partnership Property Partnership property_syndicate Property Syndicate residential_property_development Residential Property Development savings_account Savings Account seed_enterprise_investment_scheme_non_regulated Seed Enterprise Investment Scheme (Non-Regulated) seed_enterprise_investment_scheme_regulated Seed Enterprise Investment Scheme (Regulated) share_incentive_plan Share Incentive Plan share_save_scheme Share Save Scheme sicav SICAV structured_plan Structured Plan structured_plan_cash_isa Structured Plan (Cash ISA) structured_plan_deposit Structured Plan (Deposit) structured_plan_medium_term_note Structured Plan (Medium Term Note) structured_plan_stocks_shares_isa Structured Plan (Stocks & Shares ISA) tessa TESSA trust Trust unit_trust Unit Trust unregulated_collective_investments Unregulated Collective Investments venture_capital_trust_non_regulated Venture Capital Trust (Non-Regulated) venture_capital_trust_regulated Venture Capital Trust (Regulated) wrap Wrap investment_unknown Unknown accident_and_sickness_insurance Accident And Sickness Insurance accident_sickness_and_unemployment_insurance Accident Sickness And Unemployment Insurance accidental_death_insurance Accidental Death Insurance business_loan_protection Business Loan Protection capital_redemption_policy Capital Redemption Policy death_in_service Death In Service endowment Endowment flexible_plan Flexible Plan general_insurance_income_protection General Insurance (Income Protection) gift_inter_vivos Gift Inter Vivos health_assessment Health Assessment income_protection Income Protection income_protection_executive Income Protection (Executive) income_protection_key_person Income Protection (Key Person) life_settlement_fund Life Settlement Fund maximum_investment_plan Maximum Investment Plan multi_benefit_protection Multi Benefit Protection pension_contribution_insurance Pension Contribution Insurance pension_term_assurance Pension Term Assurance pre_paid_funeral_plan Pre-Paid Funeral Plan redundancy_insurance Redundancy Insurance relevant_life_policy Relevant Life Policy renewable_convertible_term Renewable Convertible Term term_protection Term Protection term_protection_convertible Term Protection (Convertible) term_protection_critical_illness Term Protection (Critical Illness) term_protection_decreasing_term Term Protection (Decreasing Term) term_protection_decreasing_term_ci Term Protection (Decreasing Term - CI) term_protection_decreasing_term_life_ci Term Protection (Decreasing Term - Life & CI) term_protection_directors_share_protection Term Protection (Directors Share Protection) term_protection_family_income_protection Term Protection (Family Income Protection) term_protection_family_income_protection_ci Term Protection (Family Income Protection - CI) term_protection_family_income_protection_life_ci Term Protection (Family Income Protection - Life & CI) term_protection_increasing_term Term Protection (Increasing Term) term_protection_key_person_assurance Term Protection (Key Person Assurance) term_protection_level Term Protection (Level) term_protection_level_ci Term Protection (Level - CI) term_protection_level_life_ci Term Protection (Level - Life & CI) term_protection_mortgage_protection Term Protection (Mortgage Protection) term_protection_partnership_protection Term Protection (Partnership Protection) term_protection_renewable Term Protection (Renewable) unemployment_insurance Unemployment Insurance whole_of_life Whole Of Life whole_of_life_non_investment Whole Of Life (Non Investment) will Will protection_policy_unknown Unknown alternatively_secured_pension_plan Alternatively Secured Pension Plan appropriate_personal_pension Appropriate Personal Pension avc AVC cimp CIMP cimp_comp CIMP & COMP comp COMP deferred_sipp Deferred SIPP defined_benefit_pension Defined Benefit Pension dependants_pension Dependants Pension efrbs EFRBS equivalent_pension_benefits Equivalent Pension Benefits executive_pension_plan Executive Pension Plan family_sipp Family SIPP final_salary_scheme Final Salary Scheme fsavc FSAVC furbs FURBS group_cimp Group CIMP group_comp Group COMP group_dependants_pension Group Dependants Pension group_offshore_pension_scheme Group Offshore Pension Scheme group_personal_pension Group Personal Pension group_s32_buyout_bond Group S32 Buyout Bond group_sipp Group SIPP group_stakeholder_pension Group Stakeholder Pension income_drawdown_beneficiary Income Drawdown (Beneficiary) income_drawdown_capped Income Drawdown (Capped) income_drawdown_flexi_access Income Drawdown (Flexi-Access) income_drawdown_flexible Income Drawdown (Flexible) independent_retirement_advice Independent Retirement Advice (IRA) individual_retirement_account Individual Retirement Account inherited_independent_retirement_advice Inherited Independent Retirement Advice (Inherited IRA) junior_personal_pension_plan Junior SIPP master_trust_pension Master Trust Pension money_purchase_contracted Money Purchase Contracted national_employers_savings_trust National Employers Savings Trust (NEST) offshore_pension Offshore Pension pension_fund_withdrawal Pension Fund Withdrawal personal_pension_plan Personal Pension Plan phased_retirement Phased Retirement pia_non_protected_rights PIA (Non Protected Rights) qnups QNUPs qnups_wrapper QNUPs Wrapper qrops QROPs qrops_wrapper QROPs Wrapper rnups_wrapper RNUPs Wrapper roth_inherited_independent_retirement_advice Roth Inherited Independent Retirement Advice (Roth IRA) s226_rac S226 RAC s32_buyout_bond S32 Buyout Bond sipp SIPP sipp_wrapper SIPP Wrapper ssas Ssas stakeholder_individual Stakeholder Individual third_way_pensions Third Way Pensions trustee_investment_plan Trustee Investment Plan unsecured_pension Unsecured Pension uurbs UURBs workplace_pension_scheme Workplace Pension Scheme pension_unknown Unknown annuity_non_pension Annuity (Non Pension) compulsory_purchase_life_annuity Compulsory Purchase Life Annuity deferred_annuity Deferred Annuity defined_benefit_trustee_buy_in Defined Benefit Trustee Buy In enhanced_pension_annuity Enhanced Pension Annuity fixed_term_annuity Fixed Term Annuity group_final_salary Group Final Salary hancock_annuity Hancock Annuity impaired_life_annuity Impaired Life Annuity ivpp IVPP lifetime_annuity Lifetime Annuity pension_annuity Pension Annuity pension_annuity_conventional Pension Annuity (Conventional) pension_annuity_flexible Pension Annuity (Flexible) pension_annuity_impaired_life Pension Annuity (Impaired Life) pension_annuity_temporary Pension Annuity (Temporary) pension_annuity_unit_linked Pension Annuity (Unit Linked) pension_annuity_with_profits Pension Annuity (With Profits) purchased_life_annuity Purchased Life Annuity scheme_pension Scheme Pension annuity_unknown Unknown dental_insurance Dental Insurance general_insurance_building General Insurance (Building) general_insurance_building_contents General Insurance (Building & Contents) general_insurance_commercial_combined General Insurance (Commercial Combined) general_insurance_commercial_motor General Insurance (Commercial Motor) general_insurance_contents General Insurance (Contents) general_insurance_directors_and_officers General Insurance (Directors And Officers) general_insurance_extended_warranty General Insurance (Extended Warranty) general_insurance_legal_expenses General Insurance (Legal Expenses) general_insurance_let_property General Insurance (Let Property) general_insurance_liability General Insurance (Liability) general_insurance_other General Insurance Other general_insurance_payment_protection General Insurance (Payment Protection) general_insurance_private_motor General Insurance (Private Motor) general_insurance_professional_indemnity General Insurance (Professional Indemnity) general_insurance_travel General Insurance (Travel) group_travel_insurance Group Travel Insurance healthcare_cash_plan Healthcare Cash Plan international_private_medical_insurance International Private Medical Insurance (IPMI) locum_insurance Locum Insurance long_term_care Long Term Care long_term_care_immediate Long Term Care (Immediate) long_term_care_pre_funded Long Term Care (Pre-Funded) private_medical_insurance Private Medical Insurance general_insurance_unknown Unknown cpb CPB employee_assistance_scheme Employee Assistance Scheme flexible_benefits Flexible Benefits group_accident_and_sickness Group Accident And Sickness group_critical_illness Group Critical Illness group_death_in_service Group Death In Service group_dental_insurance Group Dental Insurance group_healthcare_cash_plan Group Healthcare Cash Plan group_income_protection Group Income Protection group_income_protection_key_person Group Income Protection (Key Person) group_key_person_assurance Group Key Person Assurance group_life Group Life group_life_excepted Group Life (Excepted) group_life_registered Group Life (Registered) group_partnership_protection Group Partnership Protection group_personal_accident Group Personal Accident group_pmi Group PMI group_relevant_life Group Relevant Life group_term Group Term group_protection_unknown Unknown equity_release Equity Release mortgage Mortgage mortgage_bridging_loan Bridging Loan Mortgage mortgage_business_buy_to_let Mortgage Business Buy To Let mortgage_buy_to_let Buy To Let Mortgage mortgage_consumer_buy_to_let Consumer Buy To Let Mortgage mortgage_council_tenant_to_buy Council/Tenant To Buy Mortgage mortgage_foreign_currency Foreign Currency Mortgage mortgage_full_status Mortgage Full Status mortgage_further_advance Further Advance Mortgage mortgage_government_home_ownership_scheme Government Home Ownership Scheme Mortgage mortgage_home_purchase_plan Home Purchase Plan Mortgage mortgage_investment_property_islamic Investment Property Islamic Mortgage mortgage_let_to_buy Let To Buy Mortgage mortgage_lifetime Mortgage Lifetime mortgage_non_status Mortgage Non Status mortgage_primary_residence_islamic Primary Residence Islamic Mortgage mortgage_product_transfer Product Transfer Mortgage mortgage_remortgage Remortgage Mortgage mortgage_right_to_buy Right To Buy Mortgage mortgage_second_charge Second Charge Mortgage mortgage_second_home Second Home Mortgage mortgage_self_build Self-Build Mortgage mortgage_self_cert Mortgage Self Cert mortgage_shared_ownership Shared Ownership Mortgage mortgage_standard_residential Standard Residential Mortgage mortgage_non_regulated_bridging_loan Non-Regulated Bridging Loan Mortgage mortgage_non_regulated_buy_to_let Non-Regulated Buy To Let Mortgage mortgage_non_regulated_commercial Non-Regulated Commercial Mortgage mortgage_non_regulated_further_advance Non-Regulated Further Advance Mortgage mortgage_non_regulated_offshore Non-Regulated Offshore Mortgage mortgage_non_regulated_overseas Non-Regulated Overseas Mortgage mortgage_non_regulated_product_transfer Non-Regulated Product Transfer Mortgage third_party_mortgage Third Party Mortgage mortgage_unknown Unknown bridging_loan Bridging Loan car_finance Car Finance commercial_finance Commercial Finance consumer_finance Consumer Finance credit_card Credit Card landlords Landlords other_long_term_loan Other Long Term Loan overdraft Overdraft partner_loan Partner Loan peer_to_peer_loan Peer To Peer Loan personal_loan Personal Loan personal_loan_secured Personal Loan (Secured) personal_loan_unsecured Personal Loan (Unsecured) public_liability Public Liability student_loan Student Loan will_trust_loan Will Trust Loan loan_credit_unknown Unknown boat Boat collectible_art_other Collectible/Art/Other land Land motor_vehicle Motor Vehicle other Other own_business Own Business property Property property_btl Property (Btl) property_investment Property (Investment) property_rental Property (Rental) property_other Property (Other) property_overseas Property (Overseas) fixed_asset_unknown Unknown Values are
cash_account,cash_deposit,isa_mini_cash,isa_tessa_only,lifetime_isa_cash,national_savings,national_savings_child_bonus_bond,national_savings_fixed_interest_certificate,national_savings_guaranteed_equity_bond,national_savings_income_bond,national_savings_index_linked_certificate,national_savings_national_savings_certificate,national_savings_premium_bonds,cash_account_unknown,aim_investment_tax_service,bes,business_premises_renovation_allowance,child_trust_fund,collective_investment_account,commercial_property_purchase_scheme,debenture,discretionary_managed_service,employee_benefit_trust,enterprise_investment_scheme_non_regulated,enterprise_investment_scheme_regulated,enterprise_investment_zone_trust,enterprise_zone_syndicate,equity_holdings,exchange_traded_fund,exempt_property_unit_trust,film_partnership,geared_investments,general_investment_account,hedge_fund,investment_bond,investment_tax_service,investment_trust,isa_aim,isa_cash,isa_help_to_buy,isa_maxi,isa_maxi_mini_transfer,isa_mini_equity,isa_nisa,isa_stocks_and_shares,junior_isa_cash,junior_isa_nisa,junior_isa_stocks_and_shares,lifetime_isa_stocks_and_shares,maximum_investment_plan_investment,non_discretionary_managed_service,oeic_unit_trust,offshore_bond,offshore_deposit,offshore_oeic_fund,offshore_savings_plan,onshore_bond,personal_equity_plan,property_holdings,property_partnership,property_syndicate,residential_property_development,savings_account,seed_enterprise_investment_scheme_non_regulated,seed_enterprise_investment_scheme_regulated,share_incentive_plan,share_save_scheme,sicav,structured_plan,structured_plan_cash_isa,structured_plan_deposit,structured_plan_medium_term_note,structured_plan_stocks_shares_isa,tessa,trust,unit_trust,unregulated_collective_investments,venture_capital_trust_non_regulated,venture_capital_trust_regulated,wrap,investment_unknown,accident_and_sickness_insurance,accident_sickness_and_unemployment_insurance,accidental_death_insurance,business_loan_protection,capital_redemption_policy,death_in_service,endowment,flexible_plan,general_insurance_income_protection,gift_inter_vivos,health_assessment,income_protection,income_protection_executive,income_protection_key_person,life_settlement_fund,maximum_investment_plan,multi_benefit_protection,pension_contribution_insurance,pension_term_assurance,pre_paid_funeral_plan,redundancy_insurance,relevant_life_policy,renewable_convertible_term,term_protection,term_protection_convertible,term_protection_critical_illness,term_protection_decreasing_term,term_protection_decreasing_term_ci,term_protection_decreasing_term_life_ci,term_protection_directors_share_protection,term_protection_family_income_protection,term_protection_family_income_protection_ci,term_protection_family_income_protection_life_ci,term_protection_increasing_term,term_protection_key_person_assurance,term_protection_level,term_protection_level_ci,term_protection_level_life_ci,term_protection_mortgage_protection,term_protection_partnership_protection,term_protection_renewable,unemployment_insurance,whole_of_life,whole_of_life_non_investment,will,protection_policy_unknown,alternatively_secured_pension_plan,appropriate_personal_pension,avc,cimp,cimp_comp,comp,deferred_sipp,defined_benefit_pension,dependants_pension,efrbs,equivalent_pension_benefits,executive_pension_plan,family_sipp,final_salary_scheme,fsavc,furbs,group_cimp,group_comp,group_dependants_pension,group_offshore_pension_scheme,group_personal_pension,group_s32_buyout_bond,group_sipp,group_stakeholder_pension,income_drawdown_beneficiary,income_drawdown_capped,income_drawdown_flexi_access,income_drawdown_flexible,independent_retirement_advice,individual_retirement_account,inherited_independent_retirement_advice,junior_personal_pension_plan,master_trust_pension,money_purchase_contracted,national_employers_savings_trust,offshore_pension,pension_fund_withdrawal,personal_pension_plan,phased_retirement,pia_non_protected_rights,qnups,qnups_wrapper,qrops,qrops_wrapper,rnups_wrapper,roth_inherited_independent_retirement_advice,s226_rac,s32_buyout_bond,sipp,sipp_wrapper,ssas,stakeholder_individual,third_way_pensions,trustee_investment_plan,unsecured_pension,uurbs,workplace_pension_scheme,pension_unknown,annuity_non_pension,compulsory_purchase_life_annuity,deferred_annuity,defined_benefit_trustee_buy_in,enhanced_pension_annuity,fixed_term_annuity,group_final_salary,hancock_annuity,impaired_life_annuity,ivpp,lifetime_annuity,pension_annuity,pension_annuity_conventional,pension_annuity_flexible,pension_annuity_impaired_life,pension_annuity_temporary,pension_annuity_unit_linked,pension_annuity_with_profits,purchased_life_annuity,scheme_pension,annuity_unknown,dental_insurance,general_insurance_building,general_insurance_building_contents,general_insurance_commercial_combined,general_insurance_commercial_motor,general_insurance_contents,general_insurance_directors_and_officers,general_insurance_extended_warranty,general_insurance_legal_expenses,general_insurance_let_property,general_insurance_liability,general_insurance_other,general_insurance_payment_protection,general_insurance_private_motor,general_insurance_professional_indemnity,general_insurance_travel,group_travel_insurance,healthcare_cash_plan,international_private_medical_insurance,locum_insurance,long_term_care,long_term_care_immediate,long_term_care_pre_funded,private_medical_insurance,general_insurance_unknown,cpb,employee_assistance_scheme,flexible_benefits,group_accident_and_sickness,group_critical_illness,group_death_in_service,group_dental_insurance,group_healthcare_cash_plan,group_income_protection,group_income_protection_key_person,group_key_person_assurance,group_life,group_life_excepted,group_life_registered,group_partnership_protection,group_personal_accident,group_pmi,group_relevant_life,group_term,group_protection_unknown,equity_release,mortgage,mortgage_bridging_loan,mortgage_business_buy_to_let,mortgage_buy_to_let,mortgage_consumer_buy_to_let,mortgage_council_tenant_to_buy,mortgage_foreign_currency,mortgage_full_status,mortgage_further_advance,mortgage_government_home_ownership_scheme,mortgage_home_purchase_plan,mortgage_investment_property_islamic,mortgage_let_to_buy,mortgage_lifetime,mortgage_non_status,mortgage_primary_residence_islamic,mortgage_product_transfer,mortgage_remortgage,mortgage_right_to_buy,mortgage_second_charge,mortgage_second_home,mortgage_self_build,mortgage_self_cert,mortgage_shared_ownership,mortgage_standard_residential,mortgage_non_regulated_bridging_loan,mortgage_non_regulated_buy_to_let,mortgage_non_regulated_commercial,mortgage_non_regulated_further_advance,mortgage_non_regulated_offshore,mortgage_non_regulated_overseas,mortgage_non_regulated_product_transfer,third_party_mortgage,mortgage_unknown,bridging_loan,car_finance,commercial_finance,consumer_finance,credit_card,landlords,other_long_term_loan,overdraft,partner_loan,peer_to_peer_loan,personal_loan,personal_loan_secured,personal_loan_unsecured,public_liability,student_loan,will_trust_loan,loan_credit_unknown,boat,collectible_art_other,land,motor_vehicle,other,own_business,property,property_btl,property_investment,property_rental,property_other,property_overseas, orfixed_asset_unknown. -
uuid of the provider
-
Main policy number for the plan, will be stored as the main accounts policy number
-
Main proposal reference for the plan, will be stored as the main accounts proposal reference
-
date when the plan was purchased or account was opened
-
Status of plan.
Value Description active Active inactive Inactive proposed Proposed Values are
active,inactive, orproposed. -
Date when plan went inactive
-
Reason for inactivity.
Value Description accepted Accepted agency_transferred Agency Transferred cancelled Cancelled claimed Claimed complete Complete death_event Death Event deferred Deferred drawdown Drawdown expired Expired full_drawdown Full Drawdown issued Issued lapsed Lapsed matured Matured not_proceeded_with Not Proceeded With not_taken_up Not Taken Up offered Offered paid_up Paid Up partial_drawdown Partial Drawdown partial_surrender Partial Surrender proposed Proposed prospect Prospect refunded Refunded refused Refused surrendered Surrendered transfer Transfer transferred Transferred underwriting Underwriting vested Vested declined Declined encashment Encashment left_service Left Service premium_holiday Premium Holiday other Other Values are
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, orother. -
Agency in your name
-
Date agency was in your name from
-
Whether the plan was originally sold by your firm
-
Under advice
-
Whether this plan will be shown to clients in their client portal. Will default to true if not provided.
-
Include in client valuation. Will default to true if not provided.
-
@Deprecated
-
Determines if plan should be shown on a circle
-
Next review date
-
On panel
-
Employee account that sold this plan
-
Employee account that is managing this plan
-
A plan adviser split to be applied to charges to this plan
-
Array of case uuids
-
Linked clients who should be added as extra owners of the plan.
-
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.
-
The current value of the plan in pennies. Can be provided with
current_value_atto specify the date that the plan was valued at. -
Optional date to be used with
current_value. If left blank it will default to the current day. -
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.
-
Denotes if the plan is a wrap product, and can have plans linked under it. Will default to false if not provided.
-
The UUID of the wrap product to link this plan too
-
The UUID of the account used for contract enquiry.
-
The beneficiaries of the plan.
-
platform_provider field, this is found on types (annuity cash_account investment pension)
-
life_assured field, this is found on types (annuity)
-
sum_assured field, this is found on types (annuity)
-
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 field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)
-
term_age field, this is found on types (annuity cash_account general_insurance investment loan_credit mortgage pension protection_policy)
-
term_maturity_value field, this is found on types (annuity)
-
guaranteed_term field, this is found on types (annuity)
-
payment_type field, this is found on types (annuity)
-
income_amount field, this is found on types (annuity)
-
income_frequency field, this is found on types (annuity)
-
income_from field, this is found on types (annuity)
-
income_escalation field, this is found on types (annuity)
-
initial_purchase_amount field, this is found on types (annuity)
-
interest_type field, this is found on types (cash_account investment loan_credit mortgage)
-
interest_rate field, this is found on types (cash_account investment loan_credit mortgage)
-
address_1 field, this is found on types (fixed_asset)
-
address_2 field, this is found on types (fixed_asset)
-
address_3 field, this is found on types (fixed_asset)
-
address_4 field, this is found on types (fixed_asset)
-
town_city field, this is found on types (fixed_asset)
-
county field, this is found on types (fixed_asset)
-
postcode field, this is found on types (fixed_asset)
-
country field, this is found on types (fixed_asset)
-
new_property field, this is found on types (fixed_asset)
-
price_listed field, this is found on types (fixed_asset)
-
purchase_price field, this is found on types (fixed_asset)
-
asset_description field, this is found on types (fixed_asset)
-
asset_image field, this is found on types (fixed_asset)
-
ncd field, this is found on types (general_insurance)
-
ncd_protected field, this is found on types (general_insurance)
-
ncd_years field, this is found on types (general_insurance)
-
renewal_date field, this is found on types (general_insurance group_protection)
-
offshore field, this is found on types (investment)
-
in_trust field, this is found on types (investment protection_policy)
-
trustee_details field, this is found on types (investment protection_policy)
-
original_balance field, this is found on types (loan_credit mortgage)
-
outstanding_balance field, this is found on types (loan_credit mortgage)
-
loan_amount field, this is found on types (loan_credit)
-
repayment_amount field, this is found on types (loan_credit)
-
repayment_frequency field, this is found on types (loan_credit)
-
details field, this is found on types (loan_credit)
-
property_type field, this is found on types (mortgage)
-
payment_amount field, this is found on types (mortgage)
-
payment_frequency field, this is found on types (mortgage)
-
initial_interest field, this is found on types (mortgage)
-
initial_period_end field, this is found on types (mortgage)
-
initial_payment field, this is found on types (mortgage)
-
equity_released field, this is found on types (mortgage)
-
loan_quote field, this is found on types (mortgage)
-
loan_type field, this is found on types (mortgage)
-
mig_added field, this is found on types (mortgage)
-
repayment_type field, this is found on types (mortgage)
-
repayment_method field, this is found on types (mortgage)
-
repayment_term field, this is found on types (mortgage)
-
other_repayment_method field, this is found on types (mortgage)
-
scheme_fixed_date field, this is found on types (mortgage)
-
transaction_details field, this is found on types (mortgage)
-
base_payment field, this is found on types (mortgage)
-
has_transfer_penalties field, this is found on types (mortgage)
-
is_portable_mortgage field, this is found on types (mortgage)
-
transfer_consent field, this is found on types (mortgage)
-
transfer_penalty field, this is found on types (mortgage)
-
contract_exchanged field, this is found on types (mortgage)
-
date_complete field, this is found on types (mortgage)
-
date_confirmed field, this is found on types (mortgage)
-
date_exchanged field, this is found on types (mortgage)
-
date_submitted field, this is found on types (mortgage)
-
mortgage_completed field, this is found on types (mortgage)
-
offer_confirmed field, this is found on types (mortgage)
-
offer_confirmed_date field, this is found on types (mortgage)
-
offer_date field, this is found on types (mortgage)
-
offer_issued field, this is found on types (mortgage)
-
on_risk field, this is found on types (mortgage)
-
proposal_date field, this is found on types (mortgage)
-
submitted field, this is found on types (mortgage)
-
declined_notes field, this is found on types (mortgage)
-
accrual_rate field, this is found on types (pension)
-
year_accrued field, this is found on types (pension)
-
retirement_date field, this is found on types (pension)
-
pensionable_salary field, this is found on types (pension)
-
transfer_value field, this is found on types (pension)
-
date_of_transfer_valuation field, this is found on types (pension)
-
widows_percentage field, this is found on types (pension)
-
contracted_out field, this is found on types (pension)
-
had_avc field, this is found on types (pension)
-
in_house_avc_amount field, this is found on types (pension)
-
in_house_avc_percentage field, this is found on types (pension)
-
death_benefit_amount field, this is found on types (pension)
-
projected_income field, this is found on types (pension)
-
plan_retirement_age field, this is found on types (pension)
-
state_retirement_age field, this is found on types (pension)
-
salary_sacrifice field, this is found on types (pension)
-
waiver field, this is found on types (pension)
-
is_crystallised field, this is found on types (pension)
-
crystallisation_amount field, this is found on types (pension)
-
crystallisation_benefit field, this is found on types (pension)
-
crystallisation_fund field, this is found on types (pension)
-
crystallisation_start_date field, this is found on types (pension)
-
crystallisation_end_date field, this is found on types (pension)
-
crystallisation_frequency field, this is found on types (pension)
-
fund_amount field, this is found on types (pension)
-
uncrystallised_fund field, this is found on types (pension)
-
income_taken_amount field, this is found on types (pension)
-
maximum_income_amount field, this is found on types (pension)
-
tax_free_amount field, this is found on types (pension)
-
lifetime_allowance_percentage field, this is found on types (pension)
-
lta_applied field, this is found on types (pension)
-
mpaa_trigger field, this is found on types (pension)
-
pcls_percentage field, this is found on types (pension)
-
reason field, this is found on types (pension)
-
has_pre_existing_conditions field, this is found on types (protection_policy)
-
pre_existing_conditions_notes field, this is found on types (protection_policy)
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Johns ISA","client_uuid":"9f1a0e26-bd50-4e7f-8c2b-e25642655972","accounts":[{"account_uuid":"a2d43bbd-969b-403e-b0ae-c2b254bd9124"},{"account_uuid":"b99f9d6e-e16f-4bc2-bc82-fd95b130dac9","ownership_percentage":75.0},{"account_uuid":"6e3fb6a4-66f2-4b89-9b02-690e9c38876d","ownership_percentage":null}],"type":"annuity","sub_type":"cash_account","provider_uuid":"9fd162b4-fc3a-44fd-b0d4-23349d5ecd3a","policy_number":"AVI-43135","proposal_reference":"AB12345","opened_at":"2025-12-20","status":"active","inactive_at":"2025-12-24","inactive_reason":"accepted","agency_in_your_name":true,"agency_in_your_name_from":"2025-09-15","originally_sold_by_firm":true,"under_advice":true,"visible_on_client_portal":true,"include_in_client_valuation":true,"show_on_joint":true,"shown_on_circles":false,"review_date":"2026-12-24","on_panel":true,"seller_uuid":"497e59de-18d6-4d2a-8edd-1bc7cf158176","active_adviser_uuid":"e71cc312-440a-4e3d-b338-860c9174b29a","adviser_split_uuid":"bafe938f-e7cd-4097-947f-268898d7ebea","cases":["c21621e2-03d5-47d5-98f3-73cfd543b830","d826040e-0416-4875-b99c-6b7b8aaeea76","9cf4ced6-cac0-4dc0-8a50-38de6100a47c"],"linked_owners":["2667a587-c654-4232-8809-c70d3c015e56","36139ef0-50f9-4dc7-b461-f46a5a36f7ed","0733df4d-cea7-4ffe-b4d3-0e5040ef575f"],"visible_to_circles_uuids":["6362220d-119e-4e43-9e5c-c5759723f818","35f0fae4-8d19-466c-b80b-f238c30a402b","5834138a-4684-4b8e-a2a6-cb6d1137054f"],"current_value":5000,"current_value_at":"2025-12-24","is_group_scheme":false,"is_wrap_product":false,"wrap_uuid":"1a9eff30-9c67-45c9-9e23-2166adf6a52e","contract_enquiry_account_uuid":"9d5e0439-f26f-45ed-8069-29fed9c58b9b","beneficiaries":[{"name":"John Smith","percentage":20.5},{"name":"Jane Doe","percentage":50.5}],"platform_provider":"(platform_provider)","life_assured":"(life_assured)","sum_assured":"(sum_assured)","term_type":"(term_type)","term_maturity_date":"(term_maturity_date)","term_age":"(term_age)","term_maturity_value":"(term_maturity_value)","guaranteed_term":"(guaranteed_term)","payment_type":"(payment_type)","income_amount":"(income_amount)","income_frequency":"(income_frequency)","income_from":"(income_from)","income_escalation":"(income_escalation)","initial_purchase_amount":"(initial_purchase_amount)","interest_type":"(interest_type)","interest_rate":"(interest_rate)","address_1":"(address_1)","address_2":"(address_2)","address_3":"(address_3)","address_4":"(address_4)","town_city":"(town_city)","county":"(county)","postcode":"(postcode)","country":"(country)","new_property":"(new_property)","price_listed":"(price_listed)","purchase_price":"(purchase_price)","asset_description":"(asset_description)","asset_image":"(asset_image)","ncd":"(ncd)","ncd_protected":"(ncd_protected)","ncd_years":"(ncd_years)","renewal_date":"(renewal_date)","offshore":"(offshore)","in_trust":"(in_trust)","trustee_details":"(trustee_details)","original_balance":"(original_balance)","outstanding_balance":"(outstanding_balance)","loan_amount":"(loan_amount)","repayment_amount":"(repayment_amount)","repayment_frequency":"(repayment_frequency)","details":"(details)","property_type":"(property_type)","payment_amount":"(payment_amount)","payment_frequency":"(payment_frequency)","initial_interest":"(initial_interest)","initial_period_end":"(initial_period_end)","initial_payment":"(initial_payment)","equity_released":"(equity_released)","loan_quote":"(loan_quote)","loan_type":"(loan_type)","mig_added":"(mig_added)","mig_premium":"(mig_premium)","repayment_type":"(repayment_type)","repayment_method":"(repayment_method)","repayment_term":"(repayment_term)","other_repayment_method":"(other_repayment_method)","scheme_fixed_date":"(scheme_fixed_date)","transaction_details":"(transaction_details)","base_payment":"(base_payment)","has_transfer_penalties":"(has_transfer_penalties)","is_portable_mortgage":"(is_portable_mortgage)","transfer_consent":"(transfer_consent)","transfer_penalty":"(transfer_penalty)","contract_exchanged":"(contract_exchanged)","date_complete":"(date_complete)","date_confirmed":"(date_confirmed)","date_exchanged":"(date_exchanged)","date_submitted":"(date_submitted)","mortgage_completed":"(mortgage_completed)","offer_confirmed":"(offer_confirmed)","offer_confirmed_date":"(offer_confirmed_date)","offer_date":"(offer_date)","offer_issued":"(offer_issued)","on_risk":"(on_risk)","proposal_date":"(proposal_date)","submitted":"(submitted)","declined_notes":"(declined_notes)","accrual_rate":"(accrual_rate)","year_accrued":"(year_accrued)","retirement_date":"(retirement_date)","pensionable_salary":"(pensionable_salary)","transfer_value":"(transfer_value)","date_of_transfer_valuation":"(date_of_transfer_valuation)","widows_percentage":"(widows_percentage)","contracted_out":"(contracted_out)","had_avc":"(had_avc)","in_house_avc_amount":"(in_house_avc_amount)","in_house_avc_percentage":"(in_house_avc_percentage)","death_benefit_amount":"(death_benefit_amount)","projected_income":"(projected_income)","plan_retirement_age":"(plan_retirement_age)","state_retirement_age":"(state_retirement_age)","salary_sacrifice":"(salary_sacrifice)","waiver":"(waiver)","is_crystallised":"(is_crystallised)","crystallisation_amount":"(crystallisation_amount)","crystallisation_benefit":"(crystallisation_benefit)","crystallisation_fund":"(crystallisation_fund)","crystallisation_start_date":"(crystallisation_start_date)","crystallisation_end_date":"(crystallisation_end_date)","crystallisation_frequency":"(crystallisation_frequency)","fund_amount":"(fund_amount)","uncrystallised_fund":"(uncrystallised_fund)","income_taken_amount":"(income_taken_amount)","maximum_income_amount":"(maximum_income_amount)","tax_free_amount":"(tax_free_amount)","lifetime_allowance_percentage":"(lifetime_allowance_percentage)","lta_applied":"(lta_applied)","mpaa_trigger":"(mpaa_trigger)","pcls_percentage":"(pcls_percentage)","reason":"(reason)","has_pre_existing_conditions":"(has_pre_existing_conditions)","pre_existing_conditions_notes":"(pre_existing_conditions_notes)","external_reference":{"third_party":"adviser_office","reference":"AB123456"}}'# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Johns ISA",
"client_uuid": "9f1a0e26-bd50-4e7f-8c2b-e25642655972",
"accounts": [
{
"account_uuid": "a2d43bbd-969b-403e-b0ae-c2b254bd9124"
},
{
"account_uuid": "b99f9d6e-e16f-4bc2-bc82-fd95b130dac9",
"ownership_percentage": 75.0
},
{
"account_uuid": "6e3fb6a4-66f2-4b89-9b02-690e9c38876d",
"ownership_percentage": null
}
],
"type": "annuity",
"sub_type": "cash_account",
"provider_uuid": "9fd162b4-fc3a-44fd-b0d4-23349d5ecd3a",
"policy_number": "AVI-43135",
"proposal_reference": "AB12345",
"opened_at": "2025-12-20",
"status": "active",
"inactive_at": "2025-12-24",
"inactive_reason": "accepted",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-09-15",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": false,
"review_date": "2026-12-24",
"on_panel": true,
"seller_uuid": "497e59de-18d6-4d2a-8edd-1bc7cf158176",
"active_adviser_uuid": "e71cc312-440a-4e3d-b338-860c9174b29a",
"adviser_split_uuid": "bafe938f-e7cd-4097-947f-268898d7ebea",
"cases": [
"c21621e2-03d5-47d5-98f3-73cfd543b830",
"d826040e-0416-4875-b99c-6b7b8aaeea76",
"9cf4ced6-cac0-4dc0-8a50-38de6100a47c"
],
"linked_owners": [
"2667a587-c654-4232-8809-c70d3c015e56",
"36139ef0-50f9-4dc7-b461-f46a5a36f7ed",
"0733df4d-cea7-4ffe-b4d3-0e5040ef575f"
],
"visible_to_circles_uuids": [
"6362220d-119e-4e43-9e5c-c5759723f818",
"35f0fae4-8d19-466c-b80b-f238c30a402b",
"5834138a-4684-4b8e-a2a6-cb6d1137054f"
],
"current_value": 5000,
"current_value_at": "2025-12-24",
"is_group_scheme": false,
"is_wrap_product": false,
"wrap_uuid": "1a9eff30-9c67-45c9-9e23-2166adf6a52e",
"contract_enquiry_account_uuid": "9d5e0439-f26f-45ed-8069-29fed9c58b9b",
"beneficiaries": [
{
"name": "John Smith",
"percentage": 20.5
},
{
"name": "Jane Doe",
"percentage": 50.5
}
],
"platform_provider": "(platform_provider)",
"life_assured": "(life_assured)",
"sum_assured": "(sum_assured)",
"term_type": "(term_type)",
"term_maturity_date": "(term_maturity_date)",
"term_age": "(term_age)",
"term_maturity_value": "(term_maturity_value)",
"guaranteed_term": "(guaranteed_term)",
"payment_type": "(payment_type)",
"income_amount": "(income_amount)",
"income_frequency": "(income_frequency)",
"income_from": "(income_from)",
"income_escalation": "(income_escalation)",
"initial_purchase_amount": "(initial_purchase_amount)",
"interest_type": "(interest_type)",
"interest_rate": "(interest_rate)",
"address_1": "(address_1)",
"address_2": "(address_2)",
"address_3": "(address_3)",
"address_4": "(address_4)",
"town_city": "(town_city)",
"county": "(county)",
"postcode": "(postcode)",
"country": "(country)",
"new_property": "(new_property)",
"price_listed": "(price_listed)",
"purchase_price": "(purchase_price)",
"asset_description": "(asset_description)",
"asset_image": "(asset_image)",
"ncd": "(ncd)",
"ncd_protected": "(ncd_protected)",
"ncd_years": "(ncd_years)",
"renewal_date": "(renewal_date)",
"offshore": "(offshore)",
"in_trust": "(in_trust)",
"trustee_details": "(trustee_details)",
"original_balance": "(original_balance)",
"outstanding_balance": "(outstanding_balance)",
"loan_amount": "(loan_amount)",
"repayment_amount": "(repayment_amount)",
"repayment_frequency": "(repayment_frequency)",
"details": "(details)",
"property_type": "(property_type)",
"payment_amount": "(payment_amount)",
"payment_frequency": "(payment_frequency)",
"initial_interest": "(initial_interest)",
"initial_period_end": "(initial_period_end)",
"initial_payment": "(initial_payment)",
"equity_released": "(equity_released)",
"loan_quote": "(loan_quote)",
"loan_type": "(loan_type)",
"mig_added": "(mig_added)",
"mig_premium": "(mig_premium)",
"repayment_type": "(repayment_type)",
"repayment_method": "(repayment_method)",
"repayment_term": "(repayment_term)",
"other_repayment_method": "(other_repayment_method)",
"scheme_fixed_date": "(scheme_fixed_date)",
"transaction_details": "(transaction_details)",
"base_payment": "(base_payment)",
"has_transfer_penalties": "(has_transfer_penalties)",
"is_portable_mortgage": "(is_portable_mortgage)",
"transfer_consent": "(transfer_consent)",
"transfer_penalty": "(transfer_penalty)",
"contract_exchanged": "(contract_exchanged)",
"date_complete": "(date_complete)",
"date_confirmed": "(date_confirmed)",
"date_exchanged": "(date_exchanged)",
"date_submitted": "(date_submitted)",
"mortgage_completed": "(mortgage_completed)",
"offer_confirmed": "(offer_confirmed)",
"offer_confirmed_date": "(offer_confirmed_date)",
"offer_date": "(offer_date)",
"offer_issued": "(offer_issued)",
"on_risk": "(on_risk)",
"proposal_date": "(proposal_date)",
"submitted": "(submitted)",
"declined_notes": "(declined_notes)",
"accrual_rate": "(accrual_rate)",
"year_accrued": "(year_accrued)",
"retirement_date": "(retirement_date)",
"pensionable_salary": "(pensionable_salary)",
"transfer_value": "(transfer_value)",
"date_of_transfer_valuation": "(date_of_transfer_valuation)",
"widows_percentage": "(widows_percentage)",
"contracted_out": "(contracted_out)",
"had_avc": "(had_avc)",
"in_house_avc_amount": "(in_house_avc_amount)",
"in_house_avc_percentage": "(in_house_avc_percentage)",
"death_benefit_amount": "(death_benefit_amount)",
"projected_income": "(projected_income)",
"plan_retirement_age": "(plan_retirement_age)",
"state_retirement_age": "(state_retirement_age)",
"salary_sacrifice": "(salary_sacrifice)",
"waiver": "(waiver)",
"is_crystallised": "(is_crystallised)",
"crystallisation_amount": "(crystallisation_amount)",
"crystallisation_benefit": "(crystallisation_benefit)",
"crystallisation_fund": "(crystallisation_fund)",
"crystallisation_start_date": "(crystallisation_start_date)",
"crystallisation_end_date": "(crystallisation_end_date)",
"crystallisation_frequency": "(crystallisation_frequency)",
"fund_amount": "(fund_amount)",
"uncrystallised_fund": "(uncrystallised_fund)",
"income_taken_amount": "(income_taken_amount)",
"maximum_income_amount": "(maximum_income_amount)",
"tax_free_amount": "(tax_free_amount)",
"lifetime_allowance_percentage": "(lifetime_allowance_percentage)",
"lta_applied": "(lta_applied)",
"mpaa_trigger": "(mpaa_trigger)",
"pcls_percentage": "(pcls_percentage)",
"reason": "(reason)",
"has_pre_existing_conditions": "(has_pre_existing_conditions)",
"pre_existing_conditions_notes": "(pre_existing_conditions_notes)",
"external_reference": {
"third_party": "adviser_office",
"reference": "AB123456"
}
}{
"message": "Unauthenticated."
}