Follow

Open API: What data can be shared via HRA Cloud's Open API?

The HRA Cloud API Ecosystem

Building an OpenAPI is a huge undertaking, so we’re releasing it in stages. Each release improves and expands the number of things you and your business can do with HRA Cloud.

There are still several months of work ahead for the team to further extend the functionality in our API, but we’re excited about what we’ve achieved so far – and what you can build on today. We have deployed several releases of the API, and we are aiming at starting to develop API Connectors in the 2nd half of the year 2021. We haven’t finalised yet the systems we will be building connectors to, nor the order of priority, and this is will be communicated by the end of April 2021.

The table below shows the information that is currently exposed through the API and the short-term roadmap.

Currently available:

  • Accounts: List Branches
  • Accounts: Retrieve details of a Branch
  • Accounts: List Reference Data: Genders
  • Accounts: List Reference Data: Honorifics
  • Accounts: List Reference Data: Employment Types
  • Accounts: List Reference Data: Employment Status

  • Employees: Create a new employee
  • Employees: Update an existing employee
  • Employees: List all employees in the account
  • Employees: Retrieve details of an employee
  • Employees: Update an existing employee - Adding Employment Status
  • Employees: Terminate an employee
  • Employees: Transfer an employee (Move Everything)

  • Candidates: List candidate
  • Candidates: Add new candidate
  • Candidates: Retrieve & update permanent field
  • Candidates: Convert candidate to employee
  • Candidates: Merge 2 candidate

 

  • Payroll (AU): Retrieve Tax Details to an employee record
  • Payroll (AU): Maintain Tax Details to an employee record
  • Payroll (AU): Retrieve details of all Bank Accounts of an employee
  • Payroll (AU): Maintain Bank Accounts of an employee
  • Payroll (AU): Retrieve leave balances of an employee
  • Payroll (AU): Maintain leave balances of an employee
  • Payroll (AU): List all Superannuation Memberships of an employee
  • Payroll (AU): Retrieve Superannuation Memberships of an employee
  • Payroll (AU): Update a Superannuation Memberships of an employee (Regulated Funds)
  • Payroll (AU): Remove a Superannuation Memberships from an employee
  • Payroll (AU): Create Superannuation Memberships for an employee (Regulated Funds)

 

  • Payroll (NZ): Retrieve Kiwi Saver details of an employee
  • Payroll (NZ): Update Kiwi Saver details of an employee
  • Payroll (NZ): Retrieve Tax Details of an employee
  • Payroll (NZ): Update Tax Details of an employee
  • Payroll (NZ): Retrieve details of all Bank Accounts of an employee
  • Payroll (NZ): Update details of all Bank Accounts of an employee
  • Payroll (NZ): Retrieve leave balances of an employee
  • Payroll (NZ): Update leave balances of an employee

Coming soon

Expected to come in July 2021:

  • 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 & update note to an employee

Expected to come by the end of 2021:

  • 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 HRA Cloud users

For background on the meaning of an Open API and how it works, please see this article:  Open API: What is it and why do you need it?

Have more questions? Submit a request