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

Default to latest finalised pay date if not supplied.

Ensure standard date formats are supported (e.g. DDMMYY, DDMMMYY, DDMMYYYY, DDMMMYYYY)

EmployeeCode

Optional

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'

p - paid date

s - period start date

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

  • Normal
  • Long Service Leave (Hours)
  • Long Service Leave (Days)
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

GetEmployeePayMasterDetails








© 2023 Fusion5. All rights reserved.