Skip to main content

A working time arrangement is an object aimed at drawing employees populations regarding time management rules.

It is attached to employees through their work contract and essentially dictates:

  • their contractual working time, ie how many hours / days they are paid for each week / year.
  • a full time equivalent based on the the ratio between this contractual work duration and a "full time work duration".
  • a succession of Collective Schedules that describe their usual working hours.
  • the applicable regulation in Lucca Timesheet.
​
id
integer<int32>
required

The unique identifier of this Working Time Arrangement.

Required range: x >= 0
​
name
string
required

The unique name for this Working Time Arrangement.

Required string length: 3 - 1000
​
description
string | null
required

An optional description.

Maximum string length: 5000
​
unit
enum<string>
required

An event can be set in:

  • Day: "I worked for a half day last Monday".
  • Hour: "I worked for 2 hours last Monday".
  • Time: "I worked between 10:00 AM and 12:00 AM last Monday".
Available options:
day,
hour,
time
​
fullTimeEquivalent
number<decimal>
required

By default, equal to the ratio between the Contract Working Time Duration and the Reference Working Time Duration.

Required range: 0 <= x <= 1Must be a multiple of 0.0001
​
publicHolidaysCalendar
PublicHolidayCalendar, · object
required

Unique identifier of the Public Holidays Calendar applicable to these employees.

​
authorizedCommands
enum<string>[]
required

The actions the current authenticated User can make on this Working Time Arrangement. Depends on his permissions.

Available options:
create,
update,
delete,
archive,
unarchive
​
referencePeriod
Week · object

The period the Contract Working Time Duration applies over.

​
contractWorkingTimeDuration
Duration · object

How many hours / days these employees are paid for every Reference Period?

​
referenceWorkingTimeDuration
Duration · object

The number of hours / days for a full-time employee over the same Reference Period.

​
fullDayAbsenceDurationInHours
number<decimal> | null

Duration in hours of a full day of absence. When left null, is equal to the number of hours indicated on the given day in the applicable Collective Schedule.

Required range: x >= 0Must be a multiple of 0.0001
​
timesheetRegulation
Lucca Timesheet regulation · object

The applicable Lucca Timesheet regulation, which contains all rules regarding time tracking management in this application.

​
currentSchedulePatternSummary
Summary of a Schedule Pattern · object

A summary of the expected working hours, given the currently ongoing Schedule Pattern.