Skip to main content
PUT
/
custom
/
datev
/
employees
/
{employee_id}
/
compensations
Set DATEV compensations
curl --request PUT \
  --url https://api.kombo.dev/v1/custom/datev/employees/{employee_id}/compensations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '
{
  "effective_date": "2023-11-07T05:31:56Z",
  "compensations": [
    {
      "amount": -1.7976931348623157e+308,
      "currency": "<string>",
      "period": "HOUR",
      "lohnart": 5000
    }
  ]
}
'
{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}
Other compensations will end at the effective date. That means, if you would like to add a compensation, you also have to include the compensations that you would like to keep.
This endpoint requires the permission Manage payroll to be enabled in your scope config.

​
Example Request Body

{
  "employee_id": "3bdhemmSP1TPQDGWtRveRot9",
  "effective_date": "2022-12-01",
  "compensations": [
    {
      "amount": 4500,
      "currency": "EUR",
      "period": "MONTH",
      "lohnart": 200
    },
    {
      "amount": 30,
      "currency": "EUR",
      "period": "HOUR"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
employee_id
string
required

ID of the employee that should be updated. You can use their Kombo id or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)

Body

application/json

PUT /custom/datev/employees/:employee_id/compensations Request body

​
effective_date
string<date-time>
required

Date from which the submitted compensations should be valid. Please note that it might not be possible to set compensations for the past if the payroll was already run.

​
compensations
object[]
required

Response

PUT /custom/datev/employees/:employee_id/compensations Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.