High-Level Concepts

Before diving in the capabilities of the enableHR API, it is important to understand the basic concepts used in the enableHR product.

When an organisation signs up to enableHR, an enableHR Account is created. Within this account, worker records are organised in branches, which are either a legal entity or a department.

Each worker record has its own set of data fields. Some of these fields are identical across record types (first name for instance), some are restricted to a specific type (start date for instance). enableHR has 4 types of records: Candidates, Employees, Volunteers and Contractors.

enableHR API

The enableHR API exposes Account information, Branch information, Candidate information and Employee information. It also provides some “actions” that can be executed on Candidates and Employees. Volunteers and Contractors will come at a later stage of development.

In order to access this information, you need to have the appropriate rights. This is done via our Authentication and Authorisation Server. Our Client Success team will help you with it.

Candidates:

  • Actions:
    1. List existing Candidates
    2. Create, retrieve and update a Candidate
    3. Merge two Candidates together
    4. Convert a Candidate to an Employee
  • Fields:
    1. Personal information (excluding custom fields)

Employees:

  • Actions:
    1. List existing Employees
    2. Create, retrieve and update an Employee
    3. Transfer an Employee to another branch
    4. Terminate an Employee
  • Fields:
    1. Personal information (excluding custom fields & emergency contacts)
    2. Bank accounts (Australia and New Zealand)
    3. Tax details (Australia and New Zealand)
    4. Superannuation (Kiwi Saver in New Zealand)
    5. Leave balances
    6. Training and Qualification (competencies)

Coming next:

  • Employees: List/Retrieve/Update Custom Fields of an employee
  • Employees: List/Retrieve/Add/Update/Delete roles and groups
  • Employees: List/Retrieve/Add/Update/Delete competencies
  • Employees: Manage roles and competencies for an employee
  • Employees: Create a new employee - Adding Emergency Contact
  • Employees: Update an existing employee - Adding Emergency Contact
  • Employees: Retrieve details of an employee - Adding Emergency Contact
  • Employees: List & retrieve notes for an employee
  • Employees: Add a note to an employee
  • Employees: Check for duplicate employee records
  • Employees: Merge 2 employees
  • Employees: Multi-branch linking of an employee
  • Employees: List & retrieve notes for a candidate
  • Employees: Add a note to a candidate
  • Employees: Transfer to new branch (new copy)
  • Employees: Transfer to new branch (move no trace)
  • Employees: Delete an employee
  • Candidates: Retrieve & update custom fields
  • Candidates: Multi-branch linking of a candidate
  • Candidates: Delete a candidate
  • Users: List and manage ESS users
  • Users: List and manage enableHR users
© 2021 enableHR · All rights reserved