GET api/Absence/{employeeNo}
Get a list of all absences for an employee
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
All Absence Details
Collection of AbsenceDetailName | Description | Type | Additional information |
---|---|---|---|
StartDate | date |
Required |
|
EndDate |
Must be after StartDate |
date |
Required |
AbsenceType |
1 = Holiday, 2 = Sickness, 3 = Unpaid Leave |
integer |
Required |
NoOfUnits |
Number of units in the absence. |
decimal number |
Required |
PayMaximumDays |
Indicates whether to pay maximum holiday available instead of throwing any errors. example, if an employee has accrued 2 days, but an entry is sent for 5 days of holiday, the record will instead be inserted as 2 days. |
boolean |
Nullable |
Offset |
Sickness only. Allows the statutory payment to be offset by an identical negative payment and is used in scenarios where you wish to continue to pay the employee as normal. Where a payment is to be only partially offset, an adjustment can be made via statutory override. |
boolean |
Nullable |
Response Formats
application/json, text/json
[ { "StartDate": "2022-02-09T11:08:37.966519+00:00", "EndDate": "2022-02-11T11:08:37.966519+00:00", "AbsenceType": 2, "NoOfUnits": 4.0 }, { "StartDate": "2022-02-09T11:08:37.966519+00:00", "EndDate": "2022-02-11T11:08:37.966519+00:00", "AbsenceType": 1, "NoOfUnits": 2.0 } ]
application/xml, text/xml
<ArrayOfAbsenceDetail> <AbsenceDetail> <AbsenceType>2</AbsenceType> <EndDate>2022-02-11T11:08:37.966519+00:00</EndDate> <NoOfUnits>4</NoOfUnits> <StartDate>2022-02-09T11:08:37.966519+00:00</StartDate> </AbsenceDetail> <AbsenceDetail> <AbsenceType>1</AbsenceType> <EndDate>2022-02-11T11:08:37.966519+00:00</EndDate> <NoOfUnits>2</NoOfUnits> <StartDate>2022-02-09T11:08:37.966519+00:00</StartDate> </AbsenceDetail> </ArrayOfAbsenceDetail>