Update an account

PUT /api/v1/account/{uuid}

Headers

Authorization string
Content-Type string
Accept string

Path parameters

uuid integer Required

application/json

Body

Client array[string]

Client route
Employee array[string]

Employee route
Introducer array[string]

Introducer route

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
  
  Email
- firm object
  
  Firm
- primary_phone_number object
  
  Primary phone number
- primary_email object
  
  Primary email
- current_time_entry object
  
  Current time entry
- assigned_adviser object
  
  Assigned adviser
- assigned_administrator object
  
  Assigned administrator
- assigned_paraplanner object
  
  Assigned paraplanner
- introduced_by object
  
  Introduced by
- groups array[object]
  
  Groups
- tags array[object]
  
  Tags
- owners array[object]
  
  Accounts that own this account
- 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
- custom_fields array[object]
  
  Any custom fields on the model.
- external_references array[object]
  
  The external references that have been added to the client.

PUT /api/v1/account/{uuid}

curl \
 -X PUT https://api.plannrcrm.com/api/v1/account/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"Client":[{"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"value":{"type":"integer","example":500000,"required":false,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"gender":{"type":"string","example":"Male","required":false,"description":"Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"},"groups":{"type":"array","example":["aeed7295-9a5d-4a90-a950-4c6d2b8c29fa","328e6fde-f309-4730-9c27-2820c161c71d"],"required":false,"description":"Group UUIDs to sync client to. Null can be provided to clear a clients groups."},"height":{"type":"integer","example":186,"required":false,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"required":false,"description":"The weight of the client in pounds."},"has_will":{"type":"boolean","example":true,"required":false,"description":"Whether the client has a will or not."},"nickname":{"type":"string","example":"Garth","required":false,"description":"preferred nickname of the client"},"pronouns":{"type":"string","example":"he/him","required":false,"description":"Pronouns"},"last_name":{"type":"string","example":"Thompson","required":false,"description":"Last name"},"ni_number":{"type":"string","example":"AB 12 34 56 C","required":false,"description":"National Insurance Number"},"first_name":{"type":"string","example":"Gareth","required":false,"description":"First name"},"gift_notes":{"type":"string","example":"Notes on the gifts.","required":false,"description":"Notes on the gifts."},"will_notes":{"type":"string","example":"Notes on the client's will.","required":false,"description":"Notes on the client's will."},"deceased_at":{"type":"date","example":"2024-10-16","required":false,"description":"Date of death"},"entity_name":{"type":"string","example":"Plannr Ltd","required":false,"description":"Entity name for shared account types"},"is_deceased":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is deceased"},"is_prospect":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is a prospect or not."},"lead_source":{"type":"string","example":"LeadGen Company","required":false,"description":"Marks the lead source of the client"},"maiden_name":{"type":"string","example":"Thompson","required":false,"description":"Maiden name."},"middle_name":{"type":"string","example":"Alex","required":false,"description":"Middle name."},"status_uuid":{"type":"string","example":"1f0f481b-db0b-4d93-a9eb-20c3ea0b29ee","required":false,"description":"The status of the client."},"do_not_visit":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be visited"},"health_notes":{"type":"string","example":"Notes on the client's health.","required":false,"description":"Notes on the client's health."},"smoker_since":{"type":"date","example":"2014-10-16","required":false,"description":"The date of when the client started smoking."},"date_of_birth":{"type":"date","example":"1974-10-16","required":false,"description":"Date of birth"},"do_not_market":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be visited"},"is_vulnerable":{"type":"string","example":"possibly","required":false,"description":"whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\""},"nationalities":{"type":"array","example":["British","Romanian"],"required":false,"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"pension_notes":{"type":"string","example":"","required":false,"description":"Notes on the pension"},"smoker_status":{"type":"string","example":"non-smoker","required":false,"description":"Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"},"will_location":{"type":"string","example":"","required":false,"description":"Where is the will stored?"},"write_to_whom":{"type":"string","example":"Gareth","required":false,"description":"Marks the name of the client to write to"},"is_uk_domicile":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK domicile or not."},"is_uk_resident":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK resident or not."},"marital_status":{"type":"string","example":"married","required":false,"description":"Marital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"},"will_executors":{"type":"string","example":"","required":false,"description":"Who are the executors?"},"passport_number":{"type":"string","example":"123456","required":false,"description":"The passport number of the client"},"cigarettes_daily":{"type":"integer","example":6,"required":false,"description":"The amount of cigarettes the client smokes a day."},"date_of_forecast":{"type":"date","example":"2024-10-16T11:10:13+01:00","required":false,"description":"What is the date of the obtained forecast"},"date_of_marriage":{"type":"date","example":"2024-10-16","required":false,"description":"Date of marriage"},"has_iht_planning":{"type":"boolean","example":true,"required":false,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"is_will_accurate":{"type":"boolean","example":true,"required":false,"description":"Does your current will reflect your wishes?"},"next_review_date":{"type":"date","example":"2024-11-16","required":false,"description":"Date of next review"},"will_poa_details":{"type":"string","example":"","required":false,"description":"Who are the Attorney’s?"},"has_gifted_family":{"type":"boolean","example":true,"required":false,"description":"Whether the client has gifted the family."},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","required":false,"description":"Any client preferences."},"first_contact_date":{"type":"date","example":"2024-09-16","required":false,"description":"The date of the first contact."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","required":false,"description":"Notes on the client's Inheritance Tax (IHT) planning."},"introduced_by_uuid":{"type":"string","example":"6475c54d-3303-4c36-baed-ce57b1d2f680","required":false,"description":"The UUID of the introducer for this client"},"residential_status":{"type":"string","example":"settled","required":false,"description":"Residential status"},"will_gifts_details":{"type":"string","example":"","required":false,"description":"Notes of gifts"},"will_last_reviewed":{"type":"date","example":"2024-10-16","required":false,"description":"The date of the last time the will's been reviewed."},"third_party_offered":{"type":"boolean","example":true,"required":false,"description":"Whether the client has been offered any third party."},"checked_sanctions_at":{"type":"date","example":"2024-10-16","required":false,"description":"Date the client was checked for sanctions"},"country_of_residence":{"type":"string","example":"United Kingdom","required":false,"description":"Country of residence"},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","required":false,"description":"Notes on the client's long term care."},"previous_review_date":{"type":"date","example":"2024-09-16","required":false,"description":"Date of previous review"},"procedure_adaptation":{"type":"boolean","example":false,"required":false,"description":"Whether any procedures need to be adapted to the client."},"state_retirement_age":{"type":"integer","example":60,"required":false,"description":"The state retirement age."},"will_bequests_detail":{"type":"string","example":"","required":false,"description":"Details of any Bequests"},"assigned_adviser_uuid":{"type":"string","example":"64ba7023-32a1-4d51-9b70-6b5d888a667f","required":false,"description":"The UUID of the employee that the client directly reports to"},"has_power_of_attorney":{"type":"boolean","example":true,"required":false,"description":"Whether the client has power of attorney."},"is_married_to_partner":{"type":"boolean","example":true,"required":false,"description":"Denotes if the client is married to their partner"},"long_term_care_needed":{"type":"boolean","example":false,"required":false,"description":"Whether the client required long term care."},"prospect_converted_at":{"type":"date","example":"2024-10-16T11:10:13+01:00","required":false,"description":"The datetime when the prospect was converted into a client."},"target_retirement_age":{"type":"integer","example":60,"required":false,"description":"Targest retirement age."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","required":false,"description":"Any details regarding the client's vulnerabilities."},"adaption_details_notes":{"type":"boolean","example":"Adaptation notes","required":false,"description":"Any notes regarding adaptations"},"do_not_contact_via_fax":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_sms":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via SMS"},"anniversary_review_date":{"type":"date","example":"2024-10-16","required":false,"description":"Anniversary review date"},"current_state_of_health":{"type":"string","example":"Fit and healthy","required":false,"description":"The client's current state of health."},"do_not_contact_via_mail":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via mail"},"expected_retirement_age":{"type":"integer","example":60,"required":false,"description":"The expected retirement age."},"has_obtained_a_forecast":{"type":"boolean","example":true,"required":false,"description":"Have you recently obtained a forecast"},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","required":false,"description":"Notes on the client's power of attorney."},"projected_state_pension":{"type":"integer","example":50000,"required":false,"description":"What is the projected State Pension"},"units_of_alcohol_weekly":{"type":"integer","example":28,"required":false,"description":"The units of alcohol digested weekly."},"do_not_contact_via_email":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via email"},"assigned_paraplanner_uuid":{"type":"string","example":"e77cd881-38b2-4236-b8af-380178bd71b9","required":false,"description":"The UUID of the paraplanner employee that the client has been assigned"},"poa_attorney_appointed_at":{"type":"date","example":"2024-10-16T00:00:00+01:00","required":false,"description":"When were the Attorney’s appointed?"},"assigned_administrator_uuid":{"type":"string","example":"2a24b762-cf07-463b-92e4-0b749bbee29d","required":false,"description":"The UUID of the adviser employee that the client has been assigned"},"is_anticipating_inheritance":{"type":"boolean","example":true,"required":false,"description":"Whether the client is anticipating/ expecting any inheritance."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","required":false,"description":"Explanation of the current state of health."},"are_poa_documents_registered":{"type":"boolean","example":true,"required":false,"description":"Are the documents registered?"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via telephone"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","required":false,"description":"Is the Power of Attorney Registered as a EPA or LPA"},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","required":false,"description":"Notes on the client's inheritance anticipation/ expectations."},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"required":false,"description":"Are you in receipt of your State Pension"},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","required":false,"description":"Are the Attorneys appointed for Health, Wealth or Both?"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"required":false,"description":"How many years have you made Nation Insurance Contributions"}}],"Employee":[{"role":{"type":"string","example":"owner","required":false,"description":"The role of the employee."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","required":false,"description":"The email of the employee. Required when with_login is present."},"groups":{"type":"array","example":["3004ac40-16fb-474b-b7de-9134e499916e","3b509ea5-b428-4396-944d-fc277f4c825f"],"required":false,"description":"Group UUIDs to sync employee to. Null can be provided to clear an employees groups"},"last_name":{"type":"string","example":"Thompson","required":false,"description":"The last name of the employee."},"first_name":{"type":"string","example":"Gareth","required":false,"description":"The first name of the employee."},"advice_type":{"type":"string","example":"independent","required":false,"description":"Employee's RMAR advice type"},"departments":{"type":"array","example":["paraplanner","adviser"],"required":false,"description":"The departments the employee is part of"},"adviser_split_uuid":{"type":"string","example":"b94fbcc7-4d90-4020-8680-a5124d901e8f","required":false,"description":"Adviser split"},"meeting_booking_url":{"type":"string","example":"https://calendly.com/gareth-codepotato","required":false,"description":"Employee's meeting booking URL"},"assigned_adviser_uuid":{"type":"string","example":"701cfce6-5387-4a84-bf8c-0fda530e6dee","required":false,"description":"The uuid of the senior employee that the employee directly reports to"}}],"Introducer":[{"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"groups":{"type":"array","example":["577d3416-4026-4306-82fb-e207b335234e","36d46221-1513-4a2c-b0b1-231d6a7eba35"],"required":false,"description":"Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups"},"last_name":{"type":"string","example":"Stanton","required":false,"description":"Last name"},"first_name":{"type":"string","example":"Patrick","required":false,"description":"First name"},"entity_name":{"type":"string","example":"PatrickCo","required":false,"description":"Entity/business name"},"assigned_adviser_uuid":{"type":"string","example":"2147045a-4883-422e-8056-b4de8ad2a88c","required":false,"description":"UUID of the account that this account reports to"},"charge_split_schema_uuid":{"type":"string","example":"b8753fcb-bcdb-4dc3-8bb2-a8cbe008f781","required":false,"description":"Charge split schema that is always used when adding a charge split for this introducer"}}]}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "Client": [
    {
      "title": {
        "type": "string",
        "example": "Mr",
        "required": false,
        "description": "Title"
      },
      "value": {
        "type": "integer",
        "example": 500000,
        "required": false,
        "description": "The value of the client in penny format. E.g £5,000 would be 500000."
      },
      "gender": {
        "type": "string",
        "example": "Male",
        "required": false,
        "description": "Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"
      },
      "groups": {
        "type": "array",
        "example": [
          "aeed7295-9a5d-4a90-a950-4c6d2b8c29fa",
          "328e6fde-f309-4730-9c27-2820c161c71d"
        ],
        "required": false,
        "description": "Group UUIDs to sync client to. Null can be provided to clear a clients groups."
      },
      "height": {
        "type": "integer",
        "example": 186,
        "required": false,
        "description": "The height of the client in centimeters."
      },
      "weight": {
        "type": "integer",
        "example": 220,
        "required": false,
        "description": "The weight of the client in pounds."
      },
      "has_will": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client has a will or not."
      },
      "nickname": {
        "type": "string",
        "example": "Garth",
        "required": false,
        "description": "preferred nickname of the client"
      },
      "pronouns": {
        "type": "string",
        "example": "he/him",
        "required": false,
        "description": "Pronouns"
      },
      "last_name": {
        "type": "string",
        "example": "Thompson",
        "required": false,
        "description": "Last name"
      },
      "ni_number": {
        "type": "string",
        "example": "AB 12 34 56 C",
        "required": false,
        "description": "National Insurance Number"
      },
      "first_name": {
        "type": "string",
        "example": "Gareth",
        "required": false,
        "description": "First name"
      },
      "gift_notes": {
        "type": "string",
        "example": "Notes on the gifts.",
        "required": false,
        "description": "Notes on the gifts."
      },
      "will_notes": {
        "type": "string",
        "example": "Notes on the client's will.",
        "required": false,
        "description": "Notes on the client's will."
      },
      "deceased_at": {
        "type": "date",
        "example": "2024-10-16",
        "required": false,
        "description": "Date of death"
      },
      "entity_name": {
        "type": "string",
        "example": "Plannr Ltd",
        "required": false,
        "description": "Entity name for shared account types"
      },
      "is_deceased": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client is deceased"
      },
      "is_prospect": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client is a prospect or not."
      },
      "lead_source": {
        "type": "string",
        "example": "LeadGen Company",
        "required": false,
        "description": "Marks the lead source of the client"
      },
      "maiden_name": {
        "type": "string",
        "example": "Thompson",
        "required": false,
        "description": "Maiden name."
      },
      "middle_name": {
        "type": "string",
        "example": "Alex",
        "required": false,
        "description": "Middle name."
      },
      "status_uuid": {
        "type": "string",
        "example": "1f0f481b-db0b-4d93-a9eb-20c3ea0b29ee",
        "required": false,
        "description": "The status of the client."
      },
      "do_not_visit": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be visited"
      },
      "health_notes": {
        "type": "string",
        "example": "Notes on the client's health.",
        "required": false,
        "description": "Notes on the client's health."
      },
      "smoker_since": {
        "type": "date",
        "example": "2014-10-16",
        "required": false,
        "description": "The date of when the client started smoking."
      },
      "date_of_birth": {
        "type": "date",
        "example": "1974-10-16",
        "required": false,
        "description": "Date of birth"
      },
      "do_not_market": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be visited"
      },
      "is_vulnerable": {
        "type": "string",
        "example": "possibly",
        "required": false,
        "description": "whether the client is vulnerable.  Possible values are: \"yes\", \"no\", and \"possibly\""
      },
      "nationalities": {
        "type": "array",
        "example": [
          "British",
          "Romanian"
        ],
        "required": false,
        "description": "Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."
      },
      "pension_notes": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Notes on the pension"
      },
      "smoker_status": {
        "type": "string",
        "example": "non-smoker",
        "required": false,
        "description": "Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"
      },
      "will_location": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Where is the will stored?"
      },
      "write_to_whom": {
        "type": "string",
        "example": "Gareth",
        "required": false,
        "description": "Marks the name of the client to write to"
      },
      "is_uk_domicile": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client is a UK domicile or not."
      },
      "is_uk_resident": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client is a UK resident or not."
      },
      "marital_status": {
        "type": "string",
        "example": "married",
        "required": false,
        "description": "Marital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"
      },
      "will_executors": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Who are the executors?"
      },
      "passport_number": {
        "type": "string",
        "example": "123456",
        "required": false,
        "description": "The passport number of the client"
      },
      "cigarettes_daily": {
        "type": "integer",
        "example": 6,
        "required": false,
        "description": "The amount of cigarettes the client smokes a day."
      },
      "date_of_forecast": {
        "type": "date",
        "example": "2024-10-16T11:10:13+01:00",
        "required": false,
        "description": "What is the date of the obtained forecast"
      },
      "date_of_marriage": {
        "type": "date",
        "example": "2024-10-16",
        "required": false,
        "description": "Date of marriage"
      },
      "has_iht_planning": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client has Inheritance Tax (IHT) planning or not."
      },
      "is_will_accurate": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Does your current will reflect your wishes?"
      },
      "next_review_date": {
        "type": "date",
        "example": "2024-11-16",
        "required": false,
        "description": "Date of next review"
      },
      "will_poa_details": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Who are the Attorney’s?"
      },
      "has_gifted_family": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client has gifted the family."
      },
      "client_preferences": {
        "type": "string",
        "example": "Prefers telephone calls in the morning.",
        "required": false,
        "description": "Any client preferences."
      },
      "first_contact_date": {
        "type": "date",
        "example": "2024-09-16",
        "required": false,
        "description": "The date of the first contact."
      },
      "iht_planning_notes": {
        "type": "string",
        "example": "Notes on the client's Inheritance Tax (IHT) planning.",
        "required": false,
        "description": "Notes on the client's Inheritance Tax (IHT) planning."
      },
      "introduced_by_uuid": {
        "type": "string",
        "example": "6475c54d-3303-4c36-baed-ce57b1d2f680",
        "required": false,
        "description": "The UUID of the introducer for this client"
      },
      "residential_status": {
        "type": "string",
        "example": "settled",
        "required": false,
        "description": "Residential status"
      },
      "will_gifts_details": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Notes of gifts"
      },
      "will_last_reviewed": {
        "type": "date",
        "example": "2024-10-16",
        "required": false,
        "description": "The date of the last time the will's been reviewed."
      },
      "third_party_offered": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client has been offered any third party."
      },
      "checked_sanctions_at": {
        "type": "date",
        "example": "2024-10-16",
        "required": false,
        "description": "Date the client was checked for sanctions"
      },
      "country_of_residence": {
        "type": "string",
        "example": "United Kingdom",
        "required": false,
        "description": "Country of residence"
      },
      "long_term_care_notes": {
        "type": "string",
        "example": "Notes on the client's long term care.",
        "required": false,
        "description": "Notes on the client's long term care."
      },
      "previous_review_date": {
        "type": "date",
        "example": "2024-09-16",
        "required": false,
        "description": "Date of previous review"
      },
      "procedure_adaptation": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Whether any procedures need to be adapted to the client."
      },
      "state_retirement_age": {
        "type": "integer",
        "example": 60,
        "required": false,
        "description": "The state retirement age."
      },
      "will_bequests_detail": {
        "type": "string",
        "example": "",
        "required": false,
        "description": "Details of any Bequests"
      },
      "assigned_adviser_uuid": {
        "type": "string",
        "example": "64ba7023-32a1-4d51-9b70-6b5d888a667f",
        "required": false,
        "description": "The UUID of the employee that the client directly reports to"
      },
      "has_power_of_attorney": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client has power of attorney."
      },
      "is_married_to_partner": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Denotes if the client is married to their partner"
      },
      "long_term_care_needed": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Whether the client required long term care."
      },
      "prospect_converted_at": {
        "type": "date",
        "example": "2024-10-16T11:10:13+01:00",
        "required": false,
        "description": "The datetime when the prospect was converted into a client."
      },
      "target_retirement_age": {
        "type": "integer",
        "example": 60,
        "required": false,
        "description": "Targest retirement age."
      },
      "vulnerability_details": {
        "type": "string",
        "example": "No vulnerabilities",
        "required": false,
        "description": "Any details regarding the client's vulnerabilities."
      },
      "adaption_details_notes": {
        "type": "boolean",
        "example": "Adaptation notes",
        "required": false,
        "description": "Any notes regarding adaptations"
      },
      "do_not_contact_via_fax": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be contacted via fax"
      },
      "do_not_contact_via_sms": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be contacted via SMS"
      },
      "anniversary_review_date": {
        "type": "date",
        "example": "2024-10-16",
        "required": false,
        "description": "Anniversary review date"
      },
      "current_state_of_health": {
        "type": "string",
        "example": "Fit and healthy",
        "required": false,
        "description": "The client's current state of health."
      },
      "do_not_contact_via_mail": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be contacted via mail"
      },
      "expected_retirement_age": {
        "type": "integer",
        "example": 60,
        "required": false,
        "description": "The expected retirement age."
      },
      "has_obtained_a_forecast": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Have you recently obtained a forecast"
      },
      "power_of_attorney_notes": {
        "type": "string",
        "example": "Notes on the client's power of attorney.",
        "required": false,
        "description": "Notes on the client's power of attorney."
      },
      "projected_state_pension": {
        "type": "integer",
        "example": 50000,
        "required": false,
        "description": "What is the projected State Pension"
      },
      "units_of_alcohol_weekly": {
        "type": "integer",
        "example": 28,
        "required": false,
        "description": "The units of alcohol digested weekly."
      },
      "do_not_contact_via_email": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be contacted via email"
      },
      "assigned_paraplanner_uuid": {
        "type": "string",
        "example": "e77cd881-38b2-4236-b8af-380178bd71b9",
        "required": false,
        "description": "The UUID of the paraplanner employee that the client has been assigned"
      },
      "poa_attorney_appointed_at": {
        "type": "date",
        "example": "2024-10-16T00:00:00+01:00",
        "required": false,
        "description": "When were the Attorney’s appointed?"
      },
      "assigned_administrator_uuid": {
        "type": "string",
        "example": "2a24b762-cf07-463b-92e4-0b749bbee29d",
        "required": false,
        "description": "The UUID of the adviser employee that the client has been assigned"
      },
      "is_anticipating_inheritance": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Whether the client is anticipating/ expecting any inheritance."
      },
      "state_of_health_explanation": {
        "type": "string",
        "example": "Explanation of the current state of health.",
        "required": false,
        "description": "Explanation of the current state of health."
      },
      "are_poa_documents_registered": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Are the documents registered?"
      },
      "do_not_contact_via_telephone": {
        "type": "boolean",
        "example": false,
        "required": false,
        "description": "Denotes if the client can be contacted via telephone"
      },
      "is_poa_registered_epa_or_lpa": {
        "type": "string",
        "example": "epa",
        "required": false,
        "description": "Is the Power of Attorney Registered as a EPA or LPA"
      },
      "anticipating_inheritance_notes": {
        "type": "string",
        "example": "Notes on the client's inheritance anticipation/ expectations.",
        "required": false,
        "description": "Notes on the client's inheritance anticipation/ expectations."
      },
      "is_in_receipt_of_your_state_pension": {
        "type": "boolean",
        "example": true,
        "required": false,
        "description": "Are you in receipt of your State Pension"
      },
      "are_poa_appointed_for_health_or_wealth": {
        "type": "string",
        "example": "health",
        "required": false,
        "description": "Are the Attorneys appointed for Health, Wealth or Both?"
      },
      "years_of_national_insurance_contributions": {
        "type": "integer",
        "example": 5,
        "required": false,
        "description": "How many years have you made Nation Insurance Contributions"
      }
    }
  ],
  "Employee": [
    {
      "role": {
        "type": "string",
        "example": "owner",
        "required": false,
        "description": "The role of the employee."
      },
      "email": {
        "type": "string",
        "example": "gareth.thompson@plannrcrm.com",
        "required": false,
        "description": "The email of the employee. Required when with_login is present."
      },
      "groups": {
        "type": "array",
        "example": [
          "3004ac40-16fb-474b-b7de-9134e499916e",
          "3b509ea5-b428-4396-944d-fc277f4c825f"
        ],
        "required": false,
        "description": "Group UUIDs to sync employee to. Null can be provided to clear an employees groups"
      },
      "last_name": {
        "type": "string",
        "example": "Thompson",
        "required": false,
        "description": "The last name of the employee."
      },
      "first_name": {
        "type": "string",
        "example": "Gareth",
        "required": false,
        "description": "The first name of the employee."
      },
      "advice_type": {
        "type": "string",
        "example": "independent",
        "required": false,
        "description": "Employee's RMAR advice type"
      },
      "departments": {
        "type": "array",
        "example": [
          "paraplanner",
          "adviser"
        ],
        "required": false,
        "description": "The departments the employee is part of"
      },
      "adviser_split_uuid": {
        "type": "string",
        "example": "b94fbcc7-4d90-4020-8680-a5124d901e8f",
        "required": false,
        "description": "Adviser split"
      },
      "meeting_booking_url": {
        "type": "string",
        "example": "https://calendly.com/gareth-codepotato",
        "required": false,
        "description": "Employee's meeting booking URL"
      },
      "assigned_adviser_uuid": {
        "type": "string",
        "example": "701cfce6-5387-4a84-bf8c-0fda530e6dee",
        "required": false,
        "description": "The uuid of the senior employee that the employee directly reports to"
      }
    }
  ],
  "Introducer": [
    {
      "title": {
        "type": "string",
        "example": "Mr",
        "required": false,
        "description": "Title"
      },
      "groups": {
        "type": "array",
        "example": [
          "577d3416-4026-4306-82fb-e207b335234e",
          "36d46221-1513-4a2c-b0b1-231d6a7eba35"
        ],
        "required": false,
        "description": "Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups"
      },
      "last_name": {
        "type": "string",
        "example": "Stanton",
        "required": false,
        "description": "Last name"
      },
      "first_name": {
        "type": "string",
        "example": "Patrick",
        "required": false,
        "description": "First name"
      },
      "entity_name": {
        "type": "string",
        "example": "PatrickCo",
        "required": false,
        "description": "Entity/business name"
      },
      "assigned_adviser_uuid": {
        "type": "string",
        "example": "2147045a-4883-422e-8056-b4de8ad2a88c",
        "required": false,
        "description": "UUID of the account that this account reports to"
      },
      "charge_split_schema_uuid": {
        "type": "string",
        "example": "b8753fcb-bcdb-4dc3-8bb2-a8cbe008f781",
        "required": false,
        "description": "Charge split schema that is always used when adding a charge split for this introducer"
      }
    }
  ]
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "6e86aaff-448d-47e4-8064-e6bf9728c9e8",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!"
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "8c14b9b3-9bf3-4e64-ada8-a8137c4bcee8",
      "colour": "#ef4582",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00"
    }
  ],
  "type": "client",
  "uuid": "af1e6d02-55a6-4dd0-a0d0-f22747dd47df",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "6979be66-63d9-4c50-a355-e184f9210c16",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "8f8c1397-e765-4161-a804-22c3288f61a3",
          "description": "UUID of the account"
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "description": "Email of the account"
        },
        "last_name": {
          "example": "Thompson",
          "description": "Last name of the account"
        },
        "first_name": {
          "example": "Gareth",
          "description": "First name of the account"
        }
      },
      "participants_count": "3"
    }
  ],
  "owners": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "d90b8ea5-3586-4eba-b92e-d7b93e33e03c",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2024-10-16T11:10:13+01:00",
      "first_name": "Gareth",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "with_login": true,
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2024-10-16T11:10:13+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2024-10-16T11:10:13+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2024-10-16T11:10:13+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2024-10-16T11:10:13+01:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2024-10-16T11:10:13+01:00",
  "first_name": "Gareth",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "with_login": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "3b8da11c-a088-4bcd-b771-72a3ec27868a",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "introduced_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "925f516f-ea07-4de1-94dc-39a9f4424bcd",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "ae1a6553-5ca0-402b-a479-fd6b24db8e11",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "can_be_deleted": "false",
  "assigned_adviser": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "9265ca13-f1d6-4187-a71f-4b68be899e8f",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "next_review_date": "2024-10-16T11:10:13+01:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "2b7efef2-b8d0-44ee-a98c-35c7b2155c20",
    "end_date": "2024-10-16T11:10:13+01:00",
    "is_active": "1",
    "trackable": "Client",
    "start_date": "2024-10-16T11:10:13+01:00"
  },
  "first_contact_date": "2024-10-16T11:10:13+01:00",
  "external_references": [
    {
      "uuid": "3f1c3cae-a99a-437d-bb6d-5df642a9f76d",
      "reference": "AB123456",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "third_party": "nucleus"
    }
  ],
  "assigned_paraplanner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "bf36a6cb-a2cc-4861-a666-8fd5b7dc9b64",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "previous_review_date": "2024-10-16T11:10:13+01:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "617e2e16-7a96-4b1c-8053-4b8d8a063c07",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "assigned_administrator": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "db9e3b8f-4fd1-4e39-8a21-1f8c3e259478",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "anniversary_review_date": "2024-10-16T11:10:13+01:00"
}