Get all charges Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
GET /api/v1/charge
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [statement].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[client_uuids] string

    Filter by a comma separated list of client UUIDs.

  • filter[group_uuids] string

    Filter by a comma separated list of group UUIDs.

  • filter[circle_uuids] string

    Filter by a comma separated list of circle UUIDs.

  • filter[plan_uuids] string

    Filter by a comma separated list of plan UUIDs.

  • filter[provider_uuids] string

    Filter by a comma separated list of provider UUIDs.

  • filter[policy_number] string

    Filter by policy numbers.

  • filter[seller_uuids] string

    Filter by a comma separated list of seller account UUIDs.

  • filter[payment_origin] string

    Filter by comma separated list of payment origins.

  • filter[type] string

    Filter by comma separated list of charge types.

  • filter[category] string

    Filter by comma separated list of charge categories.

  • filter[recurring] boolean

    Filter by recurring charges or not.

  • filter[frequency] string

    Filter by comma separated list of frequencies.

  • filter[start_date_after] string

    Filter by charge start dates after.

  • filter[start_date_before] string

    Filter by charge start dates before.

  • filter[end_date_after] string

    Filter by charge end dates after.

  • filter[end_date_before] string

    Filter by charge end dates before.

  • filter[next_expectation_date_after] string

    Filter by charge next expectation dates after.

  • filter[next_expectation_date_before] string

    Filter by charge next expectation dates before.

  • filter[amount_from] integer

    Filter by charge fixed amounts from in pennies.

  • filter[amount_to] integer

    Filter by charge fixed amounts to in pennies.

  • filter[percentage_from] number

    Filter by charge percentages from.

  • filter[percentage_to] number

    Filter by charge percentages to.

  • filter[tax_exempt] boolean

    Filter by tax exempt charges or not.

  • filter[exclude_from_rmar] boolean

    Filter by charges excluded from RMAR or not.

  • filter[rmar_type] string

    Filter by comma separated list of RMAR types.

  • filter[advice_type] string

    Filter by comma separated list of advice types.

  • filter[service_type] string

    Filter by comma separated list of service types.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC. Defaults to '-start_date'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • payment_origin string
      • type string
      • category string
      • recurring boolean
      • frequency string
      • start_date string
      • end_date string
      • next_expectation_date string
      • tax_exempt boolean
      • tax number
      • amount object
        Hide amount attributes Show 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
      • percentage number
      • percentage_frequency string
      • charge_identifier string
      • exclude_from_rmar boolean
      • rmar_type string
      • advice_type string
      • service_type string
      • advice_area object
        Hide advice_area attributes Show advice_area attributes object
        • deposit integer
        • non_regulated integer
        • non_rmar integer
        • non_investment_insurance integer
        • regulated_mortgage integer
        • retail_investment integer
        • other_fca_regulated integer
        • unknown integer
      • plan_value string
      • chargeable_type object
        Hide chargeable_type attributes Show chargeable_type attributes object
        • amount string
        • currency string
        • formatted string
      • chargeable object
        Hide chargeable attributes Show chargeable 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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.

      • 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_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.

          • 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

            IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

          • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

        • marketing_consent object
          Hide marketing_consent attributes Show marketing_consent attributes object
          • email

            Marketing consent status for email. One of not_captured, opted_in and opted_out

          • phone

            Marketing consent status for phone. One of not_captured, opted_in and opted_out

          • letter

            Marketing consent status for letter. One of not_captured, opted_in and opted_out

          • sms

            Marketing consent status for SMS. One of not_captured, opted_in and opted_out

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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]
        • managed_by_head_office boolean
        • 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.

      • author object
        Hide author attributes Show author 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_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.

          • 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

            IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

          • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

        • marketing_consent object
          Hide marketing_consent attributes Show marketing_consent attributes object
          • email

            Marketing consent status for email. One of not_captured, opted_in and opted_out

          • phone

            Marketing consent status for phone. One of not_captured, opted_in and opted_out

          • letter

            Marketing consent status for letter. One of not_captured, opted_in and opted_out

          • sms

            Marketing consent status for SMS. One of not_captured, opted_in and opted_out

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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]
        • managed_by_head_office boolean
        • 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.

      • seller object
        Hide seller attributes Show seller 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_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.

          • 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

            IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

          • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

        • marketing_consent object
          Hide marketing_consent attributes Show marketing_consent attributes object
          • email

            Marketing consent status for email. One of not_captured, opted_in and opted_out

          • phone

            Marketing consent status for phone. One of not_captured, opted_in and opted_out

          • letter

            Marketing consent status for letter. One of not_captured, opted_in and opted_out

          • sms

            Marketing consent status for SMS. One of not_captured, opted_in and opted_out

        • 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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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]
        • managed_by_head_office boolean
        • 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.

      • premium object
        Hide premium attributes Show premium attributes object
        • uuid string
        • created_at string
        • updated_at string
        • transfer_type string
        • date_of_transfer_valuation string
        • date_advice_given string
        • premium integer
        • premium_monthly integer
        • premium_annually integer
        • total_premium_to_date integer
        • amount integer
        • percentage number
        • frequency string
        • source string
        • payment_method string
        • start_date string
        • end_date string
        • pensionable_salary integer
        • details string
        • created_by object
          Hide created_by attributes Show created_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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • plan object
          Hide plan attributes Show plan 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

        • transferred_from_plan object
          Hide transferred_from_plan attributes Show transferred_from_plan 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

        • transferred_from_plan_type string
        • transferred_from_plan_sub_type string
      • firm object
        Hide firm attributes Show firm attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
        • address_1 string
        • address_2 string
        • town_city string
        • county string
        • postcode string
        • country string
        • regulatory_text string
        • logo_icon string
        • brand_colours object
          Hide brand_colours attributes Show brand_colours attributes object
          • sidebar_background string
          • sidebar_accent string
          • sidebar_text string
          • sidebar_hover string
          • sidebar_active string
          • sidebar_title_background string
          • sidebar_title_primary string
          • sidebar_title_secondary string
          • sidebar_title_secondary_hover string
          • email_background string
          • email_logo_background_panel string
          • email_sub_text string
          • email_button_background string
          • email_button_text string
          • portal_sidebar_button_background string
          • portal_sidebar_button_hover string
          • portal_sidebar_button_active string
          • portal_brand_title string
          • portal_brand_sub_title string
          • portal_sidebar_title string
          • portal_sidebar_text string
          • portal_sidebar_text_hover string
          • portal_sidebar_text_active string
          • portal_sidebar_icon string
          • portal_sidebar_icon_hover string
          • portal_sidebar_icon_active string
          • portal_background string
          • portal_sidebar_account_title string
          • portal_sidebar_account_email string
          • portal_sidebar_divider string
          • portal_dashboard_bg_one string
          • portal_dashboard_bg_two string
          • portal_sidebar_collapse_button string
          • portal_sidebar_collapse_button_hover string
          • portal_sidebar_user_select_background string
          • portal_sidebar_user_select_hover string
          • portal_sidebar_user_select_text string
          • portal_sidebar_user_select_text_hover string
          • portal_sidebar_user_select_border string
          • portal_sidebar_user_select_border_hover string
        • factfind_pdf_header_background string
        • factfind_pdf_header_text string
        • is_subscribed boolean
        • addon_subscriptions object
          Hide addon_subscriptions attributes Show addon_subscriptions 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.

          • enabled

            Determines if the addon is enabled

          • trial_ends_at

            If the addon is a paid addon, this is the date the free trial will end for the addon subscription.

          • trial_ends_in_days

            If the addon is a paid addon, this is the number of days left in the free trial for the addon subscription.

          • payment_confirmed_at

            If the addon is a paid addon, this is the date the payment was confirmed for the addon subscription.

        • keep_deleted_files_for integer
        • tax number
        • month_end integer
        • statement_frequency string
        • billing object
          Hide billing attributes Show billing attributes object
          • invoice_address_1 string
          • invoice_address_2 string
          • invoice_town_city string
          • invoice_county string
          • invoice_postcode string
          • invoice_country string
          • invoice_email string
        • task_board_template object
          Hide task_board_template attributes Show task_board_template attributes object
          • uuid

            uuid of the board

          • created_at

            timestamp of when the board was created

          • updated_at

            timestamp of when the board was updated

          • is_template

            returns true if the board is a template

          • name

            the name of the board

          • default_list_uuid

            the default list uuid

          • is_editable

            determines if the user can edit the board (e.g update the board, lists and move tasks around)

          • priorities

            returns the array of priorities that can be set within a task

        • ip_whitelist array[string]
        • welcome_paragraph_html string
        • email_welcome_paragraph_html string
        • show_fact_find_illustrations boolean
        • cc_email_addresses array[string]
        • bcc_email_addresses array[string]
        • reply_to_email_address string
        • mobile_app_support_number string
        • mobile_app_support_email string
      • notes_count integer
  • 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
