Skip to main content
POST
/
api
/
v2
/
employees
cURL
curl --request POST \
  --url https://api.become1.de/api/v2/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "personnelNumber": "<string>",
  "companyId": "<string>",
  "costCenter": "<string>",
  "groups": [
    "<array>"
  ],
  "dateTerminated": "2023-11-07T05:31:56Z",
  "skipSendRegistrationEmail": true
}
'
{
  "email": "<string>",
  "employeeId": "<string>",
  "companyId": "<string>",
  "personnelNumber": "<string>",
  "costCenter": "<string>",
  "groups": [
    "<string>"
  ],
  "datePausedStart": "2023-11-07T05:31:56Z",
  "datePausedEnd": "2023-11-07T05:31:56Z",
  "dateTerminated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string
required
​
personnelNumber
string
required

The employee is important for the import / export to payroll.

​
companyId
string | null

The company the employee belongs to.

​
costCenter
string | null

The cost center helps to organize employees, but is mainly important for the import / export to payroll.

​
groups
array[] | null

Groups help to organize employees.

​
dateTerminated
string<date-time>

The date when the employee should be terminated. When set, the access to any benefits will be terminated on this date.

For goodies, this means planned vouchers will have the endDate set to this date.

         For flex, all access will also be have the validUntil set to this date.
​
skipSendRegistrationEmail
boolean

Response

200 - application/json
​
email
string
required
​
employeeId
string
required
​
companyId
string
required
​
personnelNumber
string
required
​
costCenter
string | null
​
groups
string[] | null
​
datePausedStart
string<date-time> | null
​
datePausedEnd
string<date-time> | null
​
dateTerminated
string<date-time> | null