Leave Data Models

Leave Request

NameTypeDescription
idStringUnique identifier of the leave request
startDateDateExample: 2022-09-23T00:00:00Z
endDateDateExample: 2022-09-30T00:00:00Z
requestedOnDateExample: 2022-09-20T13:45:00Z
noteStringNote by the employee requesting the leave
statusEnumOne of
REQUESTED,
APPROVED,
DECLINED,
CANCELLED,
DELETED,
NOT_SPECIFIED
leaveTypeLeaveTypeSee the Leave Type model below
unitEnumThe measurement that the HRIS uses to count time off requested.
One of
DAYS,
HOURS
NOT_SPECIFIED
amountDoubleThe leave time off quantity measured by the prescribed unit
Example: 7.0
isPaidEnumOne of
TRUE,
FALSE,
NOT_SPECIFIED

Leave Balance

NameTypeDescription
leaveTypeLeaveTypeSee the Leave Type model below
unitEnumThe measurement that the HRIS uses to count time off.
One of
DAYS,
HOURS
NOT_SPECIFIED
balanceDoubleThe balance leave quantity measured by the prescribed unit
Example: 20.0
usedDoubleThe used leave quantity measured by the prescribed unit
Example: 1.0
isPaidEnumOne of
TRUE,
FALSE,
NOT_SPECIFIED
isEligibleEnumIndicates whether the employee is eligible for the given leave type
One of
TRUE,
FALSE,
NOT_SPECIFIED

Leave Type

NameTypeDescription
idStringUnique identifier of the leave type
nameString
typeStringOne of
VACATION,
SICK,
PERSONAL,
JURY_DUTY,
VOLUNTEER,
BEREAVEMENT,
NOT_SPECIFIED