Leave Request
| Name | Type | Description |
|---|---|---|
id | String | Unique identifier of the leave request |
startDate | Date | Example: 2022-09-23T00:00:00Z |
endDate | Date | Example: 2022-09-30T00:00:00Z |
requestedOn | Date | Example: 2022-09-20T13:45:00Z |
note | String | Note by the employee requesting the leave |
status | Enum | One ofREQUESTED,APPROVED,DECLINED,CANCELLED,DELETED,NOT_SPECIFIED |
leaveType | LeaveType | See the Leave Type model below |
unit | Enum | The measurement that the HRIS uses to count time off requested. One of DAYS,HOURSNOT_SPECIFIED |
amount | Double | The leave time off quantity measured by the prescribed unitExample: 7.0 |
isPaid | Enum | One ofTRUE,FALSE,NOT_SPECIFIED |
utcOffset | String | UTC offset associated with the leave request timestamps, when provided by the source system. Format: ±HH:MM. Example: +02:00, -05:00. Returns null when the source system does not expose UTC offset information. |
timezone | String | IANA time zone identifier associated with the leave request, when provided by the source system. Example: Europe/Stockholm, America/New_York. Returns null when the source system does not expose a time zone identifier. |
Leave Balance
| Name | Type | Description |
|---|---|---|
leaveType | LeaveType | See the Leave Type model below |
unit | Enum | The measurement that the HRIS uses to count time off. One of DAYS,HOURSNOT_SPECIFIED |
balance | Double | The balance leave quantity measured by the prescribed unitExample: 20.0 |
used | Double | The used leave quantity measured by the prescribed unitExample: 1.0 |
isPaid | Enum | One ofTRUE,FALSE,NOT_SPECIFIED |
isEligible | Enum | Indicates whether the employee is eligible for the given leave type One of TRUE,FALSE,NOT_SPECIFIED |
Leave Type
| Name | Type | Description |
|---|---|---|
id | String | Unique identifier of the leave type |
name | String | |
type | Enum | One ofVACATION,SICK,PERSONAL,JURY_DUTY,VOLUNTEER,BEREAVEMENT,NOT_SPECIFIED |

