The shift-override resource

Documentation

Files

Organization Structure API

Core HR API

Recruitment API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

{
  "id": 1,
  "employee": {
    "id": 1
  },
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "duration": {
    "value": 1,
    "iso": "<string>"
  },
  "isLocked": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "comment": "<string>",
  "createdBy": {
    "id": 1
  },
  "lastUpdatedBy": {
    "id": 1
  }
}

Represents a one-time override of an employee's regular work schedule for a specific period.

integer<int32>

required

Unique identifier of the ShiftOverride.

Required range: x >= 0

employee

object

required

The employee this override applies to.

Show child attributes

position

enum<string>

required

Available options:

firstHalf,

secondHalf,

fullDay

startsAt

string<date-time>

required

Start date-time of the override.

endsAt

string<date-time>

required

End date-time of the override.

duration

Duration · object

required

The duration of the override.

Show child attributes

workCycleUnit

enum<string>

required

The unit of the work cycle for this override.

day: duration expressed in days.
hour: duration expressed in hours.
time: duration expressed in hours with a specific start time.

Available options:

day,

hour,

time

nature

enum<string>

required

The nature of the shift override.

worked: the employee is working.
off: the employee is off.
partTime: part-time day.
weeklyRest: weekly rest day.

Available options:

worked,

off,

partTime,

weeklyRest

isLocked

boolean

required

Whether the override is locked (cannot be modified).

createdAt

string<date-time>

required

Date-time when the override was created.

lastUpdatedAt

string<date-time>

required

Date-time when the override was last updated.

comment

null | string

Optional comment associated with the override.

createdBy

null | object

The user who created the override.

Show child attributes

lastUpdatedBy

null | object

The user who last updated the override.

Show child attributes