The iPayroll Application Programming Interface
See all about the iPayroll API here: dev.ipayroll.co.nz
The iPayroll REST API allows you to query and manipulate data held by iPayroll about organisations and their employees. It uses predictable, resource-oriented URLs, and communicates API errors using HTTP response codes.
The API can be used directly by clients developing their own applications. Third party applications can also be authorised by clients to access information on their behalf.
All URLs referenced in the documentation have the following base:
The iPayroll REST API is served over HTTPS. Plain HTTP is not supported.
The iPayroll API supports the following actions:
- Get employees
- Create employees
- Get pay rates for an employee
- Get payslips
- Get leave balances for an employee
- Get leave requests
- Get timesheets associated with the latest payroll
- Get cost centres
- Create cost centres
- Get pay elements
Data available via The iPayroll API is grouped into scopes.
Scopes allow an organisation to expose only a particular section of their data to a third party application. For example, permission can be granted only to access employee details, but not their timesheets.
The iPayroll API supports the following scopes:
- Pay Rates
- Leave Balances
- Leave Requests
- Pay Elements
Your application will have to request access for the scopes it is interested in, and the user will have to grant that access.