PUT
/
custom
/
datev
/
employees
/
{employee_id}
/
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": "2022-12-01",
  "compensations": [
    {
      "amount": 4500,
      "currency": "EUR",
      "period": "MONTH",
      "lohnart": 200
    },
    {
      "amount": 30,
      "currency": "EUR",
      "period": "HOUR"
    }
  ]
}'
{
  "status": "success",
  "data": {}
}

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
headerrequired

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
effective_date
string
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

200 - application/json
status
enum<string>
required
Available options:
success
data
object
required