Set an employee's Out of Office | PlannrCRM API documentation

Set an employee's Out of Office 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

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

PUT /api/v1/account/{account_uuid}/out-of-office

Personal access token & O auth2

Record (or replace) the Out of Office window and message for an employee account.

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

account_uuid string Required

The UUID of the employee account.

application/json

Body

from string(date-time) Required

Start of the Out of Office period.
until string(date-time) Required

End of the Out of Office period. Must be after from
message string Required

Free text message shown to portal users while Out of Office.
cover_account_uuid string

UUID of the employee who covers this person conversations while away.

Responses

200 application/json
Hide response attributes Show response 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 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 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
  
  factfind_pdf_logo 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
- primary_phone_number object
  
  Hide primary_phone_number attributes Show primary_phone_number attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  value string
  
  phone_number_meta object
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
  
  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.
- primary_email object
  
  Hide primary_email attributes Show primary_email attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  value string
  
  phone_number_meta object
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
  
  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.
- current_time_entry object
  
  Hide current_time_entry attributes Show current_time_entry attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  description string
  
  trackable_type string
  
  trackable object
  
  Hide trackable attributes Show trackable 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 the primary email of the account instead). The email of the account.
  
  photo_url
  
  The photo URL of the client
  
  start_date string
  
  end_date string
  
  is_active boolean
  
  total_time_in_minutes integer
  
  computed_time_elapsed_in_seconds integer
  
  account object
  
  Hide account attributes Show 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 the primary email of the account instead). The email of the account.
  
  photo_url
  
  The photo URL of the client
- assigned_adviser object
  
  Hide assigned_adviser attributes Show assigned_adviser attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
- assigned_administrator object
  
  Hide assigned_administrator attributes Show assigned_administrator attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
- assigned_paraplanner object
  
  Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
- introduced_by object
  
  Hide introduced_by attributes Show introduced_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
- business_unit object
  
  Hide business_unit attributes Show business_unit attributes object
  
  uuid string
  
  name string
  
  has_alternative_branding boolean
  
  brand_colours array
  
  members_count integer
  
  members object
  
  Hide members attributes Show members 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.
  
  groups_count integer
  
  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
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
  
  created_at string
  
  updated_at string
- groups array[object]
  
  Hide groups attributes Show groups attributes object
  
  uuid string
  
  name string
  
  slug string
  
  participants_count string
  
  participants object
  
  Hide participants attributes Show participants attributes object
  
  uuid object
  
  Hide uuid attributes Show uuid attributes object
  
  example string
  
  description string
  
  role object
  
  Hide role attributes Show role attributes object
  
  example string
  
  description string
  
  first_name object
  
  Hide first_name attributes Show first_name attributes object
  
  example string
  
  description string
  
  last_name object
  
  Hide last_name attributes Show last_name attributes object
  
  example string
  
  description string
  
  name object
  
  Hide name attributes Show name attributes object
  
  example string
  
  description string
  
  email object
  
  Hide email attributes Show email attributes object
  
  example string
  
  description string
  
  created_at string
  
  updated_at string
- tags array[object]
  
  Hide tags attributes Show tags attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string
- marketing_consent object
  
  Hide marketing_consent attributes Show marketing_consent attributes object
  
  email string
  
  phone string
  
  letter string
  
  sms string
- owners array[object]
  
  Hide owners attributes Show owners attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  Name of the firm
  
  slug
  
  Slug of the firm
  
  address_1
  
  First line of the address
  
  address_2
  
  Second line of the address
  
  town_city
  
  Town/City
  
  county
  
  County
  
  postcode
  
  Postcode
  
  country
  
  Country
  
  regulatory_text
  
  Regulatory text of the firm.
  
  logo
  
  URL of your firm logo.
  
  logo_icon
  
  URL of your firm logo icon.
  
  brand_colours
  
  Firm branding colours.
  
  factfind_pdf_header_background
  
  Header background colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_header_text
  
  Header text colour (hex) for the fact-find snapshot PDF.
  
  factfind_pdf_logo
  
  URL of the logo used on the fact-find snapshot PDF.
  
  is_subscribed
  
  Subscription status.
  
  keep_deleted_files_for
  
  Number of days to keep deleted files for
  
  tax
  
  Tax percent
  
  month_end
  
  Date of the month for the monthly income reconciliation statements to end
  
  statement_frequency
  
  The frequency of the income reconciliation statements
  
  billing
  
  Firm invoice details for billing
  
  ip_whitelist
  
  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.
