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).
LeaveRequests status are by default in the pending_approval state. LeaveRequests status can be approved, denied, cancelled or in the cancellation_pending state.
Has the value true for approved LeaveRequest or the value false for LeaveRequest pending approval
Unique identifier for the approver
Unique identifier for the LeaveRequestApproval
approvals. substitutedApproverId
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
Time at which the object was cancelled
cancellationRequests. approved
cancellationRequests. authorId
cancellationRequests. creationDate
cancellationRequests. isActive
cancellationRequests. nextApproverId
cancellationRequests. rank
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
Unique identifier for the user that cancelled the Leave Request
Time at which the object was created
Unique identifier for the LeaveRequest
Has the value true for acitve Leave Request or the value false for cancelled Leave Request
Unique identifier for the attached document
leavePeriod. confirmationDate
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
leavePeriod.leaves. leaveAccountId
Unique identifier for the attached LeaveAccount
leavePeriod.leaves. leavePeriodId
Unique identifier for the attached LeavePeriod
leavePeriod.leaves. cancellationDate
Time at which the request was canceled
leavePeriod.leaves. cancellationUserId
Unique identifier for the user who canceled the request
leavePeriod.leaves. creationDate
Time at which the object was created
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).
leavePeriod.leaves. leaveAccount
LeaveAccounts are the type of absences that can be selected by the user
Fields leavePeriod.leaves.leaveAccount. id
Unique identifier for the LeaveAccount
leavePeriod.leaves.leaveAccount. name
leavePeriod.leaves. leavePeriod
leavePeriod.leaves.leavePeriod. attachmentId
Unique identifier for the attached document
leavePeriod.leaves.leavePeriod. confirmationDate
Time at which the LeavePeriod was approved
leavePeriod.leaves.leavePeriod. id
Unique identifier for the LeavePeriod
leavePeriod.leaves.leavePeriod. isConfirmed
Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval
leavePeriod.leaves.leavePeriod. leaves
leavePeriod.leaves.leavePeriod.leaves. date
Date of the leave in ISO format yyyy-mm-dd
leavePeriod.leaves.leavePeriod.leaves. id
Unique identifier for the Leave
leavePeriod.leaves.leavePeriod.leaves. isAm
Has the value true for morning or the value false for afternoon
leavePeriod.leaves.leavePeriod.leaves. leaveAccountId
Unique identifier for the attached LeaveAccount
leavePeriod.leaves.leavePeriod.leaves. leavePeriodId
Unique identifier for the attached LeavePeriod
leavePeriod.leaves.leavePeriod.leaves. cancellationDate
Time at which the request was canceled
leavePeriod.leaves.leavePeriod.leaves. cancellationUserId
Unique identifier for the user who canceled the request
leavePeriod.leaves.leavePeriod.leaves. creationDate
Time at which the object was created
leavePeriod.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).
leavePeriod.leaves.leavePeriod.leaves. leaveAccount
LeaveAccounts are the type of absences that can be selected by the user
Fields leavePeriod.leaves.leavePeriod.leaves. leavePeriod
leavePeriod.leaves.leavePeriod.leaves. value
leavePeriod.leaves.leavePeriod. logs
leavePeriod.leaves.leavePeriod.logs. date
leavePeriod.leaves.leavePeriod.logs. id
leavePeriod.leaves.leavePeriod.logs. status
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
leavePeriod.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
Unique identifier for the attached LeavePeriod
Unique identifier for the next approver
Status of the Leave request. Can be :
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
Available options:
0,
2,
3,
4,
5
