Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• uuid string Required

Responses

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

  • uuid string
  • created_at string
  • updated_at string
  • name string
  • type string
  • type_other string
  • amount object
    Hide amount attributes Show amount attributes object

    • amount object
      Hide amount attributes Show amount attributes object

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

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

      • example string
      • description string
  • amount_type string
  • start_date string
  • end_date string
  • frequency string
  • is_taxable boolean
  • employment object
    Hide employment attributes Show employment attributes object

    • uuid string
    • created_at string
    • updated_at string
    • status string
    • primary boolean
    • occupation string
    • occupation_code string
    • job_title string
    • employer string
    • started_at string
    • ended_at string
    • is_business_owner boolean
    • percentage_of_business_shared integer
    • address object
      Hide address attributes Show address attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the address

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • address_3

        Third line of the address

      • address_4

        Fourth line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • move_in_date

        Address move in date. This field may provide inaccurate data. We recommend using the v2/addresses API which has the moved_in_month and moved_in_year fields instead.

    • phone_number object
      Hide phone_number attributes Show phone_number attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

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

    • email_address object
      Hide email_address attributes Show email_address attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

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

    • shared_owner_type string
    • shared_owner object
      Hide shared_owner attributes Show shared_owner attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • is_out_of_office

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

      • out_of_office_from

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

      • out_of_office_until

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

      • out_of_office_message

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

      • permissions

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

    • last_salary_increase string
    • business_name string
    • business_year_end string
    • business_value object
      Hide business_value attributes Show business_value attributes object

      • amount object
        Hide amount attributes Show amount attributes object

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

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

        • example string
        • description string
    • directors string
    • shareholding_in_business object
      Hide shareholding_in_business attributes Show shareholding_in_business attributes object

      • amount object
        Hide amount attributes Show amount attributes object

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

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

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

      • amount object
        Hide amount attributes Show amount attributes object

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

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

        • example string
        • description string
    • accountant_company_name string
    • accountant_email string
    • accountant_telephone_number string
    • accountant_address string
    • turnover_history object
      Hide turnover_history attributes Show turnover_history attributes object

      • year

        The year of the turnover.

      • value

        The value of the turnover.

    • income object
      Hide income attributes Show income attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the income.

      • type

        The type of income.

      • type_other

        The other type of income, if the type is "other".

      • amount

        The amount of the income.

      • amount_type

        The type of the amount.

      • start_date

        The start date of the income.

      • end_date

        The end date of the income.

      • frequency

        The frequency of the income.

      • is_taxable

        Denotes if the income is taxable or not.

      • shared_owner_type

        Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients).

    • account object
      Hide account attributes Show account attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        The photo URL of the client

  • account object
    Hide account attributes Show account attributes object

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

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.