Advanced HR API's

Kellie Oxley Updated by Kellie Oxley

HR API Documentation

Below is a list of the Advanced HR API's, with a brief description of what they are used for:

Operation

API

Description

Employees

List employees

Returns a list of current employees. The employees are returned sorted by start date, with the most recent employees appearing first.

Employees

View an employee

Retrieves the details of a single employee. It requires the employees Id that can be found from the /employees collection or is returned after creating a new employee.

Absences

List absences

Returns a list of absences.

Absences

Create new absences

Create new absences for specified employees. This is an asynchronous endpoint that returns a JobID.

Absences

View details of an absence

Retrieves the details of an absence. It requires the absence code that can we found from the /absences collection or is returned after creating a new absence.

Absences

Updates absence parameters

Updates the details of an absence. It requires the absence code that can we found from the /absences collection or is returned after creating a new absence.

Absences

Delete absences

Delete an absence.

Jobs

Get status updates

Gets the status of a specific job id.

Leave requests

Operations to retrieve and update employee leave requests

Create a new leave request.

MyWorkplace applets

Get summary details

Returns a list of summary values for the specified applet.

MyWorkplace applets

Initialise a workflow instance

Initialise an advanced hr workflow instance.

Team member photo

View a team member photo

Returns a base64 representation of a photo for the specified team member.

Below is a list of the specific API's used to integrate with payroll:

Operation

API

Description

Payroll

List transactions

Lists all payroll transactions with a status of 'Pending'.

Payroll

Bulk update statuses

Update transaction records statuses. If a transaction's status is Pending, it will be pulled from the API again on the next GET /transactions. This is an asynchronous endpoint.

Payroll

Add warning records

Create payroll transaction warning records. This is an asynchronous endpoint that returns a Job Id.

Payroll

Get status updates

Get status of specified job id

Advanced HR now also supports some basic OData queries through it’s new /odata endpoint, this allows you to request any piece of employee data from any table within Advanced HR! Read more about that here

Looking for something more technical? Try our technical API documents

Was this article useful?

The diversity, inclusion and equality questionnaire

Cloud Folders

Contact