Absences from work, wether they are planned or not, are described in Lucca using three concepts : LeaveRequests , LeavePeriods and Leaves .
A LeaveRequest represent the request made by employees when planning time off. This resource is used for workflow purposes.
A LeavePeriod is the continuous period of absence requested by the employee or entered by HR. It is linked to a LeaveRequest if workflow applies.
A Leave is the subdivision of a LeavePeriod . There is one Leave per half-day of the LeavePeriod . Each Leave is linked to a LeaveAccount , which represent the type of leave (PTO, Sick Leave, Congés payés, RTT, etc).
Unique identifier for the attached document
Time at which the LeavePeriod was approved
Unique identifier for the LeavePeriod
Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval
Date of the leave in ISO format yyyy-mm-dd
Unique identifier for the Leave
Has the value true for morning or the value false for afternoon
Unique identifier for the attached LeaveAccount
Unique identifier for the attached LeavePeriod
Time at which the request was canceled
leaves. cancellationUserId
Unique identifier for the user who canceled the request
Time at which the object was created
Has the value true when the Leave exists (for pending or confirmed LeavePeriods), or the value false when it has been deleted (for canceled or denied LeaveRequests).
LeaveAccounts are the type of absences that can be selected by the user
Fields Unique identifier for the LeaveAccount
leaves.leavePeriod. attachmentId
Unique identifier for the attached document
leaves.leavePeriod. confirmationDate
Time at which the LeavePeriod was approved
Unique identifier for the LeavePeriod
leaves.leavePeriod. isConfirmed
Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval
leaves.leavePeriod. leaves
leaves.leavePeriod.leaves. date
Date of the leave in ISO format yyyy-mm-dd
leaves.leavePeriod.leaves. id
Unique identifier for the Leave
leaves.leavePeriod.leaves. isAm
Has the value true for morning or the value false for afternoon
leaves.leavePeriod.leaves. leaveAccountId
Unique identifier for the attached LeaveAccount
leaves.leavePeriod.leaves. leavePeriodId
Unique identifier for the attached LeavePeriod
leaves.leavePeriod.leaves. cancellationDate
Time at which the request was canceled
leaves.leavePeriod.leaves. cancellationUserId
Unique identifier for the user who canceled the request
leaves.leavePeriod.leaves. creationDate
Time at which the object was created
leaves.leavePeriod.leaves. isActive
Has the value true when the Leave exists (for pending or confirmed LeavePeriods), or the value false when it has been deleted (for canceled or denied LeaveRequests).
leaves.leavePeriod.leaves. leaveAccount
LeaveAccounts are the type of absences that can be selected by the user
Fields leaves.leavePeriod.leaves.leaveAccount. id
Unique identifier for the LeaveAccount
leaves.leavePeriod.leaves.leaveAccount. name
leaves.leavePeriod.leaves. leavePeriod
leaves.leavePeriod.leaves.leavePeriod. attachmentId
Unique identifier for the attached document
leaves.leavePeriod.leaves.leavePeriod. confirmationDate
Time at which the LeavePeriod was approved
leaves.leavePeriod.leaves.leavePeriod. id
Unique identifier for the LeavePeriod
leaves.leavePeriod.leaves.leavePeriod. isConfirmed
Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval
leaves.leavePeriod.leaves.leavePeriod. leaves
leaves.leavePeriod.leaves.leavePeriod. logs
leaves.leavePeriod.leaves.leavePeriod. ownerId
Unique identifier for the user
leaves.leavePeriod.leaves. value
leaves.leavePeriod.logs. date
leaves.leavePeriod.logs. id
leaves.leavePeriod.logs. status
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
leaves.leavePeriod. ownerId
Unique identifier for the user
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
Unique identifier for the user
