Salarisadministratie

Doel: je salarissoftware of salarisadministratiekantoor voeden met effectieve uren, afwezigheden en verlofsaldi van een periode, zonder handmatige exports.

Vereiste scopes: org:fichajes:read, org:ausencias:read, org:saldos:read.

De drie kernresources:

• GET /v1/work-summaries — de salarisresource: afgesloten aggregaties van werktijd per medewerker en periode.
• GET /v1/absences — ziekteverzuim, verlof en inhoudingen van de periode.
• GET /v1/vacation-balances — verlofsaldi voor de afsluiting.

Work summaries: uren van de periode

work-summaries retourneert één rij per medewerker × periode met de aggregaties al berekend (geen losse klok-events). Filter op period=day|month en een bereik from/to (≤ 1 jaar).

curl -s "$KINMU_BASE_URL/work-summaries?period=month&from=2026-06-01&to=2026-06-30" \
  -H "Authorization: Bearer $KINMU_API_KEY"

{
  "data": [
    {
      "employee_id": "a1b2…",
      "period_start": "2026-06-01",
      "period_end": "2026-06-30",
      "worked_minutes": 9600,
      "break_minutes": 1200,
      "night_minutes": 300,
      "overtime_minutes": 240,
      "expected_minutes": 9600,
      "balance_minutes": 0,
      "banked_hours_balance_minutes": 120,
      "absences_minutes": 480,
      "source_days": 21
    }
  ],
  "meta": { "next_cursor": null, "has_more": false }
}

Relevante velden voor de salarisadministratie:

Afwezigheden van de periode

Koppel de goedgekeurde afwezigheden die met de salarisperiode overlappen om ziekteverzuim en inhoudingen toe te passen:

curl -s "$KINMU_BASE_URL/absences?status=approved&from=2026-06-01&to=2026-06-30" \
  -H "Authorization: Bearer $KINMU_API_KEY"

Elke afwezigheid heeft een type als { key, label } (de key is stabiel: vacation, sick_leave, of custom typen van je bedrijf) en een days_count. Gebruik in je logica altijd de key.

Verlofsaldi

Vraag voor de jaarafsluiting of voor reserveringen de saldi per medewerker en jaar op:

curl -s "$KINMU_BASE_URL/vacation-balances?year=2026" \
  -H "Authorization: Bearer $KINMU_API_KEY"

{
  "data": [
    {
      "employee_id": "a1b2…",
      "year": 2026,
      "entitled_days": 23,
      "used_days": 10,
      "pending_days": 2,
      "remaining_days": 11,
      "carry_over_days": 0,
      "carry_over_expires_at": null
    }
  ]
}

Flow van de maandafsluiting

curl -s -X POST "$KINMU_BASE_URL/reports" \
  -H "Authorization: Bearer $KINMU_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ "type": "time_registry_monthly", "format": "csv", "params": { "month": "2026-06" } }'

# 1) obtener la download_url (solo aparece cuando status=completed)
DL=$(curl -s "$KINMU_BASE_URL/reports/<id>" \
  -H "Authorization: Bearer $KINMU_API_KEY" | jq -r '.download_url')
 
# 2) descargar el fichero desde la URL firmada (sin Bearer; un solo uso, 5 min)
curl -s -L "$DL" -o registro-horario-2026-06.csv