Update employment period

You can use this endpoint to update an existing employment period for an employee.

Request

PUT /api/v1/employees/:username/employment-periods/:id

curl --request PUT \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees/john.doe/employment-periods/42' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
         "id": 42,
         "employee_id": "john.doe",
         "start_date": "2024-01-01",
         "end_date": "2025-12-31",
         "note": "Extended full-time developer position",
         "beginning_of_year": "2024-01-01",
         "annual_leave_entitlement": 32.0,
         "period_holiday_entitlement": 32.0,
         "is_holiday_per_year": true,
         "day_absent_in_hours": 8.0
     }'

Response

{
	"data": {
		"id": 42,
		"employee_id": "john.doe",
		"start_date": "2024-01-01T00:00:00.000000Z",
		"end_date": "2025-12-31T00:00:00.000000Z",
		"note": "Extended full-time developer position",
		"beginning_of_year": "2024-01-01T00:00:00.000000Z",
		"annual_leave_entitlement": 32.0,
		"period_holiday_entitlement": 32.0,
		"is_holiday_per_year": true,
		"day_absent_in_hours": 8.0,
		"created": "2024-09-12T10:30:00.000000Z",
		"modified": "2025-10-07T15:45:00.000000Z"
	}
}

Required Parameters

Name
id
Type
integer
Description
ID of the employment period to update.
Name
employee_id
Type
string
Description
Employee username (max. 32 characters).
Name
start_date
Type
date | Y-m-d
Description
Start date of the employment period (must be before or equal to end_date).

Optional Parameters

Name
end_date
Type
date | Y-m-d
Description
End date of the employment period.
Name
note
Type
string
Description
Note about the employment period (max. 255 characters).
Name
annual_leave_entitlement
Type
float
Description
Annual leave entitlement in days (min. 0).
Name
beginning_of_year
Type
date | Y-m-d
Description
Beginning of the year for holiday calculation.
Name
period_holiday_entitlement
Type
float
Description
Holiday entitlement for the period in days (min. 0).
Name
is_holiday_per_year
Type
boolean
Description
Indicates whether holidays are calculated per year.
Name
day_absent_in_hours
Type
float
Description
Number of hours per absence day (min. 0).

Notes

The id must be a valid, existing employment period
The start_date must be before or equal to end_date
The employee_id must correspond to an existing employee

POST Create Employment Period Customers