---
title: "GetEmployeeLeaveBalances"
id: "getemployeeleavebalances"
project: "EHR User Guide"
url: "https://help.cloud5.com.au/articles/ehr-user-guide/getemployeeleavebalances"
updated: 2026-10-19T00:53:04Z
---

# GetEmployeeLeaveBalances

The Employee Leave Balances API is based on the Self Service employee Leave Balance and Staff Leave Balances screens.

It will accept optional parameters including the paid date and the ability to restrict to a single employee.

If the paid date is not supplied it will determine the latest finalised non ad-hoc pay date and use the leave balances (hrtentin) from that date.

The following optional parameter is allowed in the request:

| **Element** | **Comments** |
| --- | --- |
| PaidDate | Optional<br> <br>Default to latest finalised pay date if not supplied.<br> <br>Ensure standard date formats are supported (e.g. DDMMYY, DDMMMYY, DDMMYYYY, DDMMMYYYY) |
| EmployeeCode | Optional<br> <br>Allows data to be retrieved for a single employee if necessary |

The following fields will be included in each Employee Leave Balance record:

| **Element** | **Comments** |
| --- | --- |
| EmployeeCode |  |
| Name/FamilyName |  |
| Name/FirstName |  |
| Name/PreferredName |  |
| Name/Title |  |
| Name/FormattedName |  |
| PaidDate | Uses standard date output format dd MMM yyyy |
| AsAtDate | As per option 'entd'<br> <br>p - paid date<br> <br>s - period start date<br> <br>e - period end date |
| LeaveBalances/LeaveBalance/Employment | Not applicable for Long Service Leave |
| LeaveBalances/LeaveBalance/LeaveType |  |
| LeaveBalances/LeaveBalance/LeaveCode |  |
| LeaveBalances/LeaveBalance/LeaveName |  |
| LeaveBalances/LeaveBalance/LeaveAbbreviation | Obtained from Leave master tables (both normal and LSL) |
| LeaveBalances/LeaveBalance/NormalOrLsl | Values<br> <ul> <li> <span style="font-size: 12pt;"><span style="font-family: &quot;Segoe UI&quot;, Frutiger, &quot;Frutiger Linotype&quot;, &quot;Dejavu Sans&quot;, &quot;Helvetica Neue&quot;, Arial, sans-serif;">Normal</span></span> </li> <li> <span style="font-size: 12pt;"><span style="font-family: &quot;Segoe UI&quot;, Frutiger, &quot;Frutiger Linotype&quot;, &quot;Dejavu Sans&quot;, &quot;Helvetica Neue&quot;, Arial, sans-serif;">Long Service Leave (Hours)</span></span> </li> <li> <span style="font-size: 12pt;"><span style="font-family: &quot;Segoe UI&quot;, Frutiger, &quot;Frutiger Linotype&quot;, &quot;Dejavu Sans&quot;, &quot;Helvetica Neue&quot;, Arial, sans-serif;">Long Service Leave (Days)</span></span> </li> </ul> |
| LeaveBalances/LeaveBalance/LeaveEntitlementHours | Only applicable for LSL in Hours or Normal Leave where Option ‘jdys’ is set to ‘h' or 'y’ |
| LeaveBalances/LeaveBalance/LeaveEntitlementDays | Only applicable for LSL in Days or Normal Leave where Option ‘jdys’ is set to ‘d' or 'y’ |
| LeaveBalances/LeaveBalance/NextAccrualDate | Use standard date output format dd MMM yyyy |

| Next topic<br> <br>[GetEmployeePayMasterDetails](/articles/ehr-user-guide/getemployeepaymasterdetails) |
| --- |

© 2023 Fusion5. All rights reserved.