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

Leaves

List leaves

Retrieve a list of approved leaves for one or several users on a given period.

The leavePeriod.ownerId query parameter is required ans is used to:

retrieve Leaves of a specific user: ?leavePeriod.ownerId=5
retrieve Leaves of several users: ?leavePeriod.ownerId=5,6
retrieve Leaves of a specific group of users: ?leavePeriod.owner.departmentId=3

The date query parameter can operate comparisons with a given date-time value:

?date=2021-01-01: strict equality.
?date=since,2021-01-01: greater than or equal.
?date=until,2021-01-01: lower than or equal.
?date=between,2021-01-01,2021-01-31: comprised between two dates.

GET

api

leaves

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/leaves

{
  "data": {
    "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": [
        {}
      ],
      "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>"
  }
}

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

leaveAccountId

string

leavePeriod.ownerId

integer[]

required

Employee's identifier

date

string

required

{comparator},{date-time}

Response

200

application/json

data

object

data.id

string

required

Unique identifier for the Leave

data.date

string

required

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

data.isAm

boolean

required

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

data.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

data.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

data.leaveAccount

object

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

Fields

data.leavePeriod

object

data.leavePeriod.id

number

Unique identifier for the LeavePeriod

data.leavePeriod.ownerId

number

Unique identifier for the user

data.leavePeriod.isConfirmed

boolean

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

data.leavePeriod.confirmationDate

string | null

Time at which the LeavePeriod was approved

data.leavePeriod.attachmentId

string | null

Unique identifier for the attached document

data.leavePeriod.leaves

object[]

data.leavePeriod.leaves.id

string

required

Unique identifier for the Leave

data.leavePeriod.leaves.date

string

required

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

data.leavePeriod.leaves.isAm

boolean

required

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

data.leavePeriod.leaves.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

data.leavePeriod.leaves.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

data.leavePeriod.leaves.leaveAccount

object

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

Fields

data.leavePeriod.leaves.leavePeriod

object

data.leavePeriod.leaves.value

string | null

Leave duration in hours

data.leavePeriod.leaves.creationDate

string

Time at which the object was created

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

data.leavePeriod.leaves.cancellationDate

string | null

Time at which the request was canceled

data.leavePeriod.leaves.cancellationUserId

integer | null

Unique identifier for the user who canceled the request

data.leavePeriod.leaves.comment

string

Comments

data.leavePeriod.logs

object[]

data.value

string | null

Leave duration in hours

data.creationDate

string

Time at which the object was created

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

data.cancellationDate

string | null

Time at which the request was canceled

data.cancellationUserId

integer | null

Unique identifier for the user who canceled the request

data.comment

string

Comments

Was this page helpful?

The leave-account resource Get a leave by id

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/leaves

{
  "data": {
    "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": [
        {}
      ],
      "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>"
  }
}