GET /api/v1/charge 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/charge' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "3ed1a3bd-01cd-4fe3-9725-ea4ccc1926a4",
      "created_at": "2026-10-29T17:25:07+00:00",
      "updated_at": "2026-10-29T17:25:07+00:00",
      "payment_origin": "provider",
      "type": "fee",
      "category": "ongoing_fee",
      "recurring": true,
      "frequency": "monthly",
      "start_date": "2026-03-01",
      "end_date": "2026-11-29",
      "next_expectation_date": "2026-11-08",
      "tax_exempt": false,
      "tax": 17.5,
      "amount": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "percentage": 0.75,
      "percentage_frequency": "annually",
      "charge_identifier": "PLANNR-72484",
      "exclude_from_rmar": true,
      "rmar_type": "adviser_charge",
      "advice_type": "independent",
      "service_type": "initial",
      "advice_area": {
        "deposit": 7500,
        "non_regulated": 0,
        "non_rmar": 0,
        "non_investment_insurance": 0,
        "regulated_mortgage": 2500,
        "retail_investment": 0,
        "other_fca_regulated": 0,
        "unknown": 0
      },
      "plan_value": "plan",
      "chargeable_type": {
        "amount": "12000000",
        "currency": "GBP",
        "formatted": "£120,000.00"
      },
      "chargeable": {
        "uuid": "3f4cfb00-1b1a-4829-aff0-78e7e42a7311",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "opened_at": "2026-10-29T17:25:07+00:00",
        "name": "Johns ISA",
        "type": "cash_account",
        "sub_type": "lifetime isa",
        "abstract_type": "asset",
        "policy_number": "AVIVA-123",
        "proposal_reference": "AB123456",
        "status": "inactive",
        "inactive_at": "2026-10-29T17:25:07+00:00",
        "inactive_reason": "claimed",
        "agency_in_your_name": true,
        "agency_in_your_name_from": "2025-10-29",
        "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": true,
        "review_date": "2025-10-29",
        "on_panel": true,
        "is_group_scheme": false,
        "is_sub_group_scheme": false,
        "is_group_scheme_member": false,
        "advice_area": "non_investment_insurance",
        "main_account": {
          "uuid": "45c0d530-05d9-4659-a0e0-619e432b0075",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "John's ISA",
          "policy_number": "AVI-4837",
          "is_main_account": false,
          "statistics": {
            "recent_growth": 100
          }
        },
        "sub_accounts": {
          "uuid": "45c0d530-05d9-4659-a0e0-619e432b0075",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "John's ISA",
          "policy_number": "AVI-4837",
          "is_main_account": false,
          "statistics": {
            "recent_growth": 100
          }
        },
        "provider": {
          "uuid": "6fb2ca7b-076d-420a-9082-34ca8f134705",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "AJ Bell",
          "slug": "aj-bell"
        },
        "covers": {
          "uuid": "bb323f70-2189-4e00-a784-407a94d33556",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "cover_type": "critical_illness",
          "benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "benefit_frequency": "monthly",
          "benefit_status": "active",
          "excess": {
            "amount": {
              "example": "10000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£100.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "indexation": 1.4
        },
        "claims": {
          "uuid": "5e2004c3-ced1-46c4-8103-d173f9cfd95b",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "claim_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "claim_start_date": "2025-10-29",
          "claim_end_date": "2031-10-29",
          "claim_notes": "Claim notes"
        },
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            }
          }
        },
        "latest_valuations": {
          "uuid": "25706026-4640-41c6-a69f-899e0080ad10",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "valued_at": "2026-10-29T17:25:13+00:00",
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          }
        },
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "valued_at": "2026-10-29T17:25:07+00:00",
        "original_valued_at": "2026-10-28T17:25:07+00:00",
        "client": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "accounts": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "seller": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "linked_owners": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "linked_plans": {
          "uuid": "cb711453-af50-48d7-905b-d6714ffa0bfa",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "opened_at": "2026-10-29T17:25:13+00:00",
          "name": "Johns ISA",
          "type": "cash_account",
          "sub_type": "lifetime isa",
          "abstract_type": "asset",
          "policy_number": "AVIVA-123",
          "proposal_reference": "AB123456",
          "status": "inactive",
          "inactive_at": "2026-10-29T17:25:13+00:00",
          "inactive_reason": "claimed",
          "agency_in_your_name": true,
          "agency_in_your_name_from": "2025-10-29",
          "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": true,
          "review_date": "2025-10-29",
          "on_panel": true,
          "is_group_scheme": false,
          "is_sub_group_scheme": false,
          "is_group_scheme_member": false,
          "advice_area": "non_investment_insurance",
          "total_benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "total_benefits": {
            "critical_illness": {
              "amount": {
                "example": "15000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£150,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            },
            "family_income_benefit": {
              "amount": {
                "example": "10000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£100,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            }
          },
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "valued_at": "2026-10-29T17:25:13+00:00",
          "original_valued_at": "2026-10-28T17:25:13+00:00",
          "statistics": {
            "recent_growth": 100
          },
          "is_wrap_product": false,
          "is_wrap_child": false,
          "can_be_deleted": "false"
        },
        "visible_to_circles": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "statistics": {
          "recent_growth": 100
        },
        "cases": {
          "uuid": "e24347fb-044c-4129-8043-8450a03cb036",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "finance",
          "slug": "finance",
          "review_at": "2026-10-29T17:25:13+00:00",
          "assigned_to_uuids": [
            null
          ],
          "group_uuids": [
            null
          ],
          "completed_at": "2026-10-29T17:25:13+00:00",
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "status_position": 4,
          "participants_count": 4,
          "task_board_uuid": null
        },
        "tags": {
          "uuid": "33f99866-b8c1-412e-90cd-3555125539c1",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Mortgage",
          "slug": "mortgage",
          "colour": "#ef4582"
        },
        "is_wrap_product": false,
        "is_wrap_child": false,
        "wrap": {
          "uuid": "cb711453-af50-48d7-905b-d6714ffa0bfa",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "opened_at": "2026-10-29T17:25:13+00:00",
          "name": "Johns ISA",
          "type": "cash_account",
          "sub_type": "lifetime isa",
          "abstract_type": "asset",
          "policy_number": "AVIVA-123",
          "proposal_reference": "AB123456",
          "status": "inactive",
          "inactive_at": "2026-10-29T17:25:13+00:00",
          "inactive_reason": "claimed",
          "agency_in_your_name": true,
          "agency_in_your_name_from": "2025-10-29",
          "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": true,
          "review_date": "2025-10-29",
          "on_panel": true,
          "is_group_scheme": false,
          "is_sub_group_scheme": false,
          "is_group_scheme_member": false,
          "advice_area": "non_investment_insurance",
          "total_benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "total_benefits": {
            "critical_illness": {
              "amount": {
                "example": "15000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£150,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            },
            "family_income_benefit": {
              "amount": {
                "example": "10000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£100,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            }
          },
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "valued_at": "2026-10-29T17:25:13+00:00",
          "original_valued_at": "2026-10-28T17:25:13+00:00",
          "statistics": {
            "recent_growth": 100
          },
          "is_wrap_product": false,
          "is_wrap_child": false,
          "can_be_deleted": "false"
        },
        "wrap_children": {
          "uuid": "cb711453-af50-48d7-905b-d6714ffa0bfa",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "opened_at": "2026-10-29T17:25:13+00:00",
          "name": "Johns ISA",
          "type": "cash_account",
          "sub_type": "lifetime isa",
          "abstract_type": "asset",
          "policy_number": "AVIVA-123",
          "proposal_reference": "AB123456",
          "status": "inactive",
          "inactive_at": "2026-10-29T17:25:13+00:00",
          "inactive_reason": "claimed",
          "agency_in_your_name": true,
          "agency_in_your_name_from": "2025-10-29",
          "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": true,
          "review_date": "2025-10-29",
          "on_panel": true,
          "is_group_scheme": false,
          "is_sub_group_scheme": false,
          "is_group_scheme_member": false,
          "advice_area": "non_investment_insurance",
          "total_benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "total_benefits": {
            "critical_illness": {
              "amount": {
                "example": "15000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£150,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            },
            "family_income_benefit": {
              "amount": {
                "example": "10000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£100,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            }
          },
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "valued_at": "2026-10-29T17:25:13+00:00",
          "original_valued_at": "2026-10-28T17:25:13+00:00",
          "statistics": {
            "recent_growth": 100
          },
          "is_wrap_product": false,
          "is_wrap_child": false,
          "can_be_deleted": "false"
        },
        "linked_policy_numbers": {
          "uuid": "17df9042-8a0b-4af5-8340-cd1749c29123",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "linked_policy_number": "ABC123-X"
        },
        "can_be_deleted": "false",
        "contract_enquiry_account": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "mortgage_product": {
          "uuid": "5fb9f53c-0fac-4fd4-a67b-56963274f9bc",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "provider_reference": "example-reference",
          "provider_scenario_name": "Single Applicant, Small Deposit",
          "provider_scenario_data": [],
          "lender_name": "HSBC",
          "product_title": "5% Fixed Rate - 5 year"
        },
        "custom_fields": {
          "uuid": null,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "string",
          "name": "Favourite Drink",
          "reference": "favourite_drink",
          "is_required": false,
          "value": "Coffee",
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ],
          "help_text": "This is the client's favourite drink."
        },
        "external_references": {
          "uuid": "d966c70b-b1e3-4681-a484-10e116f601a0",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "account": {
        "uuid": "1c300608-62f7-497f-9b8b-0200f770297b",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": {
          "uuid": "a473c07b-c216-494a-832a-22add43fe748",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Codepotato",
          "slug": "codepotato",
          "address_1": "Suite E, 5 The Briars",
          "address_2": "Waterberry Drive",
          "town_city": "Waterlooville",
          "county": "Hampshire",
          "postcode": "PO7 7YH",
          "country": "United Kingdom",
          "regulatory_text": "Regulatory text",
          "logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
          "brand_colours": {
            "sidebar_background": "#0E0E56",
            "sidebar_accent": "#36367E",
            "sidebar_text": "#FFFFFF",
            "sidebar_hover": "#0A0A42",
            "sidebar_active": "#53DBB8",
            "sidebar_title_background": "#36367E",
            "sidebar_title_primary": "#FFC634",
            "sidebar_title_secondary": "#FFFFFF",
            "sidebar_title_secondary_hover": "#FFFFFF",
            "email_background": "#0E0E56",
            "email_logo_background_panel": "#36367E",
            "email_sub_text": "#FFFFFF",
            "email_button_background": "#36367E",
            "email_button_text": "#FFFFFF",
            "portal_sidebar_button_background": "#F6F6F6",
            "portal_sidebar_button_hover": "#FFFFFF",
            "portal_sidebar_button_active": "#FFFFFF",
            "portal_brand_title": "#323B4B",
            "portal_brand_sub_title": "#828994",
            "portal_sidebar_title": "#11151D",
            "portal_sidebar_text": "#323B4B",
            "portal_sidebar_text_hover": "#323B4B",
            "portal_sidebar_text_active": "#323B4B",
            "portal_sidebar_icon": "#828994",
            "portal_sidebar_icon_hover": "#828994",
            "portal_sidebar_icon_active": "#828994",
            "portal_background": "#F6F6F6",
            "portal_sidebar_account_title": "#11151D",
            "portal_sidebar_account_email": "#828994",
            "portal_sidebar_divider": "#E3E5E9",
            "portal_dashboard_bg_one": "#EF4583",
            "portal_dashboard_bg_two": "#FFC634",
            "portal_sidebar_collapse_button": "#828994",
            "portal_sidebar_collapse_button_hover": "#B3B9C4",
            "portal_sidebar_user_select_background": "#F6F6F6",
            "portal_sidebar_user_select_hover": "#F6F6F6",
            "portal_sidebar_user_select_text": "#323B4B",
            "portal_sidebar_user_select_text_hover": "#323B4B",
            "portal_sidebar_user_select_border": "#EEEEEE",
            "portal_sidebar_user_select_border_hover": "#828994"
          },
          "factfind_pdf_header_background": "#0E0E56",
          "factfind_pdf_header_text": "#ffffff",
          "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "is_subscribed": true,
          "keep_deleted_files_for": 30,
          "tax": 17.5,
          "month_end": 25,
          "statement_frequency": "monthly",
          "billing": {
            "invoice_address_1": "Suite E, 5 The Briars",
            "invoice_address_2": "Waterberry Drive",
            "invoice_town_city": "Waterlooville",
            "invoice_county": "Hampshire",
            "invoice_postcode": "PO7 7YH",
            "invoice_country": "United Kingdom",
            "invoice_email": "gareth@codepotato.co.uk"
          },
          "ip_whitelist": [
            "192.168.0.1",
            "127.0.0.1"
          ],
          "welcome_paragraph_html": "<h1>Welcome.</h1>",
          "email_welcome_paragraph_html": "Welcome to Plannr!",
          "show_fact_find_illustrations": true,
          "cc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "bcc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "reply_to_email_address": "jack@example.com",
          "mobile_app_support_number": "01234 567890",
          "mobile_app_support_email": "support@example.com"
        },
        "primary_phone_number": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "primary_email": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "current_time_entry": {
          "uuid": "d0113ed6-7b8b-4e4e-b931-32c6cef9df2e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Research",
          "description": "This is a description.",
          "trackable_type": "Client",
          "start_date": "2026-10-29T16:35:13+00:00",
          "end_date": "2026-10-29T17:03:13+00:00",
          "is_active": true,
          "total_time_in_minutes": 28,
          "computed_time_elapsed_in_seconds": 1680
        },
        "assigned_adviser": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_administrator": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_paraplanner": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "introduced_by": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "business_unit": {
          "uuid": "e5ac12c8-45b5-4719-a400-63a4f6b8c9f3",
          "name": "Wealth Management",
          "has_alternative_branding": false,
          "brand_colours": [],
          "members_count": 3,
          "groups_count": 2,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "groups": {
          "uuid": null,
          "name": "finance",
          "slug": "finance",
          "participants_count": "3",
          "participants": {
            "uuid": {
              "example": null,
              "description": "UUID of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "first_name": {
              "example": "Gareth",
              "description": "First name of the account"
            },
            "last_name": {
              "example": "Thompson",
              "description": "Last name of the account"
            },
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "email": {
              "example": "gareth@codepotato.co.uk",
              "description": "Email of the account"
            }
          },
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "tags": {
          "uuid": "33f99866-b8c1-412e-90cd-3555125539c1",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Mortgage",
          "slug": "mortgage",
          "colour": "#ef4582"
        },
        "marketing_consent": {
          "email": "opted_in",
          "phone": "opted_out",
          "letter": "not_captured",
          "sms": "not_captured"
        },
        "owners": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "first_contact_date": "2026-10-29T17:25:07+00:00",
        "next_review_date": "2026-10-29T17:25:07+00:00",
        "previous_review_date": "2026-10-29T17:25:07+00:00",
        "anniversary_review_date": "2026-10-29T17:25:07+00:00",
        "terms_of_business_at": "2026-10-29T17:25:07+00:00",
        "client_agreement_at": "2026-10-29T17:25:07+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "circles": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "ownership_percentage": 100,
        "inactive_at": "2026-10-29",
        "last_interaction_at": "2026-10-29 17:25:07",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-29T17:25:07+00:00",
        "out_of_office_until": "2026-10-29T17:25:07+00:00",
        "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
        "service_level": {
          "uuid": "edd73c8f-6fd8-4108-9c9a-39014e8438ed",
          "name": "Gold",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "is_pending_fact_find_account": false,
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "managed_by_head_office": false,
        "custom_fields": {
          "uuid": null,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "string",
          "name": "Favourite Drink",
          "reference": "favourite_drink",
          "is_required": false,
          "value": "Coffee",
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ],
          "help_text": "This is the client's favourite drink."
        },
        "external_references": {
          "uuid": "d966c70b-b1e3-4681-a484-10e116f601a0",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "author": {
        "uuid": "4b29346c-3b4e-43a7-9867-09d163995b5b",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": {
          "uuid": "a473c07b-c216-494a-832a-22add43fe748",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Codepotato",
          "slug": "codepotato",
          "address_1": "Suite E, 5 The Briars",
          "address_2": "Waterberry Drive",
          "town_city": "Waterlooville",
          "county": "Hampshire",
          "postcode": "PO7 7YH",
          "country": "United Kingdom",
          "regulatory_text": "Regulatory text",
          "logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
          "brand_colours": {
            "sidebar_background": "#0E0E56",
            "sidebar_accent": "#36367E",
            "sidebar_text": "#FFFFFF",
            "sidebar_hover": "#0A0A42",
            "sidebar_active": "#53DBB8",
            "sidebar_title_background": "#36367E",
            "sidebar_title_primary": "#FFC634",
            "sidebar_title_secondary": "#FFFFFF",
            "sidebar_title_secondary_hover": "#FFFFFF",
            "email_background": "#0E0E56",
            "email_logo_background_panel": "#36367E",
            "email_sub_text": "#FFFFFF",
            "email_button_background": "#36367E",
            "email_button_text": "#FFFFFF",
            "portal_sidebar_button_background": "#F6F6F6",
            "portal_sidebar_button_hover": "#FFFFFF",
            "portal_sidebar_button_active": "#FFFFFF",
            "portal_brand_title": "#323B4B",
            "portal_brand_sub_title": "#828994",
            "portal_sidebar_title": "#11151D",
            "portal_sidebar_text": "#323B4B",
            "portal_sidebar_text_hover": "#323B4B",
            "portal_sidebar_text_active": "#323B4B",
            "portal_sidebar_icon": "#828994",
            "portal_sidebar_icon_hover": "#828994",
            "portal_sidebar_icon_active": "#828994",
            "portal_background": "#F6F6F6",
            "portal_sidebar_account_title": "#11151D",
            "portal_sidebar_account_email": "#828994",
            "portal_sidebar_divider": "#E3E5E9",
            "portal_dashboard_bg_one": "#EF4583",
            "portal_dashboard_bg_two": "#FFC634",
            "portal_sidebar_collapse_button": "#828994",
            "portal_sidebar_collapse_button_hover": "#B3B9C4",
            "portal_sidebar_user_select_background": "#F6F6F6",
            "portal_sidebar_user_select_hover": "#F6F6F6",
            "portal_sidebar_user_select_text": "#323B4B",
            "portal_sidebar_user_select_text_hover": "#323B4B",
            "portal_sidebar_user_select_border": "#EEEEEE",
            "portal_sidebar_user_select_border_hover": "#828994"
          },
          "factfind_pdf_header_background": "#0E0E56",
          "factfind_pdf_header_text": "#ffffff",
          "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "is_subscribed": true,
          "keep_deleted_files_for": 30,
          "tax": 17.5,
          "month_end": 25,
          "statement_frequency": "monthly",
          "billing": {
            "invoice_address_1": "Suite E, 5 The Briars",
            "invoice_address_2": "Waterberry Drive",
            "invoice_town_city": "Waterlooville",
            "invoice_county": "Hampshire",
            "invoice_postcode": "PO7 7YH",
            "invoice_country": "United Kingdom",
            "invoice_email": "gareth@codepotato.co.uk"
          },
          "ip_whitelist": [
            "192.168.0.1",
            "127.0.0.1"
          ],
          "welcome_paragraph_html": "<h1>Welcome.</h1>",
          "email_welcome_paragraph_html": "Welcome to Plannr!",
          "show_fact_find_illustrations": true,
          "cc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "bcc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "reply_to_email_address": "jack@example.com",
          "mobile_app_support_number": "01234 567890",
          "mobile_app_support_email": "support@example.com"
        },
        "primary_phone_number": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "primary_email": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "current_time_entry": {
          "uuid": "d0113ed6-7b8b-4e4e-b931-32c6cef9df2e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Research",
          "description": "This is a description.",
          "trackable_type": "Client",
          "start_date": "2026-10-29T16:35:13+00:00",
          "end_date": "2026-10-29T17:03:13+00:00",
          "is_active": true,
          "total_time_in_minutes": 28,
          "computed_time_elapsed_in_seconds": 1680
        },
        "assigned_adviser": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_administrator": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_paraplanner": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "introduced_by": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "business_unit": {
          "uuid": "e5ac12c8-45b5-4719-a400-63a4f6b8c9f3",
          "name": "Wealth Management",
          "has_alternative_branding": false,
          "brand_colours": [],
          "members_count": 3,
          "groups_count": 2,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "groups": {
          "uuid": null,
          "name": "finance",
          "slug": "finance",
          "participants_count": "3",
          "participants": {
            "uuid": {
              "example": null,
              "description": "UUID of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "first_name": {
              "example": "Gareth",
              "description": "First name of the account"
            },
            "last_name": {
              "example": "Thompson",
              "description": "Last name of the account"
            },
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "email": {
              "example": "gareth@codepotato.co.uk",
              "description": "Email of the account"
            }
          },
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "tags": {
          "uuid": "33f99866-b8c1-412e-90cd-3555125539c1",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Mortgage",
          "slug": "mortgage",
          "colour": "#ef4582"
        },
        "marketing_consent": {
          "email": "opted_in",
          "phone": "opted_out",
          "letter": "not_captured",
          "sms": "not_captured"
        },
        "owners": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "first_contact_date": "2026-10-29T17:25:07+00:00",
        "next_review_date": "2026-10-29T17:25:07+00:00",
        "previous_review_date": "2026-10-29T17:25:07+00:00",
        "anniversary_review_date": "2026-10-29T17:25:07+00:00",
        "terms_of_business_at": "2026-10-29T17:25:07+00:00",
        "client_agreement_at": "2026-10-29T17:25:07+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "circles": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "ownership_percentage": 100,
        "inactive_at": "2026-10-29",
        "last_interaction_at": "2026-10-29 17:25:07",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-29T17:25:07+00:00",
        "out_of_office_until": "2026-10-29T17:25:07+00:00",
        "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
        "service_level": {
          "uuid": "edd73c8f-6fd8-4108-9c9a-39014e8438ed",
          "name": "Gold",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "is_pending_fact_find_account": false,
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "managed_by_head_office": false,
        "custom_fields": {
          "uuid": null,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "string",
          "name": "Favourite Drink",
          "reference": "favourite_drink",
          "is_required": false,
          "value": "Coffee",
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ],
          "help_text": "This is the client's favourite drink."
        },
        "external_references": {
          "uuid": "d966c70b-b1e3-4681-a484-10e116f601a0",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "seller": {
        "uuid": "9fcddd1b-8d32-4ded-bbf4-4228a8197b2c",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": {
          "uuid": "a473c07b-c216-494a-832a-22add43fe748",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Codepotato",
          "slug": "codepotato",
          "address_1": "Suite E, 5 The Briars",
          "address_2": "Waterberry Drive",
          "town_city": "Waterlooville",
          "county": "Hampshire",
          "postcode": "PO7 7YH",
          "country": "United Kingdom",
          "regulatory_text": "Regulatory text",
          "logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
          "brand_colours": {
            "sidebar_background": "#0E0E56",
            "sidebar_accent": "#36367E",
            "sidebar_text": "#FFFFFF",
            "sidebar_hover": "#0A0A42",
            "sidebar_active": "#53DBB8",
            "sidebar_title_background": "#36367E",
            "sidebar_title_primary": "#FFC634",
            "sidebar_title_secondary": "#FFFFFF",
            "sidebar_title_secondary_hover": "#FFFFFF",
            "email_background": "#0E0E56",
            "email_logo_background_panel": "#36367E",
            "email_sub_text": "#FFFFFF",
            "email_button_background": "#36367E",
            "email_button_text": "#FFFFFF",
            "portal_sidebar_button_background": "#F6F6F6",
            "portal_sidebar_button_hover": "#FFFFFF",
            "portal_sidebar_button_active": "#FFFFFF",
            "portal_brand_title": "#323B4B",
            "portal_brand_sub_title": "#828994",
            "portal_sidebar_title": "#11151D",
            "portal_sidebar_text": "#323B4B",
            "portal_sidebar_text_hover": "#323B4B",
            "portal_sidebar_text_active": "#323B4B",
            "portal_sidebar_icon": "#828994",
            "portal_sidebar_icon_hover": "#828994",
            "portal_sidebar_icon_active": "#828994",
            "portal_background": "#F6F6F6",
            "portal_sidebar_account_title": "#11151D",
            "portal_sidebar_account_email": "#828994",
            "portal_sidebar_divider": "#E3E5E9",
            "portal_dashboard_bg_one": "#EF4583",
            "portal_dashboard_bg_two": "#FFC634",
            "portal_sidebar_collapse_button": "#828994",
            "portal_sidebar_collapse_button_hover": "#B3B9C4",
            "portal_sidebar_user_select_background": "#F6F6F6",
            "portal_sidebar_user_select_hover": "#F6F6F6",
            "portal_sidebar_user_select_text": "#323B4B",
            "portal_sidebar_user_select_text_hover": "#323B4B",
            "portal_sidebar_user_select_border": "#EEEEEE",
            "portal_sidebar_user_select_border_hover": "#828994"
          },
          "factfind_pdf_header_background": "#0E0E56",
          "factfind_pdf_header_text": "#ffffff",
          "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "is_subscribed": true,
          "keep_deleted_files_for": 30,
          "tax": 17.5,
          "month_end": 25,
          "statement_frequency": "monthly",
          "billing": {
            "invoice_address_1": "Suite E, 5 The Briars",
            "invoice_address_2": "Waterberry Drive",
            "invoice_town_city": "Waterlooville",
            "invoice_county": "Hampshire",
            "invoice_postcode": "PO7 7YH",
            "invoice_country": "United Kingdom",
            "invoice_email": "gareth@codepotato.co.uk"
          },
          "ip_whitelist": [
            "192.168.0.1",
            "127.0.0.1"
          ],
          "welcome_paragraph_html": "<h1>Welcome.</h1>",
          "email_welcome_paragraph_html": "Welcome to Plannr!",
          "show_fact_find_illustrations": true,
          "cc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "bcc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "reply_to_email_address": "jack@example.com",
          "mobile_app_support_number": "01234 567890",
          "mobile_app_support_email": "support@example.com"
        },
        "primary_phone_number": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "primary_email": {
          "uuid": "4a157d65-2fa0-42c5-8a96-ce285287421e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "current_time_entry": {
          "uuid": "d0113ed6-7b8b-4e4e-b931-32c6cef9df2e",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Research",
          "description": "This is a description.",
          "trackable_type": "Client",
          "start_date": "2026-10-29T16:35:13+00:00",
          "end_date": "2026-10-29T17:03:13+00:00",
          "is_active": true,
          "total_time_in_minutes": 28,
          "computed_time_elapsed_in_seconds": 1680
        },
        "assigned_adviser": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_administrator": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_paraplanner": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "introduced_by": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "business_unit": {
          "uuid": "e5ac12c8-45b5-4719-a400-63a4f6b8c9f3",
          "name": "Wealth Management",
          "has_alternative_branding": false,
          "brand_colours": [],
          "members_count": 3,
          "groups_count": 2,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "groups": {
          "uuid": null,
          "name": "finance",
          "slug": "finance",
          "participants_count": "3",
          "participants": {
            "uuid": {
              "example": null,
              "description": "UUID of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "first_name": {
              "example": "Gareth",
              "description": "First name of the account"
            },
            "last_name": {
              "example": "Thompson",
              "description": "Last name of the account"
            },
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "email": {
              "example": "gareth@codepotato.co.uk",
              "description": "Email of the account"
            }
          },
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "tags": {
          "uuid": "33f99866-b8c1-412e-90cd-3555125539c1",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Mortgage",
          "slug": "mortgage",
          "colour": "#ef4582"
        },
        "marketing_consent": {
          "email": "opted_in",
          "phone": "opted_out",
          "letter": "not_captured",
          "sms": "not_captured"
        },
        "owners": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "first_contact_date": "2026-10-29T17:25:07+00:00",
        "next_review_date": "2026-10-29T17:25:07+00:00",
        "previous_review_date": "2026-10-29T17:25:07+00:00",
        "anniversary_review_date": "2026-10-29T17:25:07+00:00",
        "terms_of_business_at": "2026-10-29T17:25:07+00:00",
        "client_agreement_at": "2026-10-29T17:25:07+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "circles": {
          "uuid": "151dc94a-b498-4ec7-ab08-13d1f1b3914f",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-29T17:25:13+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "4b2e4646-f1d0-445e-b644-8767e03a8bf4",
          "login_access_level": "write",
          "current_life_stage_uuid": "3b189994-3fe7-47f0-9030-c8836fcd72d7"
        },
        "ownership_percentage": 100,
        "inactive_at": "2026-10-29",
        "last_interaction_at": "2026-10-29 17:25:07",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-29T17:25:07+00:00",
        "out_of_office_until": "2026-10-29T17:25:07+00:00",
        "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
        "service_level": {
          "uuid": "edd73c8f-6fd8-4108-9c9a-39014e8438ed",
          "name": "Gold",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00"
        },
        "is_pending_fact_find_account": false,
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "managed_by_head_office": false,
        "custom_fields": {
          "uuid": null,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "string",
          "name": "Favourite Drink",
          "reference": "favourite_drink",
          "is_required": false,
          "value": "Coffee",
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ],
          "help_text": "This is the client's favourite drink."
        },
        "external_references": {
          "uuid": "d966c70b-b1e3-4681-a484-10e116f601a0",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "premium": {
        "uuid": "f4c40417-876c-4f77-af45-5eb6c6ab4ced",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "transfer_type": "transfer",
        "date_of_transfer_valuation": "2026-06-12",
        "date_advice_given": "2026-05-08",
        "premium": 74584,
        "premium_monthly": 298336,
        "premium_annually": 3580032,
        "total_premium_to_date": 74584,
        "amount": 74584,
        "percentage": 5.5,
        "frequency": "weekly",
        "source": "employee",
        "payment_method": "direct_debit",
        "start_date": "2026-09-14",
        "end_date": "2028-10-29",
        "pensionable_salary": 10000000,
        "details": "Extra premium details",
        "created_by": {
          "uuid": "d5d36f53-7bf2-4cdc-9b9e-ab0c775ae829",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-29T17:25:13+00:00",
          "next_review_date": "2026-10-29T17:25:13+00:00",
          "previous_review_date": "2026-10-29T17:25:13+00:00",
          "anniversary_review_date": "2026-10-29T17:25:13+00:00",
          "terms_of_business_at": "2026-10-29T17:25:13+00:00",
          "client_agreement_at": "2026-10-29T17:25:13+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-29",
          "last_interaction_at": "2026-10-29 17:25:13",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-29T17:25:13+00:00",
          "out_of_office_until": "2026-10-29T17:25:13+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "plan": {
          "uuid": "cb711453-af50-48d7-905b-d6714ffa0bfa",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "opened_at": "2026-10-29T17:25:13+00:00",
          "name": "Johns ISA",
          "type": "cash_account",
          "sub_type": "lifetime isa",
          "abstract_type": "asset",
          "policy_number": "AVIVA-123",
          "proposal_reference": "AB123456",
          "status": "inactive",
          "inactive_at": "2026-10-29T17:25:13+00:00",
          "inactive_reason": "claimed",
          "agency_in_your_name": true,
          "agency_in_your_name_from": "2025-10-29",
          "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": true,
          "review_date": "2025-10-29",
          "on_panel": true,
          "is_group_scheme": false,
          "is_sub_group_scheme": false,
          "is_group_scheme_member": false,
          "advice_area": "non_investment_insurance",
          "total_benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "total_benefits": {
            "critical_illness": {
              "amount": {
                "example": "15000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£150,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            },
            "family_income_benefit": {
              "amount": {
                "example": "10000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£100,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            }
          },
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "valued_at": "2026-10-29T17:25:13+00:00",
          "original_valued_at": "2026-10-28T17:25:13+00:00",
          "statistics": {
            "recent_growth": 100
          },
          "is_wrap_product": false,
          "is_wrap_child": false,
          "can_be_deleted": "false"
        },
        "transferred_from_plan": {
          "uuid": "cb711453-af50-48d7-905b-d6714ffa0bfa",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "opened_at": "2026-10-29T17:25:13+00:00",
          "name": "Johns ISA",
          "type": "cash_account",
          "sub_type": "lifetime isa",
          "abstract_type": "asset",
          "policy_number": "AVIVA-123",
          "proposal_reference": "AB123456",
          "status": "inactive",
          "inactive_at": "2026-10-29T17:25:13+00:00",
          "inactive_reason": "claimed",
          "agency_in_your_name": true,
          "agency_in_your_name_from": "2025-10-29",
          "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": true,
          "review_date": "2025-10-29",
          "on_panel": true,
          "is_group_scheme": false,
          "is_sub_group_scheme": false,
          "is_group_scheme_member": false,
          "advice_area": "non_investment_insurance",
          "total_benefit_amount": {
            "amount": {
              "example": "25000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£250,000.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "total_benefits": {
            "critical_illness": {
              "amount": {
                "example": "15000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£150,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            },
            "family_income_benefit": {
              "amount": {
                "example": "10000000",
                "description": "Money amount at their lowest denominator (for example: pennies)"
              },
              "formatted": {
                "example": "£100,000.00",
                "description": "Money amount formatted with currency"
              },
              "currency": {
                "example": null,
                "description": "Currency of the money"
              }
            }
          },
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            },
            "currency": {
              "example": null,
              "description": "Currency of the money"
            }
          },
          "valued_at": "2026-10-29T17:25:13+00:00",
          "original_valued_at": "2026-10-28T17:25:13+00:00",
          "statistics": {
            "recent_growth": 100
          },
          "is_wrap_product": false,
          "is_wrap_child": false,
          "can_be_deleted": "false"
        },
        "transferred_from_plan_type": "cash_account",
        "transferred_from_plan_sub_type": "cash_deposit"
      },
      "firm": {
        "uuid": "dbd2f850-633c-4961-807e-010642e309f0",
        "created_at": "2026-10-29T17:25:07+00:00",
        "updated_at": "2026-10-29T17:25:07+00:00",
        "name": "Codepotato",
        "slug": "codepotato",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "town_city": "Waterlooville",
        "county": "Hampshire",
        "postcode": "PO7 7YH",
        "country": "United Kingdom",
        "regulatory_text": "Regulatory text",
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
        "brand_colours": {
          "sidebar_background": "#0E0E56",
          "sidebar_accent": "#36367E",
          "sidebar_text": "#FFFFFF",
          "sidebar_hover": "#0A0A42",
          "sidebar_active": "#53DBB8",
          "sidebar_title_background": "#36367E",
          "sidebar_title_primary": "#FFC634",
          "sidebar_title_secondary": "#FFFFFF",
          "sidebar_title_secondary_hover": "#FFFFFF",
          "email_background": "#0E0E56",
          "email_logo_background_panel": "#36367E",
          "email_sub_text": "#FFFFFF",
          "email_button_background": "#36367E",
          "email_button_text": "#FFFFFF",
          "portal_sidebar_button_background": "#F6F6F6",
          "portal_sidebar_button_hover": "#FFFFFF",
          "portal_sidebar_button_active": "#FFFFFF",
          "portal_brand_title": "#323B4B",
          "portal_brand_sub_title": "#828994",
          "portal_sidebar_title": "#11151D",
          "portal_sidebar_text": "#323B4B",
          "portal_sidebar_text_hover": "#323B4B",
          "portal_sidebar_text_active": "#323B4B",
          "portal_sidebar_icon": "#828994",
          "portal_sidebar_icon_hover": "#828994",
          "portal_sidebar_icon_active": "#828994",
          "portal_background": "#F6F6F6",
          "portal_sidebar_account_title": "#11151D",
          "portal_sidebar_account_email": "#828994",
          "portal_sidebar_divider": "#E3E5E9",
          "portal_dashboard_bg_one": "#EF4583",
          "portal_dashboard_bg_two": "#FFC634",
          "portal_sidebar_collapse_button": "#828994",
          "portal_sidebar_collapse_button_hover": "#B3B9C4",
          "portal_sidebar_user_select_background": "#F6F6F6",
          "portal_sidebar_user_select_hover": "#F6F6F6",
          "portal_sidebar_user_select_text": "#323B4B",
          "portal_sidebar_user_select_text_hover": "#323B4B",
          "portal_sidebar_user_select_border": "#EEEEEE",
          "portal_sidebar_user_select_border_hover": "#828994"
        },
        "factfind_pdf_header_background": "#0E0E56",
        "factfind_pdf_header_text": "#ffffff",
        "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "is_subscribed": true,
        "addon_subscriptions": {
          "uuid": "f25b4b4a-d6fc-4c22-9089-53381f1be296",
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "enabled": "true",
          "trial_ends_at": "2026-11-12",
          "trial_ends_in_days": 14,
          "payment_confirmed_at": "2026-11-16"
        },
        "keep_deleted_files_for": 30,
        "tax": 17.5,
        "month_end": 25,
        "statement_frequency": "monthly",
        "billing": {
          "invoice_address_1": "Suite E, 5 The Briars",
          "invoice_address_2": "Waterberry Drive",
          "invoice_town_city": "Waterlooville",
          "invoice_county": "Hampshire",
          "invoice_postcode": "PO7 7YH",
          "invoice_country": "United Kingdom",
          "invoice_email": "gareth@codepotato.co.uk"
        },
        "task_board_template": {
          "uuid": null,
          "created_at": "2026-10-29T17:25:13+00:00",
          "updated_at": "2026-10-29T17:25:13+00:00",
          "is_template": false,
          "name": "Task Board",
          "default_list_uuid": null,
          "is_editable": true,
          "priorities": [
            {
              "name": "High",
              "value": "high"
            },
            {
              "name": "Low",
              "value": "low"
            }
          ]
        },
        "ip_whitelist": [
          "192.168.0.1",
          "127.0.0.1"
        ],
        "welcome_paragraph_html": "<h1>Welcome.</h1>",
        "email_welcome_paragraph_html": "Welcome to Plannr!",
        "show_fact_find_illustrations": true,
        "cc_email_addresses": [
          "jack@example.com",
          "jill@example.com"
        ],
        "bcc_email_addresses": [
          "jack@example.com",
          "jill@example.com"
        ],
        "reply_to_email_address": "jack@example.com",
        "mobile_app_support_number": "01234 567890",
        "mobile_app_support_email": "support@example.com"
      },
      "notes_count": 5
    }
  ]
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}