The leave-period resource

Status

Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

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).

number

Unique identifier for the LeavePeriod

ownerId

number

Unique identifier for the user

isConfirmed

boolean

Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval

confirmationDate

string | null

Time at which the LeavePeriod was approved

attachmentId

string | null

Unique identifier for the attached document

leaves

object[]

leaves.id

string

required

Unique identifier for the Leave

leaves.date

string

required

Date of the leave in ISO format yyyy-mm-dd

leaves.isAm

boolean

required

Has the value true for morning or the value false for afternoon

leaves.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

leaves.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

leaves.leaveAccount

object

LeaveAccounts are the type of absences that can be selected by the user

Fields

leaves.leavePeriod

object

leaves.leavePeriod.id

number

Unique identifier for the LeavePeriod

leaves.leavePeriod.ownerId

number

Unique identifier for the user

leaves.leavePeriod.isConfirmed

boolean

Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval

leaves.leavePeriod.confirmationDate

string | null

Time at which the LeavePeriod was approved

leaves.leavePeriod.attachmentId

string | null

Unique identifier for the attached document

leaves.leavePeriod.leaves

object[]

leaves.leavePeriod.leaves.id

string

required

Unique identifier for the Leave

leaves.leavePeriod.leaves.date

string

required

Date of the leave in ISO format yyyy-mm-dd

leaves.leavePeriod.leaves.isAm

boolean

required

Has the value true for morning or the value false for afternoon

leaves.leavePeriod.leaves.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

leaves.leavePeriod.leaves.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

leaves.leavePeriod.leaves.leaveAccount

object

LeaveAccounts are the type of absences that can be selected by the user

Fields

leaves.leavePeriod.leaves.leavePeriod

object

leaves.leavePeriod.leaves.value

string | null

Leave duration in hours

leaves.leavePeriod.leaves.creationDate

string

Time at which the object was created

leaves.leavePeriod.leaves.isActive

boolean

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.cancellationDate

string | null

Time at which the request was canceled

leaves.leavePeriod.leaves.cancellationUserId

integer | null

Unique identifier for the user who canceled the request

leaves.leavePeriod.leaves.comment

string

Comments

leaves.leavePeriod.logs

object[]

leaves.value

string | null

Leave duration in hours

leaves.creationDate

string

Time at which the object was created

leaves.isActive

boolean

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.cancellationDate

string | null

Time at which the request was canceled

leaves.cancellationUserId

integer | null

Unique identifier for the user who canceled the request

leaves.comment

string

Comments

logs

object[]

Was this page helpful?

The leave-request resource List leave requests

{
  "id": 123,
  "ownerId": 123,
  "isConfirmed": true,
  "confirmationDate": null,
  "attachmentId": null,
  "leaves": [
    {
      "id": "<string>",
      "date": "2023-12-25",
      "isAm": true,
      "leaveAccountId": 123,
      "leaveAccount": {
        "id": 123,
        "name": "<string>"
      },
      "leavePeriodId": 123,
      "leavePeriod": {
        "id": 123,
        "ownerId": 123,
        "isConfirmed": true,
        "confirmationDate": null,
        "attachmentId": null,
        "leaves": [
          {
            "id": "<string>",
            "date": "2023-12-25",
            "isAm": true,
            "leaveAccountId": 123,
            "leaveAccount": {
              "id": 123,
              "name": "<string>"
            },
            "leavePeriodId": 123,
            "leavePeriod": {
              "id": 123,
              "ownerId": 123,
              "isConfirmed": true,
              "confirmationDate": null,
              "attachmentId": null,
              "leaves": [
                {
                  "id": "<string>",
                  "date": "2023-12-25",
                  "isAm": true,
                  "leaveAccountId": 123,
                  "leaveAccount": {
                    "id": 123,
                    "name": "<string>"
                  },
                  "leavePeriodId": 123,
                  "leavePeriod": {},
                  "value": "<string>",
                  "creationDate": "2023-11-07T05:31:56Z",
                  "isActive": true,
                  "cancellationDate": null,
                  "cancellationUserId": null,
                  "comment": "<string>"
                }
              ],
              "logs": [
                {
                  "id": 123,
                  "date": "2023-11-07T05:31:56Z",
                  "comment": "<string>",
                  "status": 0
                }
              ]
            },
            "value": "<string>",
            "creationDate": "2023-11-07T05:31:56Z",
            "isActive": true,
            "cancellationDate": null,
            "cancellationUserId": null,
            "comment": "<string>"
          }
        ],
        "logs": [
          {
            "id": 123,
            "date": "2023-11-07T05:31:56Z",
            "comment": "<string>",
            "status": 0
          }
        ]
      },
      "value": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "isActive": true,
      "cancellationDate": null,
      "cancellationUserId": null,
      "comment": "<string>"
    }
  ],
  "logs": [
    {
      "id": 123,
      "date": "2023-11-07T05:31:56Z",
      "comment": "<string>",
      "status": 0
    }
  ]
}