- 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 string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  has_portal_access boolean
  
  portal_access_status string
  
  engagement_rating string
  
  last_login object
  
  Hide last_login attributes Show last_login attributes object
  
  logged_in_at string
  
  account_uuid string
  
  account_name string
  
  device_type string
  
  device_platform string
  
  portal_login_count_30d integer
  
  portal_login_count_90d integer
  
  portal_login_count_365d integer
  
  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.
  
  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
  
  joint_account_uuid string
  
  login_access_level string
  
  current_life_stage_uuid string
  
  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.
- circles array[object]
  
  Hide circles attributes Show circles attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  has_portal_access boolean
  
  portal_access_status string
  
  engagement_rating string
  
  last_login object
  
  Hide last_login attributes Show last_login attributes object
  
  logged_in_at string
  
  account_uuid string
  
  account_name string
  
  device_type string
  
  device_platform string
  
  portal_login_count_30d integer
  
  portal_login_count_90d integer
  
  portal_login_count_365d integer
  
  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.
  
  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
  
  joint_account_uuid string
  
  login_access_level string
  
  current_life_stage_uuid string
  
  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.
- 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 string
  
  name string
  
  created_at string
  
  updated_at string
- 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 array[object]
  
  Hide custom_fields attributes Show custom_fields attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  reference string
  
  is_required boolean
  
  value string
  
  selection_options array[string]
  
  help_text string
- external_references array[object]
  
  Hide external_references attributes Show external_references attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  third_party string
  
  reference string
400 application/json

Account is not an employee
Hide response attribute Show response attribute object
- message string Required
  
  A human-readable description of the error.
422 application/json

Validation error
Hide response attributes Show response attributes object
- message string Required
  
  A human-readable description of the error.
- errors object
  
  Validation messages keyed by the field that failed.
  
  Hide errors attribute Show errors attribute object
  
  * array[string] Additional properties

PUT /api/v1/account/{account_uuid}/out-of-office

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/account/53f22fe4-3731-4cdc-aa12-e65bd0b15e52/out-of-office' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "from": "2026-10-19T22:30:47+01:00",
  "until": "2026-10-19T22:30:47+01:00",
  "message": "I am away this week. For urgent matters please contact the office.",
  "cover_account_uuid": "9c1a2b3c-..."
}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "from": "2026-10-19T22:30:47+01:00",
  "until": "2026-10-19T22:30:47+01:00",
  "message": "I am away this week. For urgent matters please contact the office.",
  "cover_account_uuid": "9c1a2b3c-..."
}

Response examples (200)

