Leave Data Models

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 of
REQUESTED,
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,
HOURS
NOT_SPECIFIED

amount

Double

The leave time off quantity measured by the prescribed unit
Example: 7.0

isPaid

Enum

One of
TRUE,
FALSE,
NOT_SPECIFIED

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,
HOURS
NOT_SPECIFIED

balance

Double

The balance leave quantity measured by the prescribed unit
Example: 20.0

used

Double

The used leave quantity measured by the prescribed unit
Example: 1.0

isPaid

Enum

One of
TRUE,
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 of
VACATION,
SICK,
PERSONAL,
JURY_DUTY,
VOLUNTEER,
BEREAVEMENT,
NOT_SPECIFIED