GET api/EmployeeLeaveBalances/{id}
Gets the leave balances for an employee (employeeCode)
Request Information
URI Parameters
(i.e.queryString parameters in the form ?param1={param1}¶m2={param2})
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The employee's employee code. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The leave balances for the employee in the form of a list of EmployeeLeaveView
EmployeeLeaveView| Name | Description | Type | Additional information |
|---|---|---|---|
| idEmployeeLeave | integer |
None. |
|
| EmpCode |
The EmpCode for the employee |
string |
None. |
| FirstName | string |
None. |
|
| Surname | string |
None. |
|
| Terminated | boolean |
None. |
|
| TerminationDate | date |
None. |
|
| LeaveType |
The Leave Type for the Leave. One of the following values: SickLeave, AnnualLeave, LongServiceLeave, PublicHolidayLeave, ExtraLeave, UserDefinedLeave |
string |
None. |
| LeaveCode |
The Leave Code. Must be a valid Code from the specified leave type. |
string |
None. |
| YTDLoading |
The YTD Leave Loading for the Leave. |
decimal number |
None. |
| PostEntDate | date |
None. |
|
| PostEntHours | decimal number |
None. |
|
| PostEntDays | decimal number |
None. |
|
| PostProDate | date |
None. |
|
| PostProHours | decimal number |
None. |
|
| PostProDays | decimal number |
None. |
|
| CurrentAccrual Date |
date |
None. |
|
| CurrentAccrual Hours |
decimal number |
None. |
|
| PreEntHours | decimal number |
None. |
|
| PreEntDays | decimal number |
None. |
|
| TakenDate | date |
None. |
|
| TakenHours | decimal number |
None. |
|
| SuspendEnt | boolean |
None. |
|
| FirstEntPeriod | boolean |
None. |
|
| Pre78EntHours | decimal number |
None. |
|
| Pre78EntDays | decimal number |
None. |
|
| Grant | boolean |
None. |
|
| NonEntMonths | integer |
None. |
|
| SuspendFrom | date |
None. |
|
| SuspendTo | date |
None. |
|
| NonEntMet | boolean |
None. |
|
| CostCode | string |
None. |
|
| LeaveShifts | decimal number |
None. |
|
| HoursPerDay | decimal number |
None. |
|
| DaysPerWeek | decimal number |
None. |
Response Formats
application/json, text/json
{
"idEmployeeLeave": 1,
"empCode": "sample string 2",
"firstName": "sample string 3",
"surname": "sample string 4",
"terminated": true,
"terminationDate": "2024-05-19T12:25:40.057262+10:00",
"leaveType": "sample string 5",
"leaveCode": "sample string 6",
"ytdLoading": 1.1,
"postEntDate": "2024-05-19T12:25:40.057262+10:00",
"postEntHours": 1.1,
"postEntDays": 1.1,
"postProDate": "2024-05-19T12:25:40.057262+10:00",
"postProHours": 1.1,
"postProDays": 1.1,
"currentAccrualDate": "2024-05-19T12:25:40.057262+10:00",
"currentAccrualHours": 1.1,
"preEntHours": 1.1,
"preEntDays": 1.1,
"takenDate": "2024-05-19T12:25:40.057262+10:00",
"takenHours": 1.1,
"suspendEnt": true,
"firstEntPeriod": true,
"pre78EntHours": 1.1,
"pre78EntDays": 1.1,
"grant": true,
"nonEntMonths": 1,
"suspendFrom": "2024-05-19T12:25:40.057262+10:00",
"suspendTo": "2024-05-19T12:25:40.057262+10:00",
"nonEntMet": true,
"costCode": "sample string 7",
"leaveShifts": 1.1,
"hoursPerDay": 1.1,
"daysPerWeek": 1.1
}
application/xml, text/xml
<EmployeeLeaveView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <idEmployeeLeave>1</idEmployeeLeave> <EmpCode>sample string 2</EmpCode> <FirstName>sample string 3</FirstName> <Surname>sample string 4</Surname> <Terminated>true</Terminated> <TerminationDate>2024-05-19T12:25:40.057262+10:00</TerminationDate> <LeaveType>sample string 5</LeaveType> <LeaveCode>sample string 6</LeaveCode> <YTDLoading>1.1</YTDLoading> <PostEntDate>2024-05-19T12:25:40.057262+10:00</PostEntDate> <PostEntHours>1.1</PostEntHours> <PostEntDays>1.1</PostEntDays> <PostProDate>2024-05-19T12:25:40.057262+10:00</PostProDate> <PostProHours>1.1</PostProHours> <PostProDays>1.1</PostProDays> <CurrentAccrualDate>2024-05-19T12:25:40.057262+10:00</CurrentAccrualDate> <CurrentAccrualHours>1.1</CurrentAccrualHours> <PreEntHours>1.1</PreEntHours> <PreEntDays>1.1</PreEntDays> <TakenDate>2024-05-19T12:25:40.057262+10:00</TakenDate> <TakenHours>1.1</TakenHours> <SuspendEnt>true</SuspendEnt> <FirstEntPeriod>true</FirstEntPeriod> <Pre78EntHours>1.1</Pre78EntHours> <Pre78EntDays>1.1</Pre78EntDays> <Grant>true</Grant> <NonEntMonths>1</NonEntMonths> <SuspendFrom>2024-05-19T12:25:40.057262+10:00</SuspendFrom> <SuspendTo>2024-05-19T12:25:40.057262+10:00</SuspendTo> <NonEntMet>true</NonEntMet> <CostCode>sample string 7</CostCode> <LeaveShifts>1.1</LeaveShifts> <HoursPerDay>1.1</HoursPerDay> <DaysPerWeek>1.1</DaysPerWeek> </EmployeeLeaveView>