The collective-schedule resource

Community

Status

Documentation

Files

Organization Structure API

Core HR API

Cleemy Expenses API

Cleemy Invoices API

Timmi Absences API

Timmi Office API

Timmi Project API

Timmi Settings API

Timmi Timesheet API

Pagga Mealvouchers API

Pagga Remuneration API

Poplee Training API

A Collective Schedule describes the employees' expected working hours over a week.

It comes in two shapes:

"Single Week": Working hours are identical every week.
"Odd / Even Weeks": Working hours depend on the oddness of the week.

Get a Working Time Arrangement by id.

List Collective Schedules from a Working Time Arrangement

{
  "id": 1,
  "workingTimeArrangementId": 1,
  "startsOn": "2023-12-25",
  "endsOn": "2023-12-25",
  "pattern": {
    "shape": "singleWeek",
    "monday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "tuesday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "wednesday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "thursday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "friday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "saturday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    },
    "sunday": {
      "id": 1,
      "dayOffType": "off",
      "shifts": [
        {
          "position": "firstHalf",
          "startsAt": "<string>",
          "duration": {
            "value": 1,
            "iso": "<string>",
            "unit": "days"
          }
        }
      ],
      "workDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      }
    }
  },
  "splitsHalfDays": true
}