Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• plan_uuid string Required

Responses

• 201 application/json
  Hide response attributes Show response attributes object

  • uuid string
  • created_at string
  • updated_at string
  • plan object
    Hide plan attributes Show plan attributes object

    • uuid string
    • created_at string
    • updated_at string
    • opened_at string
    • name string
    • type string
    • sub_type string
    • abstract_type string
    • policy_number string
    • proposal_reference string
    • status string
    • inactive_at string
    • inactive_reason string
    • agency_in_your_name boolean
    • agency_in_your_name_from string
    • originally_sold_by_firm boolean
    • under_advice boolean
    • visible_on_client_portal boolean
    • include_in_client_valuation boolean
    • show_on_joint boolean
    • shown_on_circles boolean
    • review_date string
    • on_panel boolean
    • is_group_scheme boolean
    • is_sub_group_scheme boolean
    • is_group_scheme_member boolean
    • advice_area string
    • main_account object
      Hide main_account attributes Show main_account attributes object

      • uuid

        UUID of the sub account

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was created.

      • name

        Descriptive name of the sub account

      • policy_number

        Provider reference of the sub account

      • is_main_account

        Denotes if the sub account a main account of the plan

      • statistics

        The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

    • sub_accounts object
      Hide sub_accounts attributes Show sub_accounts attributes object

      • uuid

        UUID of the sub account

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was created.

      • name

        Descriptive name of the sub account

      • policy_number

        Provider reference of the sub account

      • is_main_account

        Denotes if the sub account a main account of the plan

      • statistics

        The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

    • provider object
      Hide provider attributes Show provider attributes object

      • uuid

        UUID of the provider

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Provider name

      • slug

        Provider name slug

    • covers object
      Hide covers attributes Show covers attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • cover_type

        Cover type

      • benefit_amount

        Benefit amount

      • benefit_frequency

        Benefit frequency

      • benefit_status

        Benefit status

      • excess

        Excess

      • indexation

        Indexation percentage

    • claims object
      Hide claims attributes Show claims attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • claim_amount

        Claim amount

      • claim_start_date

        Claim start date

      • claim_end_date

        Claim end date

      • claim_notes

        Claim notes

    • total_benefit_amount object
      Hide total_benefit_amount attributes Show total_benefit_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • total_benefits object
      Hide total_benefits attributes Show total_benefits attributes object

      • critical_illness object
        Hide critical_illness attributes Show critical_illness attributes object

        • amount object
          Hide amount attributes Show amount attributes object

          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object

          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object

          • example string
          • description string
      • family_income_benefit object
        Hide family_income_benefit attributes Show family_income_benefit attributes object

        • amount object
          Hide amount attributes Show amount attributes object

          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object

          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object

          • example string
          • description string
    • latest_valuations object
      Hide latest_valuations attributes Show latest_valuations attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • valued_at

        Valued at

      • value

        Valuation

    • value object
      Hide value attributes Show value attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • valued_at string
    • original_valued_at string
    • client object
      Hide client attributes Show client attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • accounts object
      Hide accounts attributes Show accounts attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • seller object
      Hide seller attributes Show seller attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • linked_owners object
      Hide linked_owners attributes Show linked_owners attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • linked_plans object
      Hide linked_plans attributes Show linked_plans attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • opened_at

        Timestamp of when the plan was originally opened

      • name

        Name of the plan

      • type

        Type of plan, this will indicate what to expect from the fields attribute

      • sub_type

        Plan sub type

      • abstract_type

        describes if the plan is an asset, protection or liability

      • policy_number

        The policy number on the main sub account of the plan

      • proposal_reference

        The proposal reference on the main sub account of the plan

      • status

        Plan status

      • inactive_at

        Timestamp of when the plan became inactive

      • inactive_reason

        Reason for inactivity

      • agency_in_your_name

        Denotes if plan has agency in your name

      • agency_in_your_name_from

        Date the agency was in your name from

      • originally_sold_by_firm

        Denotes if the plan was originally sold by your firm

      • under_advice

        Denotes if plan is under advice

      • visible_on_client_portal

        Denotes if this plan is visible to clients on the client portal

      • include_in_client_valuation

        Denotes if this plan should be included in the client valuation

      • show_on_joint

        Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

      • shown_on_circles

        Determines if plan should be shown on a circle

      • review_date

        Review date

      • on_panel

        On panel

      • is_group_scheme

        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.

      • is_sub_group_scheme

        Denotes if the plan is a sub-scheme of a group scheme.

      • is_group_scheme_member

        Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

      • advice_area

        The advice area of the plan based on the plan's sub type.

      • total_benefit_amount

        Total amount benefit of all covers

      • total_benefits

        Total benefits broken down in to cover types

      • value

        Total value of the plan

      • valued_at

        When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

      • original_valued_at

        When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

      • statistics

        The statistics on a plan. Only displayed when you retrieve an individual plan

      • is_wrap_product

        Determines if the plan is a wrap plan

      • is_wrap_child

        Determines if the plan is a wrap child

      • can_be_deleted

        Denotes if the plan can be deleted

    • visible_to_circles object
      Hide visible_to_circles attributes Show visible_to_circles attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • statistics object
      Hide statistics attribute Show statistics attribute object

      • recent_growth integer
    • cases object
      Hide cases attributes Show cases attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the case

      • slug

        Slug of the case

      • review_at

        Timestamp of when the case should be reviewed

      • assigned_to_uuids

        UUIDs of accounts that will be assigned to the case when it is created.

      • group_uuids

        UUIDs of groups that will be assigned when the case is created.

      • completed_at

        Timestamp of when the case was completed

      • value

        Expected value of this case

      • status_position

        The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.

      • participants_count

        The number of participants on the case

      • task_board_uuid

        UUID of the task board

    • tags object
      Hide tags attributes Show tags attributes object

      • uuid

        UUID of the tag

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the tag

      • slug

        The slug of the tag

      • colour

        The colour of the tag

    • is_wrap_product boolean
    • is_wrap_child boolean
    • wrap object
      Hide wrap attributes Show wrap attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • opened_at

        Timestamp of when the plan was originally opened

      • name

        Name of the plan

      • type

        Type of plan, this will indicate what to expect from the fields attribute

      • sub_type

        Plan sub type

      • abstract_type

        describes if the plan is an asset, protection or liability

      • policy_number

        The policy number on the main sub account of the plan

      • proposal_reference

        The proposal reference on the main sub account of the plan

      • status

        Plan status

      • inactive_at

        Timestamp of when the plan became inactive

      • inactive_reason

        Reason for inactivity

      • agency_in_your_name

        Denotes if plan has agency in your name

      • agency_in_your_name_from

        Date the agency was in your name from

      • originally_sold_by_firm

        Denotes if the plan was originally sold by your firm

      • under_advice

        Denotes if plan is under advice

      • visible_on_client_portal

        Denotes if this plan is visible to clients on the client portal

      • include_in_client_valuation

        Denotes if this plan should be included in the client valuation

      • show_on_joint

        Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

      • shown_on_circles

        Determines if plan should be shown on a circle

      • review_date

        Review date

      • on_panel

        On panel

      • is_group_scheme

        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.

      • is_sub_group_scheme

        Denotes if the plan is a sub-scheme of a group scheme.

      • is_group_scheme_member

        Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

      • advice_area

        The advice area of the plan based on the plan's sub type.

      • total_benefit_amount

        Total amount benefit of all covers

      • total_benefits

        Total benefits broken down in to cover types

      • value

        Total value of the plan

      • valued_at

        When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

      • original_valued_at

        When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

      • statistics

        The statistics on a plan. Only displayed when you retrieve an individual plan

      • is_wrap_product

        Determines if the plan is a wrap plan

      • is_wrap_child

        Determines if the plan is a wrap child

      • can_be_deleted

        Denotes if the plan can be deleted

    • wrap_children object
      Hide wrap_children attributes Show wrap_children attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • opened_at

        Timestamp of when the plan was originally opened

      • name

        Name of the plan

      • type

        Type of plan, this will indicate what to expect from the fields attribute

      • sub_type

        Plan sub type

      • abstract_type

        describes if the plan is an asset, protection or liability

      • policy_number

        The policy number on the main sub account of the plan

      • proposal_reference

        The proposal reference on the main sub account of the plan

      • status

        Plan status

      • inactive_at

        Timestamp of when the plan became inactive

      • inactive_reason

        Reason for inactivity

      • agency_in_your_name

        Denotes if plan has agency in your name

      • agency_in_your_name_from

        Date the agency was in your name from

      • originally_sold_by_firm

        Denotes if the plan was originally sold by your firm

      • under_advice

        Denotes if plan is under advice

      • visible_on_client_portal

        Denotes if this plan is visible to clients on the client portal

      • include_in_client_valuation

        Denotes if this plan should be included in the client valuation

      • show_on_joint

        Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

      • shown_on_circles

        Determines if plan should be shown on a circle

      • review_date

        Review date

      • on_panel

        On panel

      • is_group_scheme

        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.

      • is_sub_group_scheme

        Denotes if the plan is a sub-scheme of a group scheme.

      • is_group_scheme_member

        Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

      • advice_area

        The advice area of the plan based on the plan's sub type.

      • total_benefit_amount

        Total amount benefit of all covers

      • total_benefits

        Total benefits broken down in to cover types

      • value

        Total value of the plan

      • valued_at

        When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

      • original_valued_at

        When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

      • statistics

        The statistics on a plan. Only displayed when you retrieve an individual plan

      • is_wrap_product

        Determines if the plan is a wrap plan

      • is_wrap_child

        Determines if the plan is a wrap child

      • can_be_deleted

        Denotes if the plan can be deleted

    • linked_policy_numbers object
      Hide linked_policy_numbers attributes Show linked_policy_numbers attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • linked_policy_number

        The linked policy number.

    • can_be_deleted string
    • contract_enquiry_account object
      Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • mortgage_product object
      Hide mortgage_product attributes Show mortgage_product attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • provider_reference

        The provider reference for the mortgage product (if available)

      • provider_scenario_name

        The name of the scenario from the provider (if available)

      • provider_scenario_data

        Optional metadata from the mortgage provider

      • lender_name

        The name of the lender for the mortgage product

      • product_title

        The name of the mortgage product

    • custom_fields object
      Hide custom_fields attributes Show custom_fields attributes object

      • uuid

        The UUID of the custom field

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        The type of custom field

      • name

        The name of the custom field

      • reference

        The reference of the custom field, used when updating the custom field on the model.

      • is_required

        Denotes if the custom field is required

      • value

        The value of the custom field

      • selection_options

        This is the array of available options for the selection box. If the type is "selection" this array will be provided.

      • help_text

        Optional help text to aide the custom field. Will be displayed on Plannr.

    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • sub_account object
    Hide sub_account attributes Show sub_account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • policy_number string
    • latest_valuation object
      Hide latest_valuation attributes Show latest_valuation attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • valued_at

        Valued at

      • value

        Valuation

    • is_main_account boolean
    • active_portfolio object
      Hide active_portfolio attributes Show active_portfolio attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • is_proposed

        Denotes if the portfolio is proposed

      • proposed_at

        The date the portfolio was proposed.

      • name

        The name of the portfolio.

    • statistics object
      Hide statistics attribute Show statistics attribute object

      • recent_growth integer
  • holding object
    Hide holding attributes Show holding attributes object

    • uuid string
    • created_at string
    • updated_at string
    • fund_name string
    • reference string
    • sector string
    • sedol string
    • isin string
    • citi string
    • units integer
    • unit_price object
      Hide unit_price attributes Show unit_price attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • unit_price_raw integer
    • purchase_price object
      Hide purchase_price attributes Show purchase_price attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • is_active boolean
    • value object
      Hide value attributes Show value attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • sub_account object
      Hide sub_account attributes Show sub_account attributes object

      • uuid

        UUID of the sub account

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was created.

      • name

        Descriptive name of the sub account

      • policy_number

        Provider reference of the sub account

      • is_main_account

        Denotes if the sub account a main account of the plan

      • statistics

        The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • account object
    Hide account attributes Show account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • firm object
      Hide firm attributes Show firm attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the firm

      • slug

        Slug of the firm

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • regulatory_text

        Regulatory text of the firm.

      • logo

        URL of your firm logo.

      • logo_icon

        URL of your firm logo icon.

      • brand_colours

        Firm branding colours.

      • factfind_pdf_header_background

        Header background colour (hex) for the fact-find snapshot PDF.

      • factfind_pdf_header_text

        Header text colour (hex) for the fact-find snapshot PDF.

      • factfind_pdf_logo

        URL of the logo used on the fact-find snapshot PDF.

      • is_subscribed

        Subscription status.

      • keep_deleted_files_for

        Number of days to keep deleted files for

      • tax

        Tax percent

      • month_end

        Date of the month for the monthly income reconciliation statements to end

      • statement_frequency

        The frequency of the income reconciliation statements

      • billing

        Firm invoice details for billing

      • ip_whitelist

        A list of IP Addresses a firm is allowed to log in from.

      • welcome_paragraph_html

        Custom welcome paragraph html for the branded auth welcome page

      • email_welcome_paragraph_html

        Custom welcome paragraph for the welcome/new user email

      • show_fact_find_illustrations

        Determines if the illustrations/graphics are displayed on the fact find.

      • cc_email_addresses

        Array of email cc addresses.

      • bcc_email_addresses

        Array of email bcc addresses.

      • reply_to_email_address

        Firm reply to email address.

      • mobile_app_support_number

        Firm mobile app support number.

      • mobile_app_support_email

        Firm mobile app support email address.

    • primary_phone_number object
      Hide primary_phone_number attributes Show primary_phone_number attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

        If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    • primary_email object
      Hide primary_email attributes Show primary_email attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

        If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    • current_time_entry object
      Hide current_time_entry attributes Show current_time_entry attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the time entry.

      • description

        The description of the time entry.

      • trackable_type

        The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.

      • start_date

        The start time of the time entry.

      • end_date

        The end time of the time entry.

      • is_active

        Determines if the time entry is currently ongoing.

      • total_time_in_minutes

        Total time in minutes.

      • computed_time_elapsed_in_seconds

        Computed time elapsed in seconds.

    • assigned_adviser object
      Hide assigned_adviser attributes Show assigned_adviser attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_administrator object
      Hide assigned_administrator attributes Show assigned_administrator attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_paraplanner object
      Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • introduced_by object
      Hide introduced_by attributes Show introduced_by attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • business_unit object
      Hide business_unit attributes Show business_unit attributes object

      • uuid

        The UUID of the resource.

      • name

        Name of the business unit.

      • has_alternative_branding

        Whether alternative branding is enabled for this business unit.

      • brand_colours

        Brand colours for this business unit, merged with firm defaults.

      • members_count

        Number of accounts assigned to this business unit

      • groups_count

        Number of groups assigned to this business unit

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

    • groups object
      Hide groups attributes Show groups attributes object

      • uuid

        UUID of the group

      • name

        Name of the group

      • slug

        Slug of the group

      • participants_count

        Number of participants in the group

      • participants

        Participants in this group

      • created_at

        Timestamp of when the group was created

      • updated_at

        Timestamp of when the group was updated

    • tags object
      Hide tags attributes Show tags attributes object

      • uuid

        UUID of the tag

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the tag

      • slug

        The slug of the tag

      • colour

        The colour of the tag

    • owners object
      Hide owners attributes Show owners attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

        Denotes whether the account is currently within an active Out of Office window (employees only)

      • out_of_office_from

        Start of the Out of Office period (employees only). Null when not out of office

      • out_of_office_until

        End of the Out of Office period (employees only). Null when not out of office

      • out_of_office_message

        Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

      • is_pending_fact_find_account

        Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • first_contact_date string
    • next_review_date string
    • previous_review_date string
    • anniversary_review_date string
    • terms_of_business_at string
    • client_agreement_at string
    • with_login boolean
    • has_joint_account boolean
    • can_be_deleted string
    • joint_account_circle object
      Hide joint_account_circle attributes Show joint_account_circle attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • circles object
      Hide circles attributes Show circles attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • ownership_percentage integer
    • inactive_at string
    • last_interaction_at string
    • referral_code string
    • is_out_of_office boolean
    • out_of_office_from string
    • out_of_office_until string
    • out_of_office_message string
    • service_level object
      Hide service_level attributes Show service_level attributes object

      • uuid

        The UUID of the resource.

      • name

        The name of the service level.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

    • is_pending_fact_find_account boolean
    • permissions object
      Hide permissions attributes Show permissions attributes object

      • firm:read array[string]
      • network:read array[string]
    • custom_fields object
      Hide custom_fields attributes Show custom_fields attributes object

      • uuid

        The UUID of the custom field

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        The type of custom field

      • name

        The name of the custom field

      • reference

        The reference of the custom field, used when updating the custom field on the model.

      • is_required

        Denotes if the custom field is required

      • value

        The value of the custom field

      • selection_options

        This is the array of available options for the selection box. If the type is "selection" this array will be provided.

      • help_text

        Optional help text to aide the custom field. Will be displayed on Plannr.

    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • provider object
    Hide provider attributes Show provider attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
  • provider_controlled boolean
  • type string
  • sub_type string
  • amount object
    Hide amount attributes Show amount attributes object

    • amount string
    • currency string
    • formatted string
  • frequency string
  • start_date string
  • end_date string
  • next_transaction_date string
  • paused_until string
• 409 application/json

  Plan is being deleted

  Hide response attribute Show response attribute object

  • message string Required

    A human-readable description of the error.

• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • message string Required

    A human-readable description of the error.

  • errors object

    Validation messages keyed by the field that failed.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties