Create an account | PlannrCRM API documentation

Create an account Run in API Explorer

POST /api/v1/account

Personal access token & O auth2

application/json

Body object

Client route for Create an account

type string Required

The type of the account being created. For creating a client, this type must be client.
role string Required

The role of the account being created. For creating a client, the available roles are: individual, joint, trust and business
title string

Title
first_name string Required

First Name
middle_name string

Middle Name
last_name string Required

Last Name
maiden_name string

Maiden Name
email string

Email address
send_welcome_email boolean

Send an email on account creation and create a login
phone string

Phone number
address object
Hide address attributes Show address attributes object
- name string
  
  Name of the address
- address_1 string
  
  First line of the address
- address_2 string
  
  Second line of the address
- address_3 string
  
  Third line of the address
- address_4 string
  
  Fourth line of the address
- town_city string
  
  Town/City
- county string
  
  County
- postcode string
  
  Postcode
- country string
  
  Country
- move_in_date string
  
  Move in date
- moved_in_month integer
  
  The month the client moved into this address.
- moved_in_year integer
  
  The year the client moved into this address.
- moved_out_month integer
  
  The month the client moved out of this address.
- moved_out_year integer
  
  The year the client moved out of this address.
- residential_status string
  
  The client's residential status when living at the address.
  
  Value Description
  
  homeowner Homeowner
  
  renting Renting
  
  living_with_parents Living With Parents
  
  other Other
  
  Values are homeowner, renting, living_with_parents, or other.
- residential_status_other string
  
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
assigned_adviser_uuid string(uuid)

The UUID of the employee that the client directly reports to
assigned_administrator_uuid string(uuid)

The UUID of the adviser employee that the client has been assigned
assigned_paraplanner_uuid string(uuid)

The UUID of the paraplanner employee that the client has been assigned
introduced_by_uuid string(uuid)

The UUID of the introducer for this client
date_of_birth string(date)

Date of birth
gender string

Gender.

Value Description

male male

female female

non-binary non-binary

transgender transgender

intersex intersex

other other

unknown unknown

Values are male, female, non-binary, transgender, intersex, other, or unknown.
ni_number string

National Insurance Number
nickname string

preferred nickname of the client
target_retirement_age integer

Target retirement age.
pronouns string

Pronouns
smoker_status string

Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown
last_used_nicotine_products_date string(date)

The date of the last time the client used nicotine products.
residential_status string

Residential status
country_of_residence string

Country of residence
marital_status string

Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown
is_vulnerable string

whether the client is vulnerable. Possible values are: "yes", "no", and "possibly"
is_prospect boolean

Denotes if the client is a prospect or not.
prospect_converted_at string(date)

The datetime when the prospect was converted into a client.
value integer

The value of the client in penny format. E.g £5,000 would be 500000.
is_uk_resident boolean

Whether the client is a UK resident or not.
is_uk_domicile boolean

Whether the client is a UK domicile or not.
expected_retirement_age integer

The expected retirement age.
state_retirement_age integer

The state retirement age.
nationalities array

Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list.
vulnerability_details string

Any details regarding the client's vulnerabilities.
third_party_offered boolean

Whether the client has been offered any third party.
procedure_adaptation boolean

Whether any procedures need to be adapted to the client.
adaption_details_notes boolean

Any notes regarding adaptations
client_preferences string

Any client preferences.
current_state_of_health string

The client's current state of health.
state_of_health_explanation string

Explanation of the current state of health.
cigarettes_daily integer

The amount of cigarettes the client smokes a day.
smoker_since string(date)

The date of when the client started smoking.
long_term_care_needed boolean

Whether the client required long term care.
long_term_care_notes string

Notes on the client's long term care.
has_will boolean

Whether the client has a will or not.
will_notes string

Notes on the client's will.
will_last_reviewed string(date)

The date of the last time the will's been reviewed.
has_power_of_attorney boolean

Whether the client has power of attorney.
power_of_attorney_notes string

Notes on the client's power of attorney.
first_contact_date string(date)

The date of the first contact.
units_of_alcohol_weekly integer

The units of alcohol digested weekly.
height integer

The height of the client in centimeters.
weight integer

The weight of the client in pounds.
health_notes string

Notes on the client's health.
has_iht_planning boolean

Whether the client has Inheritance Tax (IHT) planning or not.
iht_planning_notes string

Notes on the client's Inheritance Tax (IHT) planning.
has_gifted_family boolean

Whether the client has gifted the family.
gift_notes string

Notes on the gifts.
is_anticipating_inheritance boolean

Whether the client is anticipating/ expecting any inheritance.
anticipating_inheritance_notes string

Notes on the client's inheritance anticipation/ expectations.
next_review_date string(date)

Date of next review
previous_review_date string(date)

Date of previous review
anniversary_review_date string(date)

Anniversary review date
is_will_accurate boolean

Does your current will reflect your wishes?
will_executors string

Who are the executors?
will_location string

Where is the will stored?
will_bequests_detail string

Details of any Bequests
is_poa_registered_epa_or_lpa string

Is the Power of Attorney Registered as a EPA or LPA
are_poa_appointed_for_health_or_wealth string

Are the Attorneys appointed for Health, Wealth or Both?
poa_attorney_appointed_at string(date)

When were the Attorney’s appointed?
will_poa_details string

Who are the Attorney’s?
are_poa_documents_registered boolean

Are the documents registered?
will_gifts_details string

Notes of gifts
groups array

Group UUIDs to sync client to.
is_in_receipt_of_your_state_pension boolean

Are you in receipt of your State Pension
has_obtained_a_forecast boolean

Have you recently obtained a forecast
date_of_forecast string(date)

What is the date of the obtained forecast
projected_state_pension integer

What is the projected State Pension
years_of_national_insurance_contributions integer

How many years have you made Nation Insurance Contributions
pension_notes string

Notes on the pension
status_uuid string(uuid)

The status of the client.
current_life_stage_uuid string(uuid)

The clients current life stage for expenditure. Defaults to first available to firm if not provided.
date_of_marriage string(date)

Date of marriage
is_deceased boolean

Denotes if the client is deceased
deceased_at string(date)

Date of death
is_married_to_partner boolean

Denotes if the client is married to their partner
checked_sanctions_at string(date)

Date the client was checked for sanctions
lead_source string

Marks the lead source of the client
write_to_whom string

Marks the name of the client to write to
passport_number string

The passport number of the client
do_not_contact_via_fax boolean

Denotes if the client can be contacted via fax
do_not_contact_via_mail boolean

Denotes if the client can be contacted via mail
do_not_contact_via_sms boolean

Denotes if the client can be contacted via SMS
do_not_contact_via_email boolean

Denotes if the client can be contacted via email
do_not_contact_via_telephone boolean

Denotes if the client can be contacted via telephone
do_not_visit boolean

Denotes if the client can be visited
do_not_market boolean

Denotes if the client can be marketed to
inactive_at string(date)

Inactive from date
circles array[object]

Circles to associate the client to on creation with a login access level that controls what the client would see if they have a login.
Hide circles attributes Show circles attributes object
- uuid string(uuid)
  
  uuid of the circle
- login_access_level string
  
  Login Access level
  
  Value Description
  
  read Read
  
  write Write
  
  Values are read or write.
business_unit string(uuid) | null

UUID of the business unit to associate this account to

Value	Description
homeowner	Homeowner
renting	Renting
living_with_parents	Living With Parents
other	Other

Value	Description
male	male
female	female
non-binary	non-binary
transgender	transgender
intersex	intersex
other	other
unknown	unknown

Value	Description
read	Read
write	Write

external_reference

object

Show external_reference attributes object

third_party

string Required

The third party that the reference is from.

Value	Description
adviser_office	Adviser Office
aj_bell	Aj Bell
be_iq_organisation	Be Iq Organisation
cash_calc	Cash Calc
conquest	Conquest
filehaven	Filehaven
finio	Finio
fundment	Fundment
intelliflo_office	Intelliflo Office
nucleus	Nucleus
octopus_money	Octopus Money
p1	P1
parmenion	Parmenion
seccl	Seccl
smartsearch	Smartsearch
soderberg	Soderberg
transact_remuneration	Transact Remuneration

Values are adviser_office, aj_bell, be_iq_organisation, cash_calc, conquest, filehaven, finio, fundment, intelliflo_office, nucleus, octopus_money, p1, parmenion, seccl, smartsearch, soderberg, or transact_remuneration.

reference string Required

The reference value.

owners array[string(uuid)]

Array of client account UUIDs that are owners
shareholders array[object]

Array of shareholders details
Hide shareholders attributes Show shareholders attributes object
- full_name string
  
  The shareholder's full name.
- role string
  
  The shareholder's role.
- appointed_at string(date)
  
  Date the shareholder was appointed
- address object
  
  Shareholder's address
  Hide address attributes Show address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
- percentage integer
  
  Shareholder's percentage
- shares_owned integer
  
  Shareholder's amount of shares owned
- voting_rights string
  
  The shareholder's voting rights.
incomes array[object]

Array of incomes
Hide incomes attributes Show incomes attributes object
- name string
  
  The income's name.
- type string
  
  The income's type.
- amount integer
  
  The amount of the income
- amount_type string
  
  The income's type (net/gross).
- start_date string(date)
  
  Date the income started
- end_date string(date)
  
  Date the income ended
- frequency string
  
  The income's frequency.
- is_taxable boolean
  
  Denotes if the income is taxable
business_details object Required

Business details
Hide business_details attributes Show business_details attributes object
- status string
  
  The status of the business.
- status_comments string
  
  The comments related to the status of the business.
- type string
  
  The type of business.
- type_comments string
  
  The type of business.
- incorporated_on string(date)
  
  The Date the business was incorporated on
- business_registered_address object
  
  the business registered address details
  Hide business_registered_address attributes Show business_registered_address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
- nature string
  
  The nature of the business
- uk_sic_code string
  
  The uk SIC code of the business
- companies_house_number string
  
  The companies house number of the business
- legal_entity_identifier string
  
  The Legal Entity Identifier (LEI) of the business
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^[a-zA-Z0-9]{18}[0-9]{2}$.
- year_end_day integer
  
  The day of the month the business uses for their year end date
- year_end_month integer
  
  The month the business uses for their year end date
- firm_website string
  
  The website of the business
- employee_count integer
  
  The number of employees the business has
- self_employed_staff_count integer
  
  The number of self employed staff the business has
- business_value integer
  
  The value of the business
- is_registered_vat boolean
  
  Denotes if the business is registered for VAT
- vat_number string
  
  The VAT number of the business
- accountant_company string
  
  The name of the accounting firm used by the business
- accountant_name string
  
  The name of the accountant used by the business
- business_accountant_address object
  
  The accountant's address details
  Hide business_accountant_address attributes Show business_accountant_address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
