Clockodo API: Abwesenheiten verwalten

Endpunkt api/absences

Über diese Ressource können Sie alle Abwesenheiten auslesen, neue Abwesenheiten eintragen und Vorhandene außerdem bearbeiten, genehmigen oder ablehnen.

Objekttyp „absence“

Parameter Typ Beschreibung
idinteger
Die ID der Abwesenheit
users_idinteger
Die ID des zugehörigen Mitarbeiters
date_sincestring
Startdatum der Abwesenheit im Format YYYY-MM-DD
date_untilstring
Enddatum der Abwesenheit im Format YYYY-MM-DD
statusinteger
Status der Abwesenheit:
0: angefragt/vermerkt
1: genehmigt
2: abgelehnt
3: Genehmigung zurückgezogen
4: Antrag zurückgezogen
typeinteger
Abwesenheitstyp:
1: Normaler Urlaubstag
2: Sonderurlaub
3: Überstundenabbau
4: Krankheit
5: Krankheit eines Kindes
6: Schule / Weiterbildung
7: Mutterschutz
8: Home Office (Sollarbeitszeit gilt)
9: Arbeit außer Haus (Sollarbeitszeit gilt)
10: Sonderurlaub (unbezahlt)
11: Krankheit (unbezahlt)
12: Krankheit eines Kindes (unbezahlt)
13: Quarantäne (nur ganze Tage)
14: Militär-/Ersatzdienst (nur ganze Tage)
15: Krankheit (Krankengeld)
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten oder eigenen Abwesenheiten
notestring|null
Notiz zur Abwesenheit
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten oder eigenen Abwesenheiten
count_daysfloat
Anzahl der Abwesenheitstage (null bei Überstundenabbau)
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten oder eigenen Abwesenheiten
count_hoursfloat|null
Anzahl der Stunden bei Überstundenabbau (sonst null)
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten
sick_noteboolean|null
Liegt eine ärztliche Krankschreibung vor?
Für die Typen 4 und 5
date_enquiredstring|null
Datum an dem der Antrag gestellt wurde im Format YYYY-MM-DD
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten
date_approvedstring|null
Datum an dem der Antrag genehmigt oder abgelehnt wurde im Format YYYY-MM-DD
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten
approved_byinteger|null
Die ID des Mitarbeiters durch welchen die Abwesenheit genehmigt oder abgelehnt wurde
Nur bei bestehenden Verwaltungsrechten für Abwesenheiten

Abwesenheiten auflisten

Anfrage
GET /api/absences
Notwendige Parameter year (integer)
Optionale Parameter users_id (integer)
Antwort
{
  "absences": 
  {
    [object of type absence],
    [object of type absence], 
    ...
  }
}

Einzelne Abwesenheit abrufen

Anfrage
GET /api/absences/[ID]
Antwort
{
  "absence": [object of type absence]
}

Abwesenheit anlegen / Antrag auf Abwesenheit erstellen

Anfrage
POST /api/absences
Notwendige Parameter date_since, date_until, type
Optionale Parameter users_id (falls die ID nicht übergeben wird, wird die Abwesenheit für den ausführenden API-Mitarbeiter erstellt), note, count_days (0.5 für einen halben Tag, wird für längere Abwesenheiten automatisch errechnet), count_hours (wird errechnet falls leer), status (nur 0 oder 1), sick_note
Antwort
{
  "absence": [object of type absence]
}

Abwesenheit bearbeiten

Anfrage
PUT /api/absences/[ID]
Notwendige Parameter keine
Optionale Parameter date_since, date_until, note, type, status, count_days (0.5 für einen halben Tag, wird für längere Abwesenheiten automatisch errechnet), count_hours (wird neu berechnet falls null übergeben wird), sick_note
Antwort
{
  "absence": [object of type absence]
}

Abwesenheit löschen

Nur mit Verwaltungsrechten für Abwesenheiten möglich, wenn die Abwesenheit bereits abgelehnt oder der Antrag zurückgezogen wurde.

Anfrage
DELETE /api/absences/[ID]
Antwort
{
  "success": true
}
stripes illustration
Kontaktieren Sie uns!

Unser Customer-Success-Team steht Ihnen für Fragen zur Verfügung!

Jetzt kontaktieren!
Test endet automatisch! Keine Kündigung notwendig.
Alle Funktionen 14 Tage kostenlos testen
Mit dem Absenden des Formulars akzeptieren Sie unsere AGB und unsere Datenschutz­erklärung und bestätigen, dass Sie Clockodo als Unternehmer nutzen.

Nutzen Sie die Erfahrungen von 10.000 weiteren Unternehmen:

Bechtle Mannheim LogoBechtlePeerigon LogoPeerigon GmbH
Phoenix Logistik LogoPhoenix LogistikFieda LogoFidea