The leave resource

A leave is a period an employee takes off work while he should otherwise be working. Employees are entitled to these either by law or by contract.

The leave-account & details

A leave references a leave-account which represents the type of leave: annual leaves, maternity, sick leave, etc... The leave-account determines:

The unit (days, hours) of any leave taken on this leave-account.
Whether some extra details are needed on leave taken on this leave-account. For example, companies in France are required to give a lot of details when it comes to sick leaves. Otherwise, these details should be left null.

The leave status

The leave status indicates whether the leave resource should be considered valid (i.e. the company management gave its approval) or not.

The leave-request

A leave may be subject to an approval process by the management. In this case, it must be created with the "pending" status (an "approved" leave needs no further approval) which then automatically creates a leave-request for this leave.

If a leave is created with an "approved" status, then it has no leave-request, and its status may then be changed directly through a PATCH request. The only available status would then be "cancelled".

Half-days of absence

An employee may work in the morning, and take the afternoon off, and vice versa. The startPosition and endPosition attributes represent this behavior. For example, taking the Jan. 2nd afternoon off:

{
"startsOn": "2023-01-02",
"startPosition": "secondHalfDay",
"endsOn": "2023-01-02",
"endPosition": "secondHalfDay"
}

startsOn

string<date>

required

Date (only). First day (included) of this employee's leave.

endsOn

string<date>

required

Date (only). Last day (included) of this employee's leave.

employee

employee-reference · object

required

Reference to an employee resource.

Show child attributes

employee.id

string

required

Minimum string length: 1

leaveAccount

leave-account-reference · object

required

Reference to a leave-account resource.

Show child attributes

leaveAccount.id

string

required

Minimum string length: 1

Example:

{
  "id": "754",
  "type": "leave-account",
  "url": "https://example.ilucca.net/lucca-api/leave-accounts/754"
}

startPosition

enum<string>

default:firstHalfDay

Does this leave start on the first half-day (often: "morning") or the second one (often: "afternoon")?

Available options:

firstHalfDay,

secondHalfDay

endPosition

enum<string>

default:secondHalfDay

Does this leave end on the first half-day (often: "morning") or the second one (often: "afternoon")?

Available options:

firstHalfDay,

secondHalfDay

totalDuration

Duration (time interval) - positive · object

ISO 8601 formatted time interval. More about this in the documentation. Examples:

"35 hours": {"value": 35, "iso": "P1DT11H", "unit": "hours"}
"5 days": {"value": 5, "iso": "P5D", "unit": "days"} Depending on the related leave-account, a leave may be taken in hours or in days. This attribute sums up the duration of the leave on all of the days it covers. Can only be written on when creating a leave in "hours" unit.

Show child attributes

totalDuration.iso

string<duration>

ISO 8601 formatted string for a duration (i.e. time interval).

totalDuration.value

number<float>

The decimal equivalent of the iso value.

Required range: x >= 0.001Must be a multiple of 0.001

totalDuration.unit

enum<string>

Represents how a work-duration unit is expressed: either as a number of days or hours.

Available options:

days,

hours

Example:

{
  "iso": "PT35H",
  "value": 35,
  "unit": "days"
}

status

enum<string>

Depends on the status of this leave's related leave-request.

tentative: the leave is uncertain as it has yet to be confirmed.
confirmed: the leave will definitely be taken.
cancelled: the leave was finally cancelled, either through the approval workflow or by the employee.

Available options:

tentative,

confirmed,

cancelled

details

Ordinary Sickness [FR] · object

Some leave-accounts required further details about the leave. This is typically the case for sick leaves in France. In this case, set these details in this object. Otherwise, you can just leave this null.

Show child attributes

details.lastWorkedOn

string<date> | null

When left null, dynamically defaults to the last working day before the sick leave starts.

details.extendsSickLeave

leave-reference · object

"Prolongation" A sick leave can extend a previous one related to the same sickness / accident / etc...

Show child attributes

details.extendsSickLeave.id

string

required

Minimum string length: 1

Example:

{
  "id": "31254",
  "type": "leave",
  "url": "https://example.ilucca.net/lucca-api/leaves/31254"
}

details.earlyReturnOf

leave-reference · object

"Reprise anticipée" If employee will return sooner than expected, then indicate the day he/she will come back to work.

Show child attributes

details.earlyReturnOf.id

string

required

Minimum string length: 1

Example:

{
  "id": "31254",
  "type": "leave",
  "url": "https://example.ilucca.net/lucca-api/leaves/31254"
}

details.partTimeReturn

object

Show child attributes

details.partTimeReturn.activityRate

number<decimal> | null

Required range: 0 <= x <= 1Must be a multiple of 0.01

details.partTimeReturn.reason

enum<string>

default:none

"Reprise à temps partiel" Will the employee return as a part-timer?

Available options:

none,

therapeutic,

personal

details.paidDaysCount

integer<int32>

Number of days during which the sick employee is still paid his/her salary. Defaults to the total number of sick days.

Required range: x >= 0

details.unpaidDaysCount

integer<int32>

default:0

Number of days during which the sick employee is not paid his/her salary. The sum of paidDaysCount and unpaidDaysCount cannot exceed this leave totalDuration.

Required range: x >= 0

details.compensationRate

number<decimal> | null

Percentage of his/her salary the sick employee is still paid.

Required range: 0 <= x <= 1Must be a multiple of 0.01

details.hasSubrogation

boolean

Does the employer pay the employee's salary during the sick leave and will later be subrogated to the employee'srights by the authorities?

details.subrogationStartsOn

string<date> | null

In case of subrogation, when does it start? When left null even though subrogation is in effect, then defaults to the sick leave first day.

details.subrogationEndsOn

string<date> | null

In case of subrogation, when does it end? When left null even though subrogation is in effect, then defaults to the sick leave last day.

details.nature

enum<string>

Available options:

frenchOrdinarySickness

Allowed value: "frenchOrdinarySickness"

details.isLongTermCondition

boolean

default:false

Long-lasting conditions are severe enough and/or have a chronic nature that requires prolonged treatment.

links

object

Show child attributes

links.leaveRequest

Link · object

Link to the related leave-request (approval process) if it exists.

Show child attributes

links.leaveRequest.href

string<uri>

required

URL to the related object.

links.approve

Link · object

Link to approve the leave-request (POST) if there's a pending related leave-request. It may need multiple approvals from different employees.

Show child attributes

links.approve.href

string<uri>

required

URL to the related object.

links.deny

Link · object

Link to deny the leave-request (POST) if there's a pending related leave-request. A single denial is enough.

Show child attributes

links.deny.href

string<uri>

required

URL to the related object.

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

The leave resource

The leave-account & details

The leave status

The leave-request

Half-days of absence