Here’s a downloadable version of our field guide shown below:
Below is an embedded version of the above excel file
| Field | Front end | Explanation | Example | Type | Notes |
|---|---|---|---|---|---|
| name | Name /Label | Name of the plan | Home Mortgage | String (Text) | |
| value | N/A | The plans current value | 30000 | Integer | In the export this shows the latest value of the plan but can be used on the import to overide the current value of the plan or provide a value when importing for the first time. |
| abstract_type | N/A | Ignore | Ignore | ||
| type | Choose a type | Top Level Plan Type | protection_policy | Selection | See Variable tab for options |
| plan_type | Choose a plan type | Sub Plan Type | Term Protection | Selection | This field is free text and can be set as anything for a list of suggested options (that match the options in Plannr) please see the variables tab |
| created_at | N/A | Ignore | Ignore | ||
| updated_at | N/A | Ignore | Ignore | ||
| uuid | N/A | The plans unique Identifier in Plannr | 4308c6fe-513d-4334-a7ec-9cc0e082d5e4 | String (Text) | If you are importing new plans for the first time you must leave this field blank. If you are updating plans that already exist in the system then the system needs this field to identify the plan you are updating. |
| client_uuid | N/A | The plan owners unique identifier in plannr | 4308c6fe-513d-4334-a7ec-9cc0e082d5e4 | String (Text) | This is the plans owner's uuid all plans must have an owner uuid to be imported into the Plannr. This can be the uuid of a single or a joint client or an entity |
| client_name | N/A | Ignore | Ignore | ||
| client_first_name | N/A | Ignore | Ignore | ||
| client_last_name | N/A | Ignore | Ignore | ||
| provider | Provider | Plan Provider | Legal & General | Selection | Optional |
| status | Plan Status | Current Status of the Plan | Active | Selection | |
| opened_at | Opened At | When the Plan Was opened | 28/06/1999 | Date/Time | |
| inactive_at | Inactive Date | The Date the plan became inactive | 19/06/2000 | Date/Time | |
| inactive_reason | Choose an inactive reason | The Reson why the plan has become inactive | Expired | Selection | See Variable tab for options |
| provider_uuid | N/A | The providers unique identifier in Plannr | 4308c6fe-513d-4334-a7ec-9cc0e082d5e4 | String (Text) | This can be used instead of the provider field |
| policy_number | Policy Number | The plans policy number | 6684610684 | String (Text) | Optional |
| cash_account_term | Term | The term for a cash account | 25 | String (Text) | |
| cash_account_interest_type | Interest Type | The interest type for a cash account | Fixed | Selection | |
| cash_account_interest_rate | Interest Date | The interest rate for a cash account as a percentage | 12 | Number | |
| cash_account_maturity_date | Maturity Date | The maturity date of a cash account | 25/12/2025 | Date/Time | |
| protection_policy_term | Term | The term for a protection policy | 15 | Text | |
| protection_policy_premium | Premium | The premium for a protection | 15.99 | Number | |
| protection_policy_benefit_amount | Benefit Amount | The benefit amount for a protection policy | 50000 | Number | |
| protection_policy_benefit_frequency | Benefit Frequency | The benefit frequency for a protection policy | one_off_payment | Selection | |
| protection_policy_is_trust | Is it in trust | Whether a protection policy is in trust | Yes | Boolean (yes/no) | |
| protection_policy_trustee_details | Trustee Details | Details of the protection policies trustees | Mr Smith's son Jonathan | String (Text) | |
| pension_accrual_rate | Accrual Rate | The Pensions Accrual Rate as a percentage | 2 | Number | |
| pension_year_accrued | Year Accrued | The year the pension accrued | 2015 | String (Text) | |
| pension_retirement_date | Retirement Date | The expected retirement date of the plan holder according to this plan | 2042 | Date/Time | |
| pension_pensionable_earnings | Pensionable Earnings | The pensionable earnings for the plan | 50000 | Number | |
| pension_transfer_value | Transfer Value | The expected transfer value of the pension | 25000 | Number | |
| pension_date_of_transfer_valuation | Date Of Transfer Valuation | The date at which the transfer value was calculated | 12/10/2022 | Date/Time | |
| ????? | Gross Contribution Amount or Percentage? | Whether the gross contribution amount being inputted is an amount of a percentage. | |||
| pension_gross_contribution_amount | Gross Contribution Amount | The gross amount that has been contributed to the pension | 50000 | Number | |
| pension_gross_contribution_percentage | Gross Contribution Percentage | The percentage of the gross pension contributions | 5 | Number | |
| pension_widows_percentage | Widows Percentage | The percentage of the pensions assigned to the widow | 50 | Number | |
| pension_contracted_out | Contracted Out | Whether the pension has been contracted out or not | Yes | Boolean (yes/no) | |
| pension_had_avc | Had AVC | Whether the pension had AVC | No | Boolean (yes/no) | |
| pension_in_house_avc_amount | In House AVC Amount | If the pension had AVC then what is the in house AVC amount? | 152223 | Number | |
| pension_in_house_avc_percentage | In House AVC Percentage | If the pension had AVC then what is the in house AVC percentage? | 16 | Number | |
| pension_death_benefit_amount | Death Benefit Amount | What is the benefit payable upon death from the pension | 15000 | Number | |
| pension_projected_income | Projected Pension Income | The projected income from the pension | |||
| mortgage_repayment_type | Repayment Type | The repayment type for the mortgage | interest_only | Selection | |
| mortgage_term | Remaining Term | The term remaining on the mortgage | 10 | String (Text) | |
| mortgage_payment_amount | Payment Amount | The amount of the regular mortgage payments | 543.98 | Number | |
| mortgage_payment_frequency | Payment Frequency | How often the mortgage payments are due | yearly | Selection | |
| mortgage_initial_interest | Initial Period Interest Rate | The interest for the initial mortgage period as a percentage | 5 | Number | |
| mortgage_initial_period_end | Initial Period End | When does the initial period end | 25/05/2023 | Date/Time | |
| mortgage_interest_rate | Interest Rate | The standard interest rate for the mortgage after the initial period has ended as a percentage. | 7 | Number | |
| equity_release_value_released | Amount released | The value of the equity released from an equity release plan. | 10000 | Number | |
| loan_credit_interest_rate | Interest Rate | The interest rate for the loan as a percentage | 12 | Number | |
| loan_credit_loan_amount | Loan Amount | The amount that the loan is for | 5000 | Number | |
| loan_credit_repayment_amount | Repayment Amount | The amount of the regular loan payments | 300 | Number | |
| loan_credit_repayment_frequency | Repayment Frequency | how often the loan payments are due | monthly | Selection | |
| loan_credit_details | Details | Any additional details about the loan/credit | Audi A7 Bank Loan | String (Text) |
| Field | Options |
|---|---|
| type | cash_account |
| investment | |
| protection_policy | |
| pension | |
| annuity | |
| general_insurance | |
| group_protection | |
| mortgage | |
| equity_release | |
| loan_credit | |
| fixed_asset | |
| status | Active |
| Proposed | |
| Inactive | |
| plan_type | Cash Account |
| 'Cash Account', | |
| 'Cash Deposit', | |
| 'ISA (Cash)', | |
| 'ISA (Mini Cash)', | |
| 'ISA (TESSA Only)', | |
| 'Junior ISA (Cash)', | |
| '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)', | |
| 'Peer to Peer Loan', | |
| 'Savings Account' | |
| investment | |
| '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 (Requlated)', | |
| '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 Trust', | |
| 'ISA (AIM)', | |
| 'ISA (Help to Buy)', | |
| 'ISA (Maxi)', | |
| 'ISA (Maxi/Mini Transfer)', | |
| 'ISA (Mini Equity)', | |
| 'ISA (NISA)', | |
| 'ISA (Stocks And Shares)', | |
| 'Junior ISA (NISA)', | |
| 'Junior ISA (Stocks And Shares)', | |
| 'Lifetime ISA (Stocks And Shares)', | |
| 'Non-Discretionary Managed Service', | |
| 'OEIC / Unit Trust', | |
| 'Offshore Bond', | |
| 'Offshore Deposit', | |
| 'Offshore OIEC / Fund', | |
| 'Offshore Savings Plan', | |
| 'Onshore Bond', | |
| 'Personal Equity Plan', | |
| 'Property Holdings', | |
| 'Property Partnership', | |
| 'Property Syndicate', | |
| 'Residential Property Development', | |
| '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', | |
| 'Unregulated Collective Investments', | |
| 'Venture Capital Trust (Non-Regulated)', | |
| 'Venture Capital Trust (Regulated)', | |
| 'Wrap', | |
| Protection Policy | |
| 'Accident and Sickness Insurance', | |
| 'Accident, Sickness and Unemployment Insurance', | |
| 'Accidental Death Insurance', | |
| 'Capital Redemption Policy', | |
| 'Death In Service', | |
| 'General Insurance (Income Protection)', | |
| 'Gift Inter Vivos', | |
| 'Health Assessment', | |
| 'Income Protection', | |
| 'Income Protection (Executive)', | |
| 'Income Protection (Key person)', | |
| 'Life Settlement Fund', | |
| 'Multi-benefit Protection', | |
| 'Pension Contribution Insurance', | |
| 'Pension Term Assurance', | |
| 'Pre-paid Funeral Plan', | |
| 'Redundancy Insurance', | |
| 'Relevant Life Policy', | |
| '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 - Life & CI)', | |
| 'Term Protection (Mortgage Protection)', | |
| 'Term Protection (Partnership Protection)', | |
| 'Term Protection (Renewable)', | |
| 'Unemployment Insurance', | |
| 'Whole of Life', | |
| 'Whole of Life (Non Investment)', | |
| 'Will', | |
| Pension | |
| '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', | |
| '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)', | |
| 'Individual Retirement Account', | |
| 'Master Trust Pension', | |
| 'Money Purchase Contracted', | |
| 'Offshore Pension', | |
| 'Pension Fund Withdrawal', | |
| 'Personal Pension Plan', | |
| 'Phased Retirement', | |
| 'PIA (Non Protected Rights)', | |
| 'PIA (Protected Rights)', | |
| 'QNUPS', | |
| 'QROPS', | |
| 's226 RAC', | |
| 's32 Buyout Bond', | |
| 'SIPP', | |
| 'SSAS', | |
| 'Stakeholder Individual', | |
| 'Third Way Pensions', | |
| 'Trustee Investment Plan', | |
| 'Unsecured Pension', | |
| 'UURBS', | |
| 'Workplace Pension Scheme', | |
| Annuity | |
| 'Annuity (Non Pension)', | |
| 'Deferred Annuity', | |
| 'Enhanced Pension Annuity', | |
| 'Fixed Term Annuity', | |
| 'Hancock Annuity', | |
| 'IVPP', | |
| 'Impaired Life Annuity', | |
| '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', | |
| 'Defined Benefit Trustee Buy In', | |
| 'Final Salary Scheme', | |
| 'Group Final Salary' | |
| General Insurance | |
| 'Dental Insurance', | |
| 'General 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 (Payment Protection)', | |
| 'General Insurance (Private Motor)', | |
| 'General Insurance (Professional Indemnity)', | |
| 'General Insurance (Travel)', | |
| 'Group Travel Insurance', | |
| 'Healthcare Cash Plan', | |
| 'Locum Insurance', | |
| 'Long Term Care', | |
| 'Long Term Care (Immediate)', | |
| 'Long Term Care (Pre-funded)', | |
| 'Private Medical Insurance', | |
| Group Protection | |
| '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 Life (Excepted)', | |
| 'Group Life (Registered)', | |
| 'Group PMI', | |
| 'Group Term', | |
| Mortgage | |
| 'Mortgage', | |
| 'Mortgage (Bridging Loan)', | |
| '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 (Let to Buy)', | |
| 'Mortgage Lifetime', | |
| 'Mortgage Non Status', | |
| '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' | |
| Loan Credit | |
| 'Bridging Loan', | |
| 'Commercial Finance', | |
| 'Credit Card', | |
| 'Personal Loan', | |
| 'Personal Loan (Secured)', | |
| 'Personal Loan (Unsecured)' | |
| Equity Release | |
| 'Equity Release', | |
| Fixed Asset | |
| 'Boat', | |
| 'Collectible / Art / Other', | |
| 'Motor Vehicle', | |
| 'Own Business', | |
| 'Other', | |
| 'Property', | |
| 'Property (BTL)', | |
| 'Property (Investment)', | |
| 'Property (Rental)', | |
| 'Property (Other)', | |
| 'Property (Overseas)', | |
| 'Land’ | |
| inactive_reason | agency_transferred |
| cancelled | |
| claimed | |
| complete | |
| death_event | |
| deferred | |
| discontinued | |
| drawdown | |
| expired | |
| full_drawdown | |
| issued | |
| lapsed | |
| live | |
| matured | |
| not_proceeded_with | |
| not_taken_up | |
| offered | |
| open_market_option | |
| paid_up | |
| partial_drawdown | |
| partial_surrender | |
| proposed | |
| prospect | |
| refunded | |
| refused | |
| reregistered | |
| retired | |
| scheme_pension | |
| servicing | |
| started | |
| surrendered | |
| suspended | |
| transfer | |
| transferred | |
| underwriting | |
| vested | |
| other | |
| cash_account_interest_type | fixed |
| variable | |
| combined | |
| protection_policy_benefit_frequency | one_off_payment |
| daily | |
| weekly | |
| fortnightly | |
| monthly | |
| quarterly | |
| biannually | |
| yearly | |
| mortgage_repayment_type | interest_only |
| repayment | |
| mortgage_payment_frequency | weekly |
| fortnightly | |
| monthly | |
| quarterly | |
| biannually | |
| yearly | |
| loan_credit_repayment_frequency | weekly |
| fortnightly | |
| monthly | |
| quarterly | |
| biannually | |
| yearly |