Table of Contents
Employee Leave Balances API v1
Supported Endpoints and Methods
The endpoint can be found at : https://api.reckon.com/R1/{BOOKID}/payroll/contacts/{employee-id}/leavebalances
Methods supported: GET
The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Reckon One Payroll API is available to AU only.
Endpoint | Additional Parameter(s) | HTTP Method | Description | API Portal |
contacts | /leavebalances | Retrieve the list of employees |
Get the leave balance of an employee
Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/contacts/{employee-id}/leavebalances
Method: GET
Sample Response
[{
"EmployeeLeaveId": "9470a313-1d03-4520-90d1-9710dabe71f8",
"Accrued": 35,
"Used": 0,
"Available": 35,
"Projected": 35,
"AvailableDollarValue": 0,
"PayItemType": 13,
"PayItemName": "Personal Leave"
}, {
"EmployeeLeaveId": "68781c6c-1b11-4686-9db0-efeb04a00eb2",
"Accrued": 105,
"Used": 0,
"Available": 105,
"Projected": 105,
"AvailableDollarValue": 0,
"PayItemType": 12,
"PayItemName": "Annual Leave"
}]Please note that the values of the Leave Balances are controlled by the usage of the leave items in a Pay run and via the Year-To-Date (Settings > Payroll > YTD Setup > Leave balance)
