List UserDates. - Lucca API

Community

Status

Documentation

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
Exports

Cleemy Invoices API

Guides

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
- The user-date resource
- GET
  List 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

GET

api

userdates

curl --request GET \
  --url https://{host}/api/v3/userdates \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "dtt": "07:00:00",
        "drt": "04:15:00",
        "draj": "03:30:00",
        "isHoliday": true,
        "isWeeklyRest": true,
        "items": [
          {
            "type": "ptt",
            "startsAt": "2023-11-07T05:31:56Z",
            "duration": "<string>",
            "timeline": "WorkCycle"
          }
        ],
        "am": {
          "dtt": "07:00:00",
          "drt": "04:15:00",
          "draj": "03:30:00",
          "isHoliday": true,
          "isWeeklyRest": true,
          "items": [
            {
              "type": "ptt",
              "startsAt": "2023-11-07T05:31:56Z",
              "duration": "<string>",
              "timeline": "WorkCycle"
            }
          ]
        },
        "pm": {
          "dtt": "07:00:00",
          "drt": "04:15:00",
          "draj": "03:30:00",
          "isHoliday": true,
          "isWeeklyRest": true,
          "items": [
            {
              "type": "ptt",
              "startsAt": "2023-11-07T05:31:56Z",
              "duration": "<string>",
              "timeline": "WorkCycle"
            }
          ]
        }
      }
    ]
  }
}

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

ownerId

integer[]

required

User's identifiers.

date

string

required

The period over which working hours should be returned for given Users. Format: 'between,{start},{includedEnd}'.

Example:

"between,2021-01-01,2021-02-01"

fields

string[]

List of all fields to be returned by the server. Example: ?fields=ownerId,date,dtt,drt,draj, items[startsAt,duration,type,timeline

Response

200

application/json

data

object

data.items

object[]

Userdates are a resource that aggregate all events related to the working schedule of an employee. There are two types of events: (1) those related to the theoretical working hours of the employee (workcycle, holidays, workcycleExceptions) and (2) those related to the actual working hours of the employee (leaves, time-entries).

A Userdate aggregates:

theoretical hours indicated by the employee's workcycle.
overrides to the workcycle indicated by the holidays calendar given to the employee.
overrides to the workcycle indicated by workcycleExceptions.
actual hours from Timmi Timesheet.
leaves taken in Timmi Absences.

About durations

The interpretation of durations depends on the time unit applicable to the User.

For instance, '12:00:00' means:

A half-day (or 0.5 d) in days unit.
12 hours in hours or time units.

The applicable unit is set on the User's WorkCycle.

data.items.dtt

string

Theoretical working time. The work duration the User should comply with on this day.

Example:

"07:00:00"

data.items.drt

string

Actual working time. The actual time the User spent working on this day.

Example:

"04:15:00"

data.items.draj

string

Leave duration.

Example:

"03:30:00"

data.items.isHoliday

boolean

Is this day a holiday in the User's holidays calendar?

data.items.isWeeklyRest

boolean

Is this the weekly rest day (most often, Sundays) in the User's workcycle?

data.items.items

object[]

All events for this day and User.

data.items.am

object

Description of the first half of the day.

data.items.pm

object

Description of the second half of this day.

Was this page helpful?

The user-date resource

The workcycle-exception resource

curl --request GET \
  --url https://{host}/api/v3/userdates \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "dtt": "07:00:00",
        "drt": "04:15:00",
        "draj": "03:30:00",
        "isHoliday": true,
        "isWeeklyRest": true,
        "items": [
          {
            "type": "ptt",
            "startsAt": "2023-11-07T05:31:56Z",
            "duration": "<string>",
            "timeline": "WorkCycle"
          }
        ],
        "am": {
          "dtt": "07:00:00",
          "drt": "04:15:00",
          "draj": "03:30:00",
          "isHoliday": true,
          "isWeeklyRest": true,
          "items": [
            {
              "type": "ptt",
              "startsAt": "2023-11-07T05:31:56Z",
              "duration": "<string>",
              "timeline": "WorkCycle"
            }
          ]
        },
        "pm": {
          "dtt": "07:00:00",
          "drt": "04:15:00",
          "draj": "03:30:00",
          "isHoliday": true,
          "isWeeklyRest": true,
          "items": [
            {
              "type": "ptt",
              "startsAt": "2023-11-07T05:31:56Z",
              "duration": "<string>",
              "timeline": "WorkCycle"
            }
          ]
        }
      }
    ]
  }
}