Sign in

v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB
Employee balance compensations

Returns balance compensations

get/employees/balance-compensations

Query parameters

idinteger

Filters by IDs. Multiple inputs with id[]=1&id[]=2

per_pageinteger

Number of items per Page

pageinteger

Result Page

order_bystring

Order column

order_direction'asc' | 'desc'

Order direction. asc or desc possible

returnstring

Returns a single aggregate over the filtered list instead of the paginated result, e.g. {"data": {"count": 42}}. Allowed values: count, sum.column, min.column, max.column, avg.column (e.g. return=sum.duration_seconds). sum and avg require a numeric column.

group_bystring

Returns one aggregate row per bucket of the given column instead of the paginated result, e.g. group_by=type_id gives {"data": [{"type_id": 1, "count": 5}, ...]}. The per-bucket aggregate reuses the "return=" grammar and defaults to count (e.g. group_by=type_id&return=sum.id). Combine with order_by=<aggregate>&order_direction=desc for "top N" queries. Groupable columns are known model columns plus foreign keys. Datetime columns must be bucketed by granularity: group_by=created_at:month (also :year, :day/:date), giving {"data": [{"created_at": "2026-07", "count": 5}, ...]}. Results are capped at 1000 buckets.

withstring

You can load relations using the with parameter. Example for assignments/appointments: with[]=documents loads all related documents and adds it to the response.

excludeinteger

Exclude ids. Multiple inputs with exclude[]=3&exclude[]=6

employee_idinteger

Filter by employee_id. Multiple inputs with employee_id[]=1&employee_id[]=2

datestring date

Filter by date. Multiple inputs with date[]=2024-01-01&date[]=2024-01-02

Response

Balance compensations list

OR
OR

Example response

{
  "data": [
    {
      "id": 1,
      "employee_id": 1,
      "duration": 480,
      "reason": "Overtime compensation",
      "first_line": "01.01.2024: 08:00",
      "icon": "fa-plus",
      "color": "#68c31d",
      "contrast_color": "WHITE"
    }
  ]
}