Create a regular working time

Records a new regular working-time schedule for the given employee.

Availability: Full version and ZEP Clock

Request

POST /api/v1/employees/{username}/regular-working-times

curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees/{username}/regular-working-times' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "employee_id": "max.mustermann",
       "start_date": "2024-01-15T00:00:00.000000Z",
       "monday": 8,
       "tuesday": 8,
       "wednesday": 4,
       "thursday": 8,
       "friday": 6,
       "saturday": 0,
       "sunday": 0,
       "monday_workday": true,
       "tuesday_workday": true,
       "wednesday_workday": true,
       "thursday_workday": true,
       "friday_workday": true,
       "saturday_workday": true,
       "sunday_workday": true,
       "is_monthly": true,
       "monthly_hours": 150.34,
       "max_hours_in_month": 137.51,
       "max_hours_in_week": 74.25,
       "break_regulation_type_id": 1,
       "holiday_calendar_id": 1
     }'

Path parameters

Name
username
Type
string
Description
The employee username

Request body

Name
employee_id
Type
string, required
Description
Username of the employee this schedule applies to.
Name
start_date
Type
string (date-time)
Description
Calendar day this schedule takes effect from.
Name
monday
Type
number, nullable
Description
Planned working hours on Monday.
Name
tuesday
Type
number, nullable
Description
Planned working hours on Tuesday.
Name
wednesday
Type
number, nullable
Description
Planned working hours on Wednesday.
Name
thursday
Type
number, nullable
Description
Planned working hours on Thursday.
Name
friday
Type
number, nullable
Description
Planned working hours on Friday.
Name
saturday
Type
number, nullable
Description
Planned working hours on Saturday.
Name
sunday
Type
number, nullable
Description
Planned working hours on Sunday.
Name
monday_workday
Type
boolean, nullable
Description
Whether Monday counts as a workday for this schedule.
Name
tuesday_workday
Type
boolean, nullable
Description
Whether Tuesday counts as a workday for this schedule.
Name
wednesday_workday
Type
boolean, nullable
Description
Whether Wednesday counts as a workday for this schedule.
Name
thursday_workday
Type
boolean, nullable
Description
Whether Thursday counts as a workday for this schedule.
Name
friday_workday
Type
boolean, nullable
Description
Whether Friday counts as a workday for this schedule.
Name
saturday_workday
Type
boolean, nullable
Description
Whether Saturday counts as a workday for this schedule.
Name
sunday_workday
Type
boolean, nullable
Description
Whether Sunday counts as a workday for this schedule.
Name
is_monthly
Type
boolean, nullable
Description
Whether the schedule is defined as a monthly total instead of per weekday.
Name
monthly_hours
Type
number, nullable
Description
Planned working hours per month, only used when the schedule is monthly.
Name
max_hours_in_month
Type
number, nullable
Description
Maximum working hours allowed per month under this schedule.
Name
max_hours_in_week
Type
number, nullable
Description
Maximum working hours allowed per week under this schedule.
Name
break_regulation_type_id
Type
integer, nullable
Description
Identifier of the break regulation applied to this schedule.
Name
holiday_calendar_id
Type
integer, nullable
Description
Identifier of the holiday calendar this schedule’s public holidays are drawn from.

Response

{
  "data": {
    "id": 1,
    "employee_id": "max.mustermann",
    "start_date": "2024-01-15T00:00:00.000000Z",
    "monday": 8,
    "monday_workday": true,
    "tuesday": 8,
    "tuesday_workday": true,
    "wednesday": 4,
    "wednesday_workday": true,
    "thursday": 8,
    "thursday_workday": true,
    "friday": 6,
    "friday_workday": true,
    "saturday": 0,
    "saturday_workday": true,
    "sunday": 0,
    "sunday_workday": true,
    "is_monthly": true,
    "monthly_hours": 150.34,
    "max_hours_in_month": 137.51,
    "max_hours_in_week": 74.25,
    "holidayCalendar": {
      "id": 1,
      "name": "EU",
      "note": "Familienurlaub",
      "country": "Deutschland",
      "region": "East Tabitha",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    },
    "breakRegulationType": {
      "id": 1,
      "name": "EU",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the regular working-time schedule.
Name
employee_id
Type
string
Description
Username of the employee this schedule applies to.
Name
start_date
Type
string (date-time), nullable
Description
Calendar day this schedule takes effect from.
Name
monday
Type
number, nullable
Description
Planned working hours on Monday.
Name
monday_workday
Type
boolean, nullable
Description
Whether Monday counts as a workday for this schedule.
Name
tuesday
Type
number, nullable
Description
Planned working hours on Tuesday.
Name
tuesday_workday
Type
boolean, nullable
Description
Whether Tuesday counts as a workday for this schedule.
Name
wednesday
Type
number, nullable
Description
Planned working hours on Wednesday.
Name
wednesday_workday
Type
boolean, nullable
Description
Whether Wednesday counts as a workday for this schedule.
Name
thursday
Type
number, nullable
Description
Planned working hours on Thursday.
Name
thursday_workday
Type
boolean, nullable
Description
Whether Thursday counts as a workday for this schedule.
Name
friday
Type
number, nullable
Description
Planned working hours on Friday.
Name
friday_workday
Type
boolean, nullable
Description
Whether Friday counts as a workday for this schedule.
Name
saturday
Type
number, nullable
Description
Planned working hours on Saturday.
Name
saturday_workday
Type
boolean, nullable
Description
Whether Saturday counts as a workday for this schedule.
Name
sunday
Type
number, nullable
Description
Planned working hours on Sunday.
Name
sunday_workday
Type
boolean, nullable
Description
Whether Sunday counts as a workday for this schedule.
Name
is_monthly
Type
boolean, nullable
Description
Whether the schedule is defined as a monthly total instead of per weekday.
Name
monthly_hours
Type
number, nullable
Description
Planned working hours per month, only set when the schedule is monthly.
Name
max_hours_in_month
Type
number, nullable
Description
Maximum working hours allowed per month under this schedule.
Name
max_hours_in_week
Type
number, nullable
Description
Maximum working hours allowed per week under this schedule.
Name
holidayCalendar
Type
object (HolidayCalendar)
Description
Holiday calendar this schedule’s public holidays are drawn from.
Name
holidayCalendar.id
Type
integer
Description
Unique identifier of the holiday calendar.
Name
holidayCalendar.name
Type
string
Description
Short designation of the holiday calendar.
Name
holidayCalendar.note
Type
string, nullable
Description
Free-text note attached to the holiday calendar.
Name
holidayCalendar.country
Type
string, nullable
Description
Country whose public holidays this calendar covers.
Name
holidayCalendar.region
Type
string, nullable
Description
Region or state within the country this calendar covers, if narrowed down.
Name
holidayCalendar.created
Type
string (date-time), nullable
Description
Timestamp the holiday calendar was created.
Name
holidayCalendar.modified
Type
string (date-time), nullable
Description
Timestamp the holiday calendar was last modified.
Name
breakRegulationType
Type
object (BreakRegulationType)
Description
Break regulation applied when calculating breaks for this schedule.
Name
breakRegulationType.id
Type
integer
Description
Unique identifier of the break regulation.
Name
breakRegulationType.name
Type
string
Description
Display name of the break regulation.
Name
breakRegulationType.created
Type
string (date-time), nullable
Description
Timestamp the break regulation was created.
Name
breakRegulationType.modified
Type
string (date-time), nullable
Description
Timestamp the break regulation was last modified.

Generated from the OpenAPI specification — edit the source code, not this page.

GET List an employee's regular working times GET Get a single regular working time