Documentation
Organization Structure API
Core HR API
Expenses API
Invoices API
Absences API
Office API
Project API
Schedule API
Timesheet API
Mealvouchers API
Compensation API
Training API
{
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"tuesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"wednesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"thursday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"friday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"saturday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
},
"sunday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"iso": "<string>"
}
}
},
"splitsHalfDays": true,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25"
}The collective-schedule resource
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.
The Pattern this Collective Schedule implements. Depends on the Shape.
- Single week SchedulePattern
- Odd-even weeks Schedule Pattern
Show child attributes
Show child attributes
singleWeek, oddEvenWeeks Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Should half-days be discriminated? In other words, should shifts belong to half days rather than just the day itself?
The date (included) from which this Collective Schedule is applicable. Must be left null for the very first Collective Schedule of a Working Time Arrangement.
The date (included) from which this Collective Schedule is no longer applicable. Is null for the last Collective Schedule of a Working Time Arrangement. Can not be modified as its equal to the day before the next applicable Collective Schedule for this Working Time Arrangement.
Was this page helpful?