- legal_adviser_name string
  
  The name of the legal adviser used by the business
- business_legal_adviser_address object
  
  The legal adviser's address details
  Hide business_legal_adviser_address attributes Show business_legal_adviser_address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
- auditor_name string
  
  The name of the auditor used by the business
- business_auditor_address object
  
  The auditor's address details
  Hide business_auditor_address attributes Show business_auditor_address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
- data_protection_officer string
  
  The name of the data protection officer used by the business
- primary_contacts array[object]
  
  Array of the business's primary contacts
  Hide primary_contacts attributes Show primary_contacts attributes object
  
  uuid string(uuid)
  
  The uuid of the primary contact.
  
  name string
  
  Name of the primary contact
  
  email string
  
  Email of the primary contact
  
  address object
  
  The primary contact's address details
  
  Hide address attributes Show address attributes object
  
  name string
  
  Name of the address
  
  address_1 string
  
  First line of the address
  
  address_2 string
  
  Second line of the address
  
  address_3 string
  
  Third line of the address
  
  address_4 string
  
  Fourth line of the address
  
  town_city string
  
  Town/City
  
  county string
  
  County
trust_details object

Trust details
Hide trust_details attributes Show trust_details attributes object
- unique_trust_reference string | null
  
  The HMRC-issued Unique Trust Reference (UTR) for the trust
  
  Maximum length is 50.
- unique_charity_reference string | null
  
  The Charity Commission Unique Charity Reference for trusts of type Charity
  
  Maximum length is 50.
- legal_entity_identifier string | null
  
  The Legal Entity Identifier (LEI) of the trust
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^[a-zA-Z0-9]{18}[0-9]{2}$.

Employee route for Create an account

type string Required

The type of the account being created. For creating an employee, this type must be employee.
role string Required

The role of the account being created. For creating an employee, the available roles are: owner, admin and member
first_name string Required

The first name of the employee.
last_name string Required

The last name of the employee.
email string

Email address
send_welcome_email boolean Required

Send an email on account creation and create a login
phone string

Phone number
address object
Hide address attributes Show address attributes object
- name string
  
  Name of the address
- address_1 string
  
  First line of the address
- address_2 string
  
  Second line of the address
- address_3 string
  
  Third line of the address
- address_4 string
  
  Fourth line of the address
- town_city string
  
  Town/City
- county string
  
  County
- postcode string
  
  Postcode
- country string
  
  Country
- move_in_date string
  
  Move in date
- moved_in_month integer
  
  The month the client moved into this address.
- moved_in_year integer
  
  The year the client moved into this address.
- moved_out_month integer
  
  The month the client moved out of this address.
- moved_out_year integer
  
  The year the client moved out of this address.
- residential_status string
  
  The client's residential status when living at the address.
  
  Value Description
  
  homeowner Homeowner
  
  renting Renting
  
  living_with_parents Living With Parents
  
  other Other
  
  Values are homeowner, renting, living_with_parents, or other.
- residential_status_other string
  
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
assigned_adviser_uuid string(uuid)

e3da997f-4075-4503-a67c-d978cb6155be
departments array Required

The departments the employee is part of
groups array

Group uuids belonging to the firm.
adviser_split_uuid string(uuid)

The uuid of the the adviser split that will be applied when this adviser adds charges
advice_type string

Employee's RMAR advice type
next_review_date string(date)

Date of next review
previous_review_date string(date)

Date of previous review
anniversary_review_date string(date)

Anniversary review date
meeting_booking_url string

Employee's meeting booking URL
inactive_at string(date)

Inactive from date
business_unit string(uuid) | null

UUID of the business unit to associate this account to

Value	Description
homeowner	Homeowner
renting	Renting
living_with_parents	Living With Parents
other	Other

Introducer route for Create an account

type string Required

The type of the account being created. For creating an introducer, this type must be introducer.
role string Required

The role of the account being created. For creating an introducer, this role must be introducer.
title string

Title
first_name string Required

First name
last_name string Required

Last name
entity_name string Required

Entity/business name
email string

Email address
send_welcome_email boolean

Send an email on account creation and create a login
phone string

Phone number
address object
Hide address attributes Show address attributes object
- name string
  
  Name of the address
- address_1 string
  
  First line of the address
- address_2 string
  
  Second line of the address
- address_3 string
  
  Third line of the address
- address_4 string
  
  Fourth line of the address
- town_city string
  
  Town/City
- county string
  
  County
- postcode string
  
  Postcode
- country string
  
  Country
- move_in_date string
  
  Move in date
- moved_in_month integer
  
  The month the client moved into this address.
- moved_in_year integer
  
  The year the client moved into this address.
- moved_out_month integer
  
  The month the client moved out of this address.
- moved_out_year integer
  
  The year the client moved out of this address.
- residential_status string
  
  The client's residential status when living at the address.
  
  Value Description
  
  homeowner Homeowner
  
  renting Renting
  
  living_with_parents Living With Parents
  
  other Other
  
  Values are homeowner, renting, living_with_parents, or other.
- residential_status_other string
  
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
assigned_adviser_uuid string(uuid)

UUID of the account that this account reports to
groups array

Group uuids belonging to the firm.
charge_split_schema_uuid string(uuid)

Charge split schema that is always used when adding a charge split for this introducer
business_unit string(uuid) | null

UUID of the business unit to associate this account to
next_review_date string(date)

Date of next review
previous_review_date string(date)

Date of previous review
anniversary_review_date string(date)

Anniversary review date
inactive_at string(date)

