v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
WorkCycleExceptions

Retrieve a WorkCycleException.

Retrieve a single WorkCycleException by its ID.

get/api/v3/workcycleExceptions/{id}

Response

OK

{"stackTrail":"components:schemas:WorkCycleException","oasType":"schema","type":"unknown","title":"The WorkCycleException resource","description":"**Represents an override to the employee's WorkCycle.**\n\n**A workcycle is a setup object that indicates the working hours of one or \nseveral employees with a recurring pattern (weekly, monthly, etc...).**\n\nWorkcycles are the basis from where employee's expected working hours are\ncalculated. On top of it, holidays are first added,then workcycleExceptions.\n\nWorkCycleExceptions are overrides to the workcycles.\nThe semantics of a workcycleException is equivalent to \"exceptionally,\nthis employee is going to work a different number of hours on this given\nhalf-day\". A workcycleException may set the work duration to zero, thus \nindicating that the employee is not expected to work on this day.\n\n<Note>An employee may only have a **single** \n`WorkCycleException` on any given half-day (indicated by the `startsAt`\ndate and the `isAm` boolean).</Note>\n\n<Note>When using Lucca Timesheet, submitting a timesheet actually \"locks\"\nthe theoretical working hours of the employee. This means that creating or deleting\nworkcycleExceptions on a day that belongs to a submitted timesheet will automatically\nunapprove said timesheet.</Note>\n\nA `WorkCycleException` must be defined in one \"unit\" (days, hours or time).\nThis unit must be conform to the one of the intersecting WorkCycle for the\nemployee and the date.\n\nExamples:\n\n**\"User #12, managed in \"days\" (`unit: 0`), will finally work on the afternoon of the 01/01/2023\"**\n","extensionFields":{"x-tags":["WorkCycleExceptions"]}}