The leave resource

Community

Status

Documentation

Files

Organization Structure API

Core HR API

Cleemy Expenses API

Cleemy Invoices API

Timmi Absences API

Timmi Office API

Timmi Project API

Timmi Settings API

Timmi Timesheet API

Pagga Mealvouchers API

Pagga Remuneration API

Poplee Training API

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"
}

{
  "id": "5367",
  "type": "leave",
  "url": "https://my-company.ilucca.net/lucca-api/leaves/5367",
  "startsOn": "2023-01-02",
  "startPosition": "firstHalfDay",
  "endsOn": "2023-01-13",
  "endPosition": "secondHalfDay",
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://my-company.ilucca.net/lucca-api/employees/416"
  },
  "leaveAccount": {
    "id": "218",
    "type": "leave-account",
    "url": "https://my-company.ilucca.net/lucca-api/leave-accounts/218"
  },
  "days": [
    {
      "date": "2023-01-02",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-03",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-04",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-05",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-06",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-09",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-10",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-11",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-12",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    },
    {
      "date": "2023-01-13",
      "range": "allDay",
      "duration": {
        "value": 1,
        "iso": "P1D",
        "unit": "days"
      }
    }
  ],
  "totalDuration": {
    "iso": "P10D",
    "value": 10,
    "unit": "days"
  },
  "status": "confirmed",
  "details": null,
  "createdAt": "2023-01-01T09:45:23.001+02:00",
  "lastUpdatedAt": "2023-01-01T09:45:23.001+02:00",
  "links": {
    "leaveRequest": {
      "href": "https://my-company.ilucca.net/lucca-api/leave-requests/8764"
    },
    "approve": {
      "href": "https://my-company.ilucca.net/lucca-api/leave-requests-decisions"
    },
    "deny": {
      "href": "https://my-company.ilucca.net/lucca-api/leave-requests-decisions"
    }
  }
}