The workcycle-exception resource

Represents an override to the employee's WorkCycle.

A workcycle is a setup object that indicates the working hours of one or several employees with a recurring pattern (weekly, monthly, etc...).

Workcycles are the basis from where employee's expected working hours are calculated. On top of it, holidays are first added,then workcycleExceptions.

WorkCycleExceptions are overrides to the workcycles. The semantics of a workcycleException is equivalent to "exceptionally, this employee is going to work a different number of hours on this given half-day". A workcycleException may set the work duration to zero, thus indicating that the employee is not expected to work on this day.

❗Note: An employee may only have a single WorkCycleException on any given half-day (indicated by the startsAt date and the isAm boolean).

❗Note 2: When using Timmi Timesheet, submitting a timesheet actually "locks" the theoretical working hours of the employee. This means that creating or deleting workcycleExceptions on a day that belongs to a submitted timesheet will automatically unapprove said timesheet.

A WorkCycleException must be defined in one "unit" (days, hours or time). This unit must be conform to the one of the intersecting WorkCycle for the employee and the date.

Examples:

"User #12, managed in "days" (unit: 0), will finally work on the afternoon of the 01/01/2023"

{"startsAt": "2023-01-01T12:00", "isAm": false, "duration": "12:00:00", "unit": 0}

"User #13, managed in "hours" (unit: 1), will finally work 3h30 on the morning of the 01/01/2023"

{"startsAt": "2023-01-01T00:00:00", "isAm": true, "duration": "03:30:00", "unit": 1}

"User #14, managed in "time" unit (unit: 2), will finally work between 09:00 and 12:30 on the morning of the 01/01/2023"

{"startsAt": "2023-01-01T09:00:00", "isAm": true, "duration": "03:30:00", "unit": 2}