Inactive from date

Value	Description
homeowner	Homeowner
renting	Renting
living_with_parents	Living With Parents
other	Other

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  Account type
- role string
  
  Account role
- first_name string
  
  First name
- last_name string
  
  Last name
- name string
  
  Name
- email string
  
  (Deprecated - Please use primary_email instead). The email of the account.
- photo_url string
  
  URL for initial avatar image
- firm object
  
  Firm
  
  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
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  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 string
  
  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
  
  Primary phone number
  
  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 string
- primary_email object
  
  Primary email
  
  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 string
- current_time_entry object
  
  Current time entry
  
  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 string
  
  start_date string
  
  end_date string
  
  is_active boolean
  
  total_time_in_minutes integer
  
  computed_time_elapsed_in_seconds integer
  
  account string
- assigned_adviser object
  
  Assigned adviser
  
  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 string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- assigned_administrator object
  
  Assigned administrator
  
  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 string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- assigned_paraplanner object
  
  Assigned paraplanner
  
  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 string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- introduced_by object
  
  Introduced by
  
  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 string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- business_unit object
  
  The business unit this account belongs to
  
  Hide business_unit attributes Show business_unit attributes object
  
  uuid string
  
  name string
  
  has_alternative_branding boolean
  
  brand_colours array
  
  members_count integer
  
  members string
  
  groups_count integer
  
  groups string
  
  firm string
  
  created_at string
  
  updated_at string
- groups array[object]
  
  Groups
  
  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]
  
  Tags
  
  Hide tags attributes Show tags attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string
- owners array[object]
  
  Accounts that own this account
  
  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 string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- first_contact_date string
  
  First contact date
- next_review_date string
  
  Next review date
- previous_review_date string
  
  Previous review date
- anniversary_review_date string
  
  Anniversary review date
- with_login boolean
  
  Denotes whether the account has a login to Plannr
- has_joint_account boolean
  
  Denotes whether this account belongs to a joint account too
- can_be_deleted string
  
  Denotes if the account can be deleted
- joint_account_circle object
  
  This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.
  
  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
  
  accounts string
  
  groups string
  
  joint_account_uuid string
  
  login_access_level string
  
  current_life_stage_uuid string
  
  external_references string
- circles array[object]
  
  The circles the account belongs to
  
  Hide circles attributes Show circles attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  accounts string
  
  groups string
  
  joint_account_uuid string
  
  login_access_level string
  
  current_life_stage_uuid string
  
  external_references string
- ownership_percentage integer
  
  Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
- inactive_at string
  
  Inactive from date
- last_interaction_at string
  
  Last interaction date
- referral_code string
  
  Unique referral code for the employee account (employees only)
- permissions object
  
  Permission map where keys are permission names and values are target arrays
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
- custom_fields array[object]
  
  Any custom fields on the model.
  
  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]
  
  The external references that have been added to the client.
  
  Hide external_references attributes Show external_references attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  third_party string
  
  reference string

