Employees

Definition

An Employee is someone who is working for your organisation.

Employees are classified as one of the following:

• Casual
• Part time (permanent or fixed/maximum term)
• Full time (permanent or fixed/maximum term)
• Labour hire
• Temporary
• Super Income Stream

Employees can be created through two different processes:

1. When a Candidate goes through the interview, shortlist and onboarding process it then converts, at your request, into an Employee. During this conversion, all the Candidate’s details, documents, notes, etc will be pushed to the Employee, for reference.
2. From scratch, without going through the Candidate process first.

Once an Employee is created, the following information can be captured (not limited to):

• Personal details,
• Payroll details,
• Training and qualifications,
• Notes (e.g. Electronic policy acknowledgements, Emails, logged interactions),
• Personal and strategic objectives,
• Performance Reviews,
• HR personnel documents.

At the present moment, the enableHR API exposes the personal details, payroll details (including leave balances) and training and qualifications of Employees. Employees have access to the enableHR self-service portal where they can review policies, action HR tasks, complete performance reviews, update personal details, update training and qualifications, create WHS incidents/hazards.

enableHR API current exposure for Employees:

• Actions:
  • List existing Employees
  • Create, retrieve and update an Employee
  • Transfer an Employee to another branch
  • Terminate an Employee

• Fields:
  • Personal information (excluding custom fields)
  • Bank accounts (Australia and New Zealand)
  • Tax details (Australia and New Zealand)
  • Super Annuation (Kiwi Saver in New Zealand)
  • Leave balances
  • Training and Qualification (competencies)

List all Employees

Use this action to list the employees visible to the user executing the API call.

Employees are organised in Branches, have a status (current, terminated, etc) and an employment type (permanent, casual, part time, full time, etc).

The list action allows you to access this information without having to query each Employee.

Method	GET: List Employees
Parameters	Account ID - Unique identifier of the Account
Response	Field Name on the Screen Details Example First Name First name of the employee Rajesh Last Name Surname or last name of the employee Powar Date of Birth Birth date of the employee 1981-02-22 Gender Gender of the employee Possible Values: Male, Female, Non_Binary, Not_Stated Emp. Type Employment type Possible Values: Unspecified, Permanent_FullTime, Permanent_PartTime, Temporary, Casual, Contract, FixedTerm_FullTime, FixedTerm_PartTime, LabourHire, SuperIncomeStream Branch Name of the branch where employee is registered Brighton Store Parent Branch Parent branch of employee’s branch If exists – /Trumps incorporated/Brighton Store If not exists - /Brighton Store Status Current employment status of the employee Possible Values: Current, Terminated, Completed, Suspended, Leave, LeaveWithoutPay, Transferred, Terminating, Merged Candidate to Employee (NA) Date when the Candidate has been converted to an employee 2022-02-03T19:20:30.45+01:00 E-mail (W) Work email of the employee EmailWork@email.com E-mail (H) Personal email of the employee EmailHome@email.com

Retrieve an Employee

Use this action to retrieve the details of an Employee.

Create an Employee

Use this action to create a new Employee.

Update an Employee

Use this action to update an Employee.

Transfer an Employee

Use this action to transfer an Employee from one Branch to another Branch.

Terminate an Employee

Use this action to terminate an Employee.