The leave-request 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).

LeaveRequests status are by default in the pending_approval state. LeaveRequests status can be approved, denied, cancelled or in the cancellation_pending state.

integer

Unique identifier for the LeaveRequest

leavePeriodId

integer

Unique identifier for the attached LeavePeriod

leavePeriod

object

leavePeriod.id

number

Unique identifier for the LeavePeriod

leavePeriod.ownerId

number

Unique identifier for the user

leavePeriod.isConfirmed

boolean

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

leavePeriod.confirmationDate

string | null

Time at which the LeavePeriod was approved

leavePeriod.attachmentId

string | null

Unique identifier for the attached document

leavePeriod.leaves

object[]

leavePeriod.leaves.id

string

required

Unique identifier for the Leave

leavePeriod.leaves.date

string

required

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

leavePeriod.leaves.isAm

boolean

required

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

leavePeriod.leaves.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

leavePeriod.leaves.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

leavePeriod.leaves.leaveAccount

object

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

Fields

leavePeriod.leaves.leavePeriod

object

leavePeriod.leaves.leavePeriod.id

number

Unique identifier for the LeavePeriod

leavePeriod.leaves.leavePeriod.ownerId

number

Unique identifier for the user

leavePeriod.leaves.leavePeriod.isConfirmed

boolean

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

leavePeriod.leaves.leavePeriod.confirmationDate

string | null

Time at which the LeavePeriod was approved

leavePeriod.leaves.leavePeriod.attachmentId

string | null

Unique identifier for the attached document

leavePeriod.leaves.leavePeriod.leaves

object[]

leavePeriod.leaves.leavePeriod.logs

object[]

leavePeriod.leaves.value

string | null

Leave duration in hours

leavePeriod.leaves.creationDate

string

Time at which the object was created

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

leavePeriod.leaves.cancellationDate

string | null

Time at which the request was canceled

leavePeriod.leaves.cancellationUserId

integer | null

Unique identifier for the user who canceled the request

leavePeriod.leaves.comment

string

Comments

leavePeriod.logs

object[]

status

enum<number>

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

creationDate

string

Time at which the object was created

nextApproverId

integer | null

Unique identifier for the next approver

cancellationUserId

integer | null

Unique identifier for the user that cancelled the Leave Request

cancellationDate

string | null

Time at which the object was cancelled

isActive

boolean

Has the value true for acitve Leave Request or the value false for cancelled Leave Request

approvals

object[]

cancellationRequests

object[]

Was this page helpful?

Cancellation of a leave The leave-period resource

{
  "id": 123,
  "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": {
                "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
      }
    ]
  },
  "status": 0,
  "creationDate": "2023-11-07T05:31:56Z",
  "nextApproverId": null,
  "cancellationUserId": null,
  "cancellationDate": null,
  "isActive": true,
  "approvals": [
    {
      "id": 123,
      "date": "2023-11-07T05:31:56Z",
      "approverId": 123,
      "substitutedApproverId": null,
      "approved": true,
      "comment": "<string>"
    }
  ],
  "cancellationRequests": [
    {
      "id": 123,
      "authorId": 123,
      "comment": "<string>",
      "rank": 0,
      "approved": true,
      "creationDate": "2023-11-07T05:31:56Z",
      "nextApproverId": null,
      "isActive": true
    }
  ]
}