POST /api/v1/account

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/account' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"client","role":"individual","title":"Mr","first_name":"Gareth","middle_name":"Alex","last_name":"Thompson","maiden_name":"Thompson","email":"gareth@codepotato.co.uk","send_welcome_email":true,"phone":"443330509960","address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2024-06-20","moved_in_month":6,"moved_in_year":2022,"moved_out_month":1,"moved_out_year":2024,"residential_status":"homeowner","residential_status_other":"Non-tenant occupier"},"assigned_adviser_uuid":"fd8c3c6d-ff3b-4140-be52-8635469d9e98","assigned_administrator_uuid":"4ef25c49-fd13-4021-8874-b3a16fc98e77","assigned_paraplanner_uuid":"2cdf3f9c-45cb-4371-aebc-3fe4d81ad1b0","introduced_by_uuid":"c5b4821e-40ce-4f4e-a029-4d4e615b6b34","date_of_birth":"1976-05-14","gender":"male","ni_number":"AB 12 34 56 C","nickname":"G","target_retirement_age":60,"pronouns":"he/him","smoker_status":"non-smoker","last_used_nicotine_products_date":"2025-05-14","residential_status":"settled","country_of_residence":"United Kingdom","marital_status":"married","is_vulnerable":"possibly","is_prospect":false,"prospect_converted_at":"2026-05-14T12:37:51+01:00","value":500000,"is_uk_resident":true,"is_uk_domicile":true,"expected_retirement_age":60,"state_retirement_age":60,"nationalities":["British","Romanian"],"vulnerability_details":"No vulnerabilities","third_party_offered":true,"procedure_adaptation":true,"adaption_details_notes":true,"client_preferences":"Prefers telephone calls in the morning.","current_state_of_health":"Fit and healthy","state_of_health_explanation":"Explanation of the current state of health.","cigarettes_daily":6,"smoker_since":"2016-05-14","long_term_care_needed":false,"long_term_care_notes":"Notes on the client's long term care.","has_will":false,"will_notes":"Notes on the client's will.","will_last_reviewed":"2026-05-13","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2026-04-14","units_of_alcohol_weekly":28,"height":186,"weight":220,"health_notes":"Notes on the client's health.","has_iht_planning":true,"iht_planning_notes":"Notes on the client's Inheritance Tax (IHT) planning.","has_gifted_family":true,"gift_notes":"Notes on the gifts.","is_anticipating_inheritance":true,"anticipating_inheritance_notes":"Notes on the client's inheritance anticipation/ expectations.","next_review_date":"2026-06-14","previous_review_date":"2026-04-14","anniversary_review_date":"2026-05-14","is_will_accurate":true,"will_executors":"string","will_location":"string","will_bequests_detail":"string","is_poa_registered_epa_or_lpa":"epa","are_poa_appointed_for_health_or_wealth":"health","poa_attorney_appointed_at":"2026-05-14T00:00:00+01:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["eab880d5-602e-4504-a965-0b4fa0168978","fb3f1a1b-4e72-4888-ac7b-5290a53f314e"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2026-05-14T12:37:51+01:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"abc02854-4157-4b82-8217-f4b6f6eaf643","current_life_stage_uuid":"e14bb1ba-f978-4f31-8fc7-b43e78f34967","date_of_marriage":"2026-05-14","is_deceased":false,"deceased_at":"2026-05-14","is_married_to_partner":true,"checked_sanctions_at":"2026-05-14","lead_source":"LeadGen Company","write_to_whom":"Gareth","passport_number":"123456","do_not_contact_via_fax":false,"do_not_contact_via_mail":false,"do_not_contact_via_sms":false,"do_not_contact_via_email":false,"do_not_contact_via_telephone":false,"do_not_visit":false,"do_not_market":false,"inactive_at":"2026-05-14","circles":[{"uuid":"0f7fb4cd-2c40-439b-8b81-533099765533","login_access_level":"read"}],"business_unit":"1dc02b16-e712-4113-b99f-5a2075b4076b","external_reference":{"third_party":"adviser_office","reference":"AB123456"},"owners":["714dca1b-a690-4030-8648-46cd50f2688c","5efcc64e-00e1-4680-9cf2-9d7a85936d9b","cd729996-5d85-4aff-bdbd-0a610794b074"],"shareholders":[{"full_name":"John Smith","role":"Director","appointed_at":"2026-05-14","address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"percentage":60,"shares_owned":20,"voting_rights":"Right to appoint or remove directors"}],"incomes":[{"name":"State Pension","type":"pension","amount":20000,"amount_type":"net","start_date":"2026-05-14","end_date":"2026-05-14","frequency":"monthly","is_taxable":false}],"business_details":{"status":"Insolvent","status_comments":"This was due to an accounting error","type":"Public Limited Company","type_comments":"They became a Public Limited Company after May 2025","incorporated_on":"2026-05-14","business_registered_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"nature":"Construction","uk_sic_code":"12345","companies_house_number":"OC999999","legal_entity_identifier":"213800XQH3M93XJ27N32","year_end_day":11,"year_end_month":7,"firm_website":"www.google.com","employee_count":30,"self_employed_staff_count":30,"business_value":45000000,"is_registered_vat":false,"vat_number":"12345","accountant_company":"Accurate Accounting","accountant_name":"Andy Accountant","business_accountant_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"legal_adviser_name":"Lenny Legal","business_legal_adviser_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"auditor_name":"Andy Audit","business_auditor_address":{"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire"},"data_protection_officer":"Dave Data","primary_contacts":[]},"trust_details":{"unique_trust_reference":"XVTRUST80725028","unique_charity_reference":"1234567","legal_entity_identifier":"213800XQH3M93XJ27N32"}}'

Request examples

{
  "type": "client",
  "role": "individual",
  "title": "Mr",
  "first_name": "Gareth",
  "middle_name": "Alex",
  "last_name": "Thompson",
  "maiden_name": "Thompson",
  "email": "gareth@codepotato.co.uk",
  "send_welcome_email": true,
  "phone": "443330509960",
  "address": {
    "name": "Work Address",
    "address_1": "Suite E",
    "address_2": "5 The Briars",
    "address_3": "Waterberry Drive",
    "address_4": "The Innovative Centre",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "move_in_date": "2024-06-20",
    "moved_in_month": 6,
    "moved_in_year": 2022,
    "moved_out_month": 1,
    "moved_out_year": 2024,
    "residential_status": "homeowner",
    "residential_status_other": "Non-tenant occupier"
  },
  "assigned_adviser_uuid": "fd8c3c6d-ff3b-4140-be52-8635469d9e98",
  "assigned_administrator_uuid": "4ef25c49-fd13-4021-8874-b3a16fc98e77",
  "assigned_paraplanner_uuid": "2cdf3f9c-45cb-4371-aebc-3fe4d81ad1b0",
  "introduced_by_uuid": "c5b4821e-40ce-4f4e-a029-4d4e615b6b34",
  "date_of_birth": "1976-05-14",
  "gender": "male",
  "ni_number": "AB 12 34 56 C",
  "nickname": "G",
  "target_retirement_age": 60,
  "pronouns": "he/him",
  "smoker_status": "non-smoker",
  "last_used_nicotine_products_date": "2025-05-14",
  "residential_status": "settled",
  "country_of_residence": "United Kingdom",
  "marital_status": "married",
  "is_vulnerable": "possibly",
  "is_prospect": false,
  "prospect_converted_at": "2026-05-14T12:37:51+01:00",
  "value": 500000,
  "is_uk_resident": true,
  "is_uk_domicile": true,
  "expected_retirement_age": 60,
  "state_retirement_age": 60,
  "nationalities": [
    "British",
    "Romanian"
  ],
  "vulnerability_details": "No vulnerabilities",
  "third_party_offered": true,
  "procedure_adaptation": true,
  "adaption_details_notes": true,
  "client_preferences": "Prefers telephone calls in the morning.",
  "current_state_of_health": "Fit and healthy",
  "state_of_health_explanation": "Explanation of the current state of health.",
  "cigarettes_daily": 6,
  "smoker_since": "2016-05-14",
  "long_term_care_needed": false,
  "long_term_care_notes": "Notes on the client's long term care.",
  "has_will": false,
  "will_notes": "Notes on the client's will.",
  "will_last_reviewed": "2026-05-13",
  "has_power_of_attorney": true,
  "power_of_attorney_notes": "Notes on the client's power of attorney.",
  "first_contact_date": "2026-04-14",
  "units_of_alcohol_weekly": 28,
  "height": 186,
  "weight": 220,
  "health_notes": "Notes on the client's health.",
  "has_iht_planning": true,
  "iht_planning_notes": "Notes on the client's Inheritance Tax (IHT) planning.",
  "has_gifted_family": true,
  "gift_notes": "Notes on the gifts.",
  "is_anticipating_inheritance": true,
  "anticipating_inheritance_notes": "Notes on the client's inheritance anticipation/ expectations.",
  "next_review_date": "2026-06-14",
  "previous_review_date": "2026-04-14",
  "anniversary_review_date": "2026-05-14",
  "is_will_accurate": true,
  "will_executors": "string",
  "will_location": "string",
  "will_bequests_detail": "string",
  "is_poa_registered_epa_or_lpa": "epa",
  "are_poa_appointed_for_health_or_wealth": "health",
  "poa_attorney_appointed_at": "2026-05-14T00:00:00+01:00",
  "will_poa_details": "string",
  "are_poa_documents_registered": true,
  "will_gifts_details": "string",
  "groups": [
    "eab880d5-602e-4504-a965-0b4fa0168978",
    "fb3f1a1b-4e72-4888-ac7b-5290a53f314e"
  ],
  "is_in_receipt_of_your_state_pension": true,
  "has_obtained_a_forecast": true,
  "date_of_forecast": "2026-05-14T12:37:51+01:00",
  "projected_state_pension": 50000,
  "years_of_national_insurance_contributions": 5,
  "pension_notes": "string",
  "status_uuid": "abc02854-4157-4b82-8217-f4b6f6eaf643",
  "current_life_stage_uuid": "e14bb1ba-f978-4f31-8fc7-b43e78f34967",
  "date_of_marriage": "2026-05-14",
  "is_deceased": false,
  "deceased_at": "2026-05-14",
  "is_married_to_partner": true,
  "checked_sanctions_at": "2026-05-14",
  "lead_source": "LeadGen Company",
  "write_to_whom": "Gareth",
  "passport_number": "123456",
  "do_not_contact_via_fax": false,
  "do_not_contact_via_mail": false,
  "do_not_contact_via_sms": false,
  "do_not_contact_via_email": false,
  "do_not_contact_via_telephone": false,
  "do_not_visit": false,
  "do_not_market": false,
  "inactive_at": "2026-05-14",
  "circles": [
    {
      "uuid": "0f7fb4cd-2c40-439b-8b81-533099765533",
      "login_access_level": "read"
    }
  ],
  "business_unit": "1dc02b16-e712-4113-b99f-5a2075b4076b",
  "external_reference": {
    "third_party": "adviser_office",
    "reference": "AB123456"
  },
  "owners": [
    "714dca1b-a690-4030-8648-46cd50f2688c",
    "5efcc64e-00e1-4680-9cf2-9d7a85936d9b",
    "cd729996-5d85-4aff-bdbd-0a610794b074"
  ],
  "shareholders": [
    {
      "full_name": "John Smith",
      "role": "Director",
      "appointed_at": "2026-05-14",
      "address": {
        "name": "Work Address",
        "address_1": "Suite E",
        "address_2": "5 The Briars",
        "address_3": "Waterberry Drive",
        "address_4": "The Innovative Centre",
        "town_city": "Waterlooville",
        "county": "Hampshire"
      },
      "percentage": 60,
      "shares_owned": 20,
      "voting_rights": "Right to appoint or remove directors"
    }
  ],
  "incomes": [
    {
      "name": "State Pension",
      "type": "pension",
      "amount": 20000,
      "amount_type": "net",
      "start_date": "2026-05-14",
      "end_date": "2026-05-14",
      "frequency": "monthly",
      "is_taxable": false
    }
  ],
  "business_details": {
    "status": "Insolvent",
    "status_comments": "This was due to an accounting error",
    "type": "Public Limited Company",
    "type_comments": "They became a Public Limited Company after May 2025",
    "incorporated_on": "2026-05-14",
    "business_registered_address": {
      "name": "Work Address",
      "address_1": "Suite E",
      "address_2": "5 The Briars",
      "address_3": "Waterberry Drive",
      "address_4": "The Innovative Centre",
      "town_city": "Waterlooville",
      "county": "Hampshire"
    },
    "nature": "Construction",
    "uk_sic_code": "12345",
    "companies_house_number": "OC999999",
    "legal_entity_identifier": "213800XQH3M93XJ27N32",
    "year_end_day": 11,
    "year_end_month": 7,
    "firm_website": "www.google.com",
    "employee_count": 30,
    "self_employed_staff_count": 30,
    "business_value": 45000000,
    "is_registered_vat": false,
    "vat_number": "12345",
    "accountant_company": "Accurate Accounting",
    "accountant_name": "Andy Accountant",
    "business_accountant_address": {
      "name": "Work Address",
      "address_1": "Suite E",
      "address_2": "5 The Briars",
      "address_3": "Waterberry Drive",
      "address_4": "The Innovative Centre",
      "town_city": "Waterlooville",
      "county": "Hampshire"
    },
    "legal_adviser_name": "Lenny Legal",
    "business_legal_adviser_address": {
      "name": "Work Address",
      "address_1": "Suite E",
      "address_2": "5 The Briars",
      "address_3": "Waterberry Drive",
      "address_4": "The Innovative Centre",
      "town_city": "Waterlooville",
      "county": "Hampshire"
    },
    "auditor_name": "Andy Audit",
    "business_auditor_address": {
      "name": "Work Address",
      "address_1": "Suite E",
      "address_2": "5 The Briars",
      "address_3": "Waterberry Drive",
      "address_4": "The Innovative Centre",
      "town_city": "Waterlooville",
      "county": "Hampshire"
    },
    "data_protection_officer": "Dave Data",
    "primary_contacts": []
  },
  "trust_details": {
    "unique_trust_reference": "XVTRUST80725028",
    "unique_charity_reference": "1234567",
    "legal_entity_identifier": "213800XQH3M93XJ27N32"
  }
}

{
  "type": "employee",
  "role": "member",
  "first_name": "Gareth",
  "last_name": "Thompson",
  "email": "gareth@codepotato.co.uk",
  "send_welcome_email": true,
  "phone": "443330509960",
  "address": {
    "name": "Work Address",
    "address_1": "Suite E",
    "address_2": "5 The Briars",
    "address_3": "Waterberry Drive",
    "address_4": "The Innovative Centre",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "move_in_date": "2024-06-20",
    "moved_in_month": 6,
    "moved_in_year": 2022,
    "moved_out_month": 1,
    "moved_out_year": 2024,
    "residential_status": "homeowner",
    "residential_status_other": "Non-tenant occupier"
  },
  "assigned_adviser_uuid": "236dd84c-2089-4279-985e-123f4e37672d",
  "departments": [
    "paraplanner",
    "adviser"
  ],
  "groups": [
    "64260ac5-6370-466e-9086-7146da161790",
    "b143561c-7968-4e82-b268-8bb6b9159adf"
  ],
  "adviser_split_uuid": "6a029dd1-609a-4e9e-8844-4770912a4067",
  "advice_type": "independent",
  "next_review_date": "2026-06-14",
  "previous_review_date": "2026-04-14",
  "anniversary_review_date": "2026-05-14",
  "meeting_booking_url": "https://calendly.com/gareth-codepotato",
  "inactive_at": "2026-05-14",
  "business_unit": "5876f27a-8010-49ef-97c6-cd775177dd4c"
}

{
  "type": "introducer",
  "role": "introducer",
  "title": "Mr",
  "first_name": "Patrick",
  "last_name": "Stanton",
  "entity_name": "PatrickCo",
  "email": "gareth@codepotato.co.uk",
  "send_welcome_email": true,
  "phone": "443330509960",
  "address": {
    "name": "Work Address",
    "address_1": "Suite E",
    "address_2": "5 The Briars",
    "address_3": "Waterberry Drive",
    "address_4": "The Innovative Centre",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "move_in_date": "2024-06-20",
    "moved_in_month": 6,
    "moved_in_year": 2022,
    "moved_out_month": 1,
    "moved_out_year": 2024,
    "residential_status": "homeowner",
    "residential_status_other": "Non-tenant occupier"
  },
  "assigned_adviser_uuid": "c3d78699-c0f8-48df-ae30-8f39c58a29ec",
  "groups": [
    "552f0073-eea8-4bda-8bb3-086c75352fb9",
    "3233c0e9-11b1-476e-9a52-081a1ff01fd3"
  ],
  "charge_split_schema_uuid": "86df08f3-de26-4aa5-97e7-83e23fa6b90d",
  "business_unit": "9492cdc8-7737-4696-ba77-2b113ccaf2f3",
  "next_review_date": "2026-06-14",
  "previous_review_date": "2026-04-14",
  "anniversary_review_date": "2026-05-14",
  "inactive_at": "2026-05-14"
}

Response examples (200)

{
  "uuid": "0f59bb3c-3e38-4e58-9c41-e67ce84d7ef0",
  "created_at": "2026-05-14T12:37:52+01:00",
  "updated_at": "2026-05-14T12:37:52+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": "74213dd1-36ed-4e21-bd64-ac32202e7199",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+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"
    },
    "is_subscribed": true,
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "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": "App\\Http\\Resources\\Board\\BoardResource",
    "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": "aadfd10f-692b-4faa-bd8c-98e8d717cd99",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+01:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": "App\\Http\\Resources\\AccountResource"
  },
  "primary_email": {
    "uuid": "55b7062b-9e75-4b29-bf97-a99680b9d99e",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+01:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": "App\\Http\\Resources\\AccountResource"
  },
  "current_time_entry": {
    "uuid": "58673ff6-92f3-4fe6-b656-101472689e84",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+01:00",
    "name": "Research",
    "description": "This is a description.",
    "trackable_type": "Client",
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "start_date": "2026-05-14T11:47:52+01:00",
    "end_date": "2026-05-14T12:15:52+01:00",
    "is_active": true,
    "total_time_in_minutes": 28,
    "computed_time_elapsed_in_seconds": 1680,
    "account": "App\\Http\\Resources\\MinimalAccountResource"
  },
  "assigned_adviser": {
    "uuid": "e089be5c-064f-41a1-ae72-5f8da871040c",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+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": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-05-14T12:37:52+01:00",
    "next_review_date": "2026-05-14T12:37:52+01:00",
    "previous_review_date": "2026-05-14T12:37:52+01:00",
    "anniversary_review_date": "2026-05-14T12:37:52+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-05-14",
    "last_interaction_at": "2026-05-14 12:37:52",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "assigned_administrator": {
    "uuid": "2dfaaf19-fa28-47fc-8fff-977a9a6c08c3",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+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": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-05-14T12:37:52+01:00",
    "next_review_date": "2026-05-14T12:37:52+01:00",
    "previous_review_date": "2026-05-14T12:37:52+01:00",
    "anniversary_review_date": "2026-05-14T12:37:52+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-05-14",
    "last_interaction_at": "2026-05-14 12:37:52",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "assigned_paraplanner": {
    "uuid": "35733a9b-07b4-4d22-aa16-b668c03cdc37",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+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": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-05-14T12:37:52+01:00",
    "next_review_date": "2026-05-14T12:37:52+01:00",
    "previous_review_date": "2026-05-14T12:37:52+01:00",
    "anniversary_review_date": "2026-05-14T12:37:52+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-05-14",
    "last_interaction_at": "2026-05-14 12:37:52",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "introduced_by": {
    "uuid": "f4bb5342-df7e-4708-8754-42eeaaa803b9",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+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": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-05-14T12:37:52+01:00",
    "next_review_date": "2026-05-14T12:37:52+01:00",
    "previous_review_date": "2026-05-14T12:37:52+01:00",
    "anniversary_review_date": "2026-05-14T12:37:52+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-05-14",
    "last_interaction_at": "2026-05-14 12:37:52",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "business_unit": {
    "uuid": "abc203d4-e893-48a6-af04-b3cbd17a8b52",
    "name": "Wealth Management",
    "has_alternative_branding": false,
    "brand_colours": [],
    "members_count": 3,
    "members": "App\\Http\\Resources\\AccountResource",
    "groups_count": 2,
    "groups": "App\\Http\\Resources\\GroupResource",
    "firm": "App\\Http\\Resources\\FirmResource",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+01:00"
  },
  "groups": [
    {
      "uuid": "c3c5d6a9-ca8e-4a64-9463-850859d1733b",
      "name": "finance",
      "slug": "finance",
      "participants_count": "3",
      "participants": {
        "uuid": {
          "example": "0c9412f5-854b-4a45-98f3-b9b1bdfbfcda",
          "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-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+01:00"
    }
  ],
  "tags": [
    {
      "uuid": "74c0a694-8141-41ae-a14e-2368a433f36d",
      "created_at": "2026-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    }
  ],
  "owners": [
    {
      "uuid": "fdb33839-8f7c-4ed1-8c03-16fd8e00deea",
      "created_at": "2026-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+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": "App\\Http\\Resources\\FirmResource",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "tags": "App\\Http\\Resources\\TagResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "first_contact_date": "2026-05-14T12:37:52+01:00",
      "next_review_date": "2026-05-14T12:37:52+01:00",
      "previous_review_date": "2026-05-14T12:37:52+01:00",
      "anniversary_review_date": "2026-05-14T12:37:52+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "inactive_at": "2026-05-14",
      "last_interaction_at": "2026-05-14 12:37:52",
      "referral_code": "ABC12345",
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "first_contact_date": "2026-05-14T12:37:52+01:00",
  "next_review_date": "2026-05-14T12:37:52+01:00",
  "previous_review_date": "2026-05-14T12:37:52+01:00",
  "anniversary_review_date": "2026-05-14T12:37:52+01:00",
  "with_login": true,
  "has_joint_account": true,
  "can_be_deleted": "false",
  "joint_account_circle": {
    "uuid": "e91e4dc6-ef61-4b41-a8a4-77e1c299fc74",
    "created_at": "2026-05-14T12:37:52+01:00",
    "updated_at": "2026-05-14T12:37:52+01:00",
    "name": "Jones Family",
    "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
    "bg_colour": "#35f4e1",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "joint_account_uuid": "d21f2fe3-bed8-4bb5-9466-94f33725a69d",
    "login_access_level": "write",
    "current_life_stage_uuid": "f073aece-4313-4262-93ce-fda9d6d5019e",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "circles": [
    {
      "uuid": "e354317b-12e2-4806-b244-f61006ca0b09",
      "created_at": "2026-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+01:00",
      "name": "Jones Family",
      "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
      "bg_colour": "#35f4e1",
      "accounts": "App\\Http\\Resources\\AccountResource",
      "groups": "App\\Http\\Resources\\GroupResource",
      "joint_account_uuid": "b1aadde3-6144-4043-91f4-4d54cbab2751",
      "login_access_level": "write",
      "current_life_stage_uuid": "b62a91a9-657b-4b38-a6a8-f7dea801a042",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "ownership_percentage": 100,
  "inactive_at": "2026-05-14",
  "last_interaction_at": "2026-05-14 12:37:52",
  "referral_code": "ABC12345",
  "permissions": {
    "firm:read": [
      "firm"
    ],
    "network:read": [
      "network:uuid"
    ]
  },
  "custom_fields": [
    {
      "uuid": "b75380ca-08ce-4d7d-967f-89b1b0685627",
      "created_at": "2026-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+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": "b43846f9-75d7-4199-9bd8-516f7b1c4fee",
      "created_at": "2026-05-14T12:37:52+01:00",
      "updated_at": "2026-05-14T12:37:52+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  ]
}