Create Employee

This endpoint allows you to create a new employee.

Request

POST /api/v1/employees

curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
         "username": "john.doe",
         "firstname": "John",
         "lastname": "Doe",
         "email": "john.doe@example.com",
         "password": "SecurePassword123!",
         "price_group": "Standard",
         "department_id": 42,
         "phone": "+49 30 123456",
         "rights": "0",
         "employment": "0",
         "birthdate": "1990-01-15",
         "street": "Main Street 123",
         "zip": "10115",
         "city": "Berlin",
         "country": "Germany"
     }'

Response

{
    "data": {
        "id": 12345,
        "username": "john.doe",
        "firstname": "John",
        "lastname": "Doe",
        "email": "john.doe@example.com",
        "price_group": "Standard",
        "department_id": 42,
        "phone": "+49 30 123456",
        "rights": "0",
        "employment": "0",
        "birthdate": "1990-01-15",
        "street": "Main Street 123",
        "zip": "10115",
        "city": "Berlin",
        "country": "Germany",
        "created": "2024-09-17T10:15:47.000000Z",
        "modified": "2024-09-17T10:15:47.000000Z"
    }
}

Required Parameters

Name
username
Type
string
Description
Unique username (5–255 characters).
Name
firstname
Type
string
Description
First name of the employee.
Name
lastname
Type
string
Description
Last name of the employee.
Name
email
Type
string
Description
Unique email address.
Name
password
Type
string
Description
Password (min. 8 characters, max. 48).
Name
price_group
Type
string
Description
Name of the price group.

Optional Parameters

Name
personal_number
Type
string
Description
Personal number (must be unique if provided).
Name
birthdate
Type
date | Y-m-d
Description
Birth date of the employee.
Name
phone
Type
string
Description
Work phone number.
Name
department_id
Type
integer
Description
ID of the department.
Name
rights
Type
string | enum
Description
Access rights: 0 (User), 1 (Admin), 2 (Controller), 3 (User with additional authorizations), 4 (Project Controller).
Name
employment
Type
string | enum
Description
Type of employment: 0 (Employee), 1 (Freelancer), 2 (Freelancer with credit note).
Name
oauthUsername
Type
string
Description
OAuth username (must be unique if provided).

Address Information

Name
street
Type
string
Description
Street address.
Name
zip
Type
string
Description
Postal code.
Name
city
Type
string
Description
City.
Name
country
Type
string
Description
Country.

Personal Information

Name
abbreviation
Type
string
Description
Employee abbreviation.
Name
salutation
Type
string
Description
Salutation.
Name
title
Type
string
Description
Title (e.g., Dr., Prof.).
Name
mobile
Type
string
Description
Mobile phone number.
Name
fax
Type
string
Description
Fax number.
Name
private_phone
Type
string
Description
Private phone number.

Banking Information

Name
iban
Type
string
Description
IBAN.
Name
bic
Type
string
Description
BIC/SWIFT code.
Name
account_no
Type
string
Description
Account number.
Name
bank_name
Type
string
Description
Bank name.
Name
bank_code
Type
string
Description
Bank code.
Name
currency
Type
string
Description
Currency code.

Additional Information

Name
approval_date
Type
date | Y-m-d
Description
Approval date.
Name
vat
Type
string
Description
VAT number.
Name
personio_id
Type
string
Description
Personio ID.
Name
cost_bearer
Type
string
Description
Cost bearer.
Name
tax_id
Type
string
Description
Tax ID.
Name
creditor_number
Type
string
Description
Creditor number.
Name
categories
Type
array
Description
List of category strings.
Name
dynamicAttributes
Type
array
Description
List of dynamic attribute objects.

GET All Employees GET Employee Details