Payroll

Get the salary items that can be added to an employee's payslip.

Resolves the employee's main (latest) contract and its editable payslip, then returns the salary-item types that can be added to that payslip as blank templates (numeric value fields cleared, distinct by <code>code</code>), together with the resolved <code>contractId</code> and <code>payslipId</code> so the response can be chained into the add-salary-item call. <strong>Prerequisite:</strong> call <code>GET /employees/short-info</code> first to resolve the <code>employeeId</code> path parameter from the returned entries' <code>id</code> field. When <code>month</code> is provided that month's payslip is used; when it is omitted the employee's current payslip is used. An employee who has left (inactive) is rejected with <code>400</code>. This call does not recalculate or create payslips, with one exception: the current payslip may be created on first access. A month whose payslip is already sealed (paid) is rejected with <code>400</code>, and a month for which no payslip exists (e.g. a future month) returns <code>404</code>. The tenant and company are derived from the authenticated token; the caller must hold the <code>COMPENSATION</code> permission on that company.

get/core/v1/payroll/employees/{employeeId}/addable-salary-items

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/v1/payroll/employees/{employeeId}/addable-salary-items
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Path parameters

employeeIdinteger required
Example:1

Id of the employee whose addable salary items are resolved. Obtained from the <code>id</code> field of an entry returned by <code>GET /employees/short-info</code>.

Query parameters

monthstring
Example:06.2025

Payslip month in the format MM.yyyy (e.g. 06.2025). If omitted, the employee's current payslip is used. The month's payslip must exist and must not be sealed (see the operation description).

Headers

Accept-Languagestring
Example:de-CH

Preferred language for localised salary-item descriptions, as an IETF language tag. Examples: de-CH, fr-CH, it-CH, en. Defaults to the tenant's language when omitted.

Response

Successful operation

employeeIdinteger

Id of the employee the addable salary items were resolved for.

contractIdinteger

Id of the employee's resolved main (latest) contract. Pass this to the add-salary-item call.

payslipIdinteger

Id of the resolved editable payslip. Pass this to the add-salary-item call.

periodFromstring date-time

Month (first day) of the resolved payslip (yyyy-MM-ddT00:00:00Z).

Example response

{
  "employeeId": 3487,
  "contractId": 9021,
  "payslipId": 9542,
  "periodFrom": "2018-03-01T00:00:00Z",
  "salaryItems": [
    {
      "code": "1005",
      "name": "Hourly Salary",
      "description": "Stundenlohn",
      "editableFields": "baseValue,quantity",
      "duplicatable": true,
      "showOnPayslip": true,
      "paymentTypeSit": "BANK",
      "salaryItemTypeId": 42,
      "accountingGroup": "SALARY",
      "printSequence": 100
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.