KOkombo
Custom Endpoints

Set DATEV compensations

Changed on

Sets the compensations for an employee on the specified effective date.

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.

<Note> This endpoint requires the permission **Manage payroll** to be enabled in [your scope config](/scopes). </Note>

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"
    }
  ]
}
put/custom/datev/employees/{employee_id}/compensations

Request

Path parameters

employee_idstring 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)

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

effective_datestring 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.

Response

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

status'success' required
dataobject required

Changes

  • d0e06abf1118Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • warning

      removed subschema #1 from the request body allOf list

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status

    • info

      added the required property to the response with the status