{
  "uuid": "a036704d-006a-482e-9d68-d3475c59de71",
  "created_at": "2026-10-19T22:30:47+01:00",
  "updated_at": "2026-10-19T22:30:47+01: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": "3a642cfa-b3a2-464f-b715-c9ce158a6613",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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": "ae32cea3-8322-4d4d-b46e-bd6198b18c54",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "enabled": "true",
      "trial_ends_at": "2026-11-02",
      "trial_ends_in_days": 14,
      "payment_confirmed_at": "2026-11-06"
    },
    "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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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"
  },
  "primary_phone_number": {
    "uuid": "8ced4f8f-e2a0-48fc-860d-8761f8ec44a0",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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
    }
  },
  "primary_email": {
    "uuid": "ab5c6ca5-6d58-473d-902e-79d041331f0f",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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
    }
  },
  "current_time_entry": {
    "uuid": "9cfd8458-20f6-4d9a-b6e5-c7344dc723d3",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01:00",
    "name": "Research",
    "description": "This is a description.",
    "trackable_type": "Client",
    "trackable": {
      "uuid": "288ffcfc-11a8-47a0-bc02-fcc53311f433",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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"
    },
    "start_date": "2026-10-19T21:40:47+01:00",
    "end_date": "2026-10-19T22:08:47+01:00",
    "is_active": true,
    "total_time_in_minutes": 28,
    "computed_time_elapsed_in_seconds": 1680,
    "account": {
      "uuid": "288ffcfc-11a8-47a0-bc02-fcc53311f433",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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"
    }
  },
  "assigned_adviser": {
    "uuid": "077f3400-a964-4506-97cf-569e521b052b",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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": "b12987c3-4e5d-446b-815e-d4642bedcebc",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "primary_email": {
      "uuid": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "current_time_entry": {
      "uuid": "27666bf6-cdf3-40f4-9eda-6c4c0c53ee25",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Research",
      "description": "This is a description.",
      "trackable_type": "Client",
      "start_date": "2026-10-19T21:40:53+01:00",
      "end_date": "2026-10-19T22:08:53+01:00",
      "is_active": true,
      "total_time_in_minutes": 28,
      "computed_time_elapsed_in_seconds": 1680
    },
    "assigned_adviser": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "2d0a4622-b521-453a-9b66-18fb7770d532",
      "name": "Wealth Management",
      "has_alternative_branding": false,
      "brand_colours": [],
      "members_count": 3,
      "groups_count": 2,
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "tags": {
      "uuid": "32896f43-b2ff-43ea-87c7-82ed521052b1",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "marketing_consent": {
      "email": "opted_in",
      "phone": "opted_out",
      "letter": "not_captured",
      "sms": "not_captured"
    },
    "owners": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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-19T22:30:47+01:00",
    "next_review_date": "2026-10-19T22:30:47+01:00",
    "previous_review_date": "2026-10-19T22:30:47+01:00",
    "anniversary_review_date": "2026-10-19T22:30:47+01:00",
    "terms_of_business_at": "2026-10-19T22:30:47+01:00",
    "client_agreement_at": "2026-10-19T22:30:47+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "circles": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "ownership_percentage": 100,
    "inactive_at": "2026-10-19",
    "last_interaction_at": "2026-10-19 22:30:47",
    "referral_code": "ABC12345",
    "is_out_of_office": true,
    "out_of_office_from": "2026-10-19T22:30:47+01:00",
    "out_of_office_until": "2026-10-19T22:30:47+01:00",
    "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
    "service_level": {
      "uuid": "0ba006f4-4d49-4a40-9976-b5fd530cd94e",
      "name": "Gold",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "assigned_administrator": {
    "uuid": "5e19147c-7c88-4acc-a4c7-1294a8e36653",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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": "b12987c3-4e5d-446b-815e-d4642bedcebc",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "primary_email": {
      "uuid": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "current_time_entry": {
      "uuid": "27666bf6-cdf3-40f4-9eda-6c4c0c53ee25",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Research",
      "description": "This is a description.",
      "trackable_type": "Client",
      "start_date": "2026-10-19T21:40:53+01:00",
      "end_date": "2026-10-19T22:08:53+01:00",
      "is_active": true,
      "total_time_in_minutes": 28,
      "computed_time_elapsed_in_seconds": 1680
    },
    "assigned_adviser": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "2d0a4622-b521-453a-9b66-18fb7770d532",
      "name": "Wealth Management",
      "has_alternative_branding": false,
      "brand_colours": [],
      "members_count": 3,
      "groups_count": 2,
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "tags": {
      "uuid": "32896f43-b2ff-43ea-87c7-82ed521052b1",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "marketing_consent": {
      "email": "opted_in",
      "phone": "opted_out",
      "letter": "not_captured",
      "sms": "not_captured"
    },
    "owners": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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-19T22:30:47+01:00",
    "next_review_date": "2026-10-19T22:30:47+01:00",
    "previous_review_date": "2026-10-19T22:30:47+01:00",
    "anniversary_review_date": "2026-10-19T22:30:47+01:00",
    "terms_of_business_at": "2026-10-19T22:30:47+01:00",
    "client_agreement_at": "2026-10-19T22:30:47+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "circles": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "ownership_percentage": 100,
    "inactive_at": "2026-10-19",
    "last_interaction_at": "2026-10-19 22:30:47",
    "referral_code": "ABC12345",
    "is_out_of_office": true,
    "out_of_office_from": "2026-10-19T22:30:47+01:00",
    "out_of_office_until": "2026-10-19T22:30:47+01:00",
    "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
    "service_level": {
      "uuid": "0ba006f4-4d49-4a40-9976-b5fd530cd94e",
      "name": "Gold",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "assigned_paraplanner": {
    "uuid": "92732f93-3d90-423c-96e1-1b0b0d190282",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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": "b12987c3-4e5d-446b-815e-d4642bedcebc",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "primary_email": {
      "uuid": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "current_time_entry": {
      "uuid": "27666bf6-cdf3-40f4-9eda-6c4c0c53ee25",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Research",
      "description": "This is a description.",
      "trackable_type": "Client",
      "start_date": "2026-10-19T21:40:53+01:00",
      "end_date": "2026-10-19T22:08:53+01:00",
      "is_active": true,
      "total_time_in_minutes": 28,
      "computed_time_elapsed_in_seconds": 1680
    },
    "assigned_adviser": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "2d0a4622-b521-453a-9b66-18fb7770d532",
      "name": "Wealth Management",
      "has_alternative_branding": false,
      "brand_colours": [],
      "members_count": 3,
      "groups_count": 2,
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "tags": {
      "uuid": "32896f43-b2ff-43ea-87c7-82ed521052b1",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "marketing_consent": {
      "email": "opted_in",
      "phone": "opted_out",
      "letter": "not_captured",
      "sms": "not_captured"
    },
    "owners": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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-19T22:30:47+01:00",
    "next_review_date": "2026-10-19T22:30:47+01:00",
    "previous_review_date": "2026-10-19T22:30:47+01:00",
    "anniversary_review_date": "2026-10-19T22:30:47+01:00",
    "terms_of_business_at": "2026-10-19T22:30:47+01:00",
    "client_agreement_at": "2026-10-19T22:30:47+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "circles": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "ownership_percentage": 100,
    "inactive_at": "2026-10-19",
    "last_interaction_at": "2026-10-19 22:30:47",
    "referral_code": "ABC12345",
    "is_out_of_office": true,
    "out_of_office_from": "2026-10-19T22:30:47+01:00",
    "out_of_office_until": "2026-10-19T22:30:47+01:00",
    "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
    "service_level": {
      "uuid": "0ba006f4-4d49-4a40-9976-b5fd530cd94e",
      "name": "Gold",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "introduced_by": {
    "uuid": "08c4cca4-aeb0-4849-97f3-ad03d78371ff",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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": "b12987c3-4e5d-446b-815e-d4642bedcebc",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "primary_email": {
      "uuid": "54d48972-2a77-44cc-8000-bb7f5ee29033",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "type": "phone_number",
      "name": "Work number",
      "value": "+443330903630",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    },
    "current_time_entry": {
      "uuid": "27666bf6-cdf3-40f4-9eda-6c4c0c53ee25",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Research",
      "description": "This is a description.",
      "trackable_type": "Client",
      "start_date": "2026-10-19T21:40:53+01:00",
      "end_date": "2026-10-19T22:08:53+01:00",
      "is_active": true,
      "total_time_in_minutes": 28,
      "computed_time_elapsed_in_seconds": 1680
    },
    "assigned_adviser": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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": "2d0a4622-b521-453a-9b66-18fb7770d532",
      "name": "Wealth Management",
      "has_alternative_branding": false,
      "brand_colours": [],
      "members_count": 3,
      "groups_count": 2,
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "tags": {
      "uuid": "32896f43-b2ff-43ea-87c7-82ed521052b1",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "marketing_consent": {
      "email": "opted_in",
      "phone": "opted_out",
      "letter": "not_captured",
      "sms": "not_captured"
    },
    "owners": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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-19T22:30:47+01:00",
    "next_review_date": "2026-10-19T22:30:47+01:00",
    "previous_review_date": "2026-10-19T22:30:47+01:00",
    "anniversary_review_date": "2026-10-19T22:30:47+01:00",
    "terms_of_business_at": "2026-10-19T22:30:47+01:00",
    "client_agreement_at": "2026-10-19T22:30:47+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "circles": {
      "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
      "login_access_level": "write",
      "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
    },
    "ownership_percentage": 100,
    "inactive_at": "2026-10-19",
    "last_interaction_at": "2026-10-19 22:30:47",
    "referral_code": "ABC12345",
    "is_out_of_office": true,
    "out_of_office_from": "2026-10-19T22:30:47+01:00",
    "out_of_office_until": "2026-10-19T22:30:47+01:00",
    "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
    "service_level": {
      "uuid": "0ba006f4-4d49-4a40-9976-b5fd530cd94e",
      "name": "Gold",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "business_unit": {
    "uuid": "d98a4145-8b0f-496e-8da4-a95f73b26d77",
    "name": "Wealth Management",
    "has_alternative_branding": false,
    "brand_colours": [],
    "members_count": 3,
    "members": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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
    },
    "groups_count": 2,
    "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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "firm": {
      "uuid": "b12987c3-4e5d-446b-815e-d4642bedcebc",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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"
    },
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01:00"
  },
  "groups": [
    {
      "uuid": "1c78cfd1-e3e2-43bf-991d-934abe2634f6",
      "name": "finance",
      "slug": "finance",
      "participants_count": "3",
      "participants": {
        "uuid": {
          "example": "17e635b8-8dc0-4cda-a870-3241daceec1c",
          "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-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01:00"
    }
  ],
  "tags": [
    {
      "uuid": "eac0345e-4a95-47ae-a35b-e6c27fe4c143",
      "created_at": "2026-10-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    }
  ],
  "marketing_consent": {
    "email": "opted_in",
    "phone": "opted_out",
    "letter": "not_captured",
    "sms": "not_captured"
  },
  "owners": [
    {
      "uuid": "75db6b60-49de-4c9c-8f4e-342a9f01b5b2",
      "created_at": "2026-10-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01: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": "b12987c3-4e5d-446b-815e-d4642bedcebc",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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": "54d48972-2a77-44cc-8000-bb7f5ee29033",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "type": "phone_number",
        "name": "Work number",
        "value": "+443330903630",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "primary_email": {
        "uuid": "54d48972-2a77-44cc-8000-bb7f5ee29033",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "type": "phone_number",
        "name": "Work number",
        "value": "+443330903630",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "current_time_entry": {
        "uuid": "27666bf6-cdf3-40f4-9eda-6c4c0c53ee25",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "name": "Research",
        "description": "This is a description.",
        "trackable_type": "Client",
        "start_date": "2026-10-19T21:40:53+01:00",
        "end_date": "2026-10-19T22:08:53+01:00",
        "is_active": true,
        "total_time_in_minutes": 28,
        "computed_time_elapsed_in_seconds": 1680
      },
      "assigned_adviser": {
        "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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": "2d0a4622-b521-453a-9b66-18fb7770d532",
        "name": "Wealth Management",
        "has_alternative_branding": false,
        "brand_colours": [],
        "members_count": 3,
        "groups_count": 2,
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00"
      },
      "tags": {
        "uuid": "32896f43-b2ff-43ea-87c7-82ed521052b1",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "name": "Mortgage",
        "slug": "mortgage",
        "colour": "#ef4582"
      },
      "marketing_consent": {
        "email": "opted_in",
        "phone": "opted_out",
        "letter": "not_captured",
        "sms": "not_captured"
      },
      "owners": {
        "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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-19T22:30:47+01:00",
      "next_review_date": "2026-10-19T22:30:47+01:00",
      "previous_review_date": "2026-10-19T22:30:47+01:00",
      "anniversary_review_date": "2026-10-19T22:30:47+01:00",
      "terms_of_business_at": "2026-10-19T22:30:47+01:00",
      "client_agreement_at": "2026-10-19T22:30:47+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": {
        "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
        "login_access_level": "write",
        "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
      },
      "circles": {
        "uuid": "f950a028-9e37-491a-ae0a-aa67db03b69d",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01: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": "848c0738-f265-4ac5-a198-7183060d1704",
        "login_access_level": "write",
        "current_life_stage_uuid": "f403fe46-8639-4c90-bb73-fe463d9e4db9"
      },
      "ownership_percentage": 100,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:47",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:47+01:00",
      "out_of_office_until": "2026-10-19T22:30:47+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "service_level": {
        "uuid": "0ba006f4-4d49-4a40-9976-b5fd530cd94e",
        "name": "Gold",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "third_party": "nucleus",
        "reference": "AB123456"
      }
    }
  ],
  "first_contact_date": "2026-10-19T22:30:47+01:00",
  "next_review_date": "2026-10-19T22:30:47+01:00",
  "previous_review_date": "2026-10-19T22:30:47+01:00",
  "anniversary_review_date": "2026-10-19T22:30:47+01:00",
  "terms_of_business_at": "2026-10-19T22:30:47+01:00",
  "client_agreement_at": "2026-10-19T22:30:47+01:00",
  "with_login": true,
  "has_joint_account": true,
  "can_be_deleted": "false",
  "joint_account_circle": {
    "uuid": "9aa6f1c0-e771-4b59-8ee2-681467bf2b85",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01: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-19T22:30:47+01: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,
    "accounts": {
      "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
      "next_review_date": "2026-10-19T22:30:53+01:00",
      "previous_review_date": "2026-10-19T22:30:53+01:00",
      "anniversary_review_date": "2026-10-19T22:30:53+01:00",
      "terms_of_business_at": "2026-10-19T22:30:53+01:00",
      "client_agreement_at": "2026-10-19T22:30:53+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-19",
      "last_interaction_at": "2026-10-19 22:30:53",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-19T22:30:53+01:00",
      "out_of_office_until": "2026-10-19T22:30:53+01: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
    },
    "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-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00"
    },
    "joint_account_uuid": "494bdd24-3e41-4e7c-98db-34bf963beb32",
    "login_access_level": "write",
    "current_life_stage_uuid": "db296bda-1628-4f32-a95c-f701902181a4",
    "external_references": {
      "uuid": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
      "created_at": "2026-10-19T22:30:53+01:00",
      "updated_at": "2026-10-19T22:30:53+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "circles": [
    {
      "uuid": "ad695256-3b84-4f93-8b97-6d1d737c944e",
      "created_at": "2026-10-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01: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-19T22:30:47+01: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,
      "accounts": {
        "uuid": "c5d38c6e-3ace-4a1a-8a2c-de30d06afadd",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01: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-19T22:30:53+01:00",
        "next_review_date": "2026-10-19T22:30:53+01:00",
        "previous_review_date": "2026-10-19T22:30:53+01:00",
        "anniversary_review_date": "2026-10-19T22:30:53+01:00",
        "terms_of_business_at": "2026-10-19T22:30:53+01:00",
        "client_agreement_at": "2026-10-19T22:30:53+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-10-19",
        "last_interaction_at": "2026-10-19 22:30:53",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-19T22:30:53+01:00",
        "out_of_office_until": "2026-10-19T22:30:53+01: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
      },
      "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-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00"
      },
      "joint_account_uuid": "eee311ef-83dd-4854-91e5-8da72eb4784d",
      "login_access_level": "write",
      "current_life_stage_uuid": "23f9573f-84be-4081-879d-20df5977c559",
      "external_references": {
        "uuid": "b7c6de5a-9d06-4ca8-a078-10dbc88409d5",
        "created_at": "2026-10-19T22:30:53+01:00",
        "updated_at": "2026-10-19T22:30:53+01:00",
        "third_party": "nucleus",
        "reference": "AB123456"
      }
    }
  ],
  "ownership_percentage": 100,
  "inactive_at": "2026-10-19",
  "last_interaction_at": "2026-10-19 22:30:47",
  "referral_code": "ABC12345",
  "is_out_of_office": true,
  "out_of_office_from": "2026-10-19T22:30:47+01:00",
  "out_of_office_until": "2026-10-19T22:30:47+01:00",
  "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
  "service_level": {
    "uuid": "5dccdc47-5a72-4e03-a1f5-a3b2950feefa",
    "name": "Gold",
    "created_at": "2026-10-19T22:30:47+01:00",
    "updated_at": "2026-10-19T22:30:47+01:00"
  },
  "is_pending_fact_find_account": false,
  "permissions": {
    "firm:read": [
      "firm"
    ],
    "network:read": [
      "network:uuid"
    ]
  },
  "managed_by_head_office": false,
  "custom_fields": [
    {
      "uuid": "8a873d23-3de3-44f0-a5d3-85c553875711",
      "created_at": "2026-10-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01: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": "ae6eff64-d625-4389-8b29-bdf0e0678c8b",
      "created_at": "2026-10-19T22:30:47+01:00",
      "updated_at": "2026-10-19T22:30:47+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  ]
}

Response examples (400)

{
  "message": "Out of Office can only be set on employee accounts."
}

Response examples (422)

{
  "message": "The from field is required. (and 2 more errors)",
  "errors": {
    "from": [
      "The from field is required."
    ],
    "until": [
      "The until field is required."
    ],
    "message": [
      "The message field is required."
    ]
  }
}

{
  "message": "The until field must be a date after from.",
  "errors": {
    "until": [
      "The until field must be a date after from."
    ]
  }
}

{
  "message": "The message field must not be greater than 2000 characters.",
  "errors": {
    "message": [
      "The message field must not be greater than 2000 characters."
    ]
  }
}