clocko:do API:
Stundenkonten auslesen

Endpunkt api/userreports

Über diese Ressource können Sie alle Informationen auslesen, die Sie aus den Stundenkonten von clocko:do kennen.

Dies sind alle Details der Mitarbeiter-Stundenkonten bis hin zu den Soll- und Ist-Stunden zu jedem einzelnen Tag, aber auch der Status der Urlaubskonten.

Objekttyp „userreport“

Bitte beachten Sie, dass der Objekttyp "userreport" in seiner Eigenschaft "month_details" ein Array von weiteren Objekten des Typs "userreport_month" enthalten kann, sodass sich eine verschachtelte Array-Struktur ergibt.

Vergleichen Sie dazu auch dieses Beispiel einer Rückgabe.

Parameter Typ Beschreibung
users_idinteger
Die ID des zugehörigen Mitarbeiters
users_namestring
Name des zugehörigen Mitarbeiters
sum_absence[military_service]integer
Anzahl Tage Militär-/Ersatzdienst
sum_absence[quarantine]integer
Anzahl Tage Quarantäne
sum_absence[out_of_office]float
Anzahl Tage Arbeit außer Haus
sum_absence[home_office]float
Anzahl Tage Home Office
sum_absence[maternity_protection]float
Anzahl Tage Mutterschutz
sum_absence[school]float
Anzahl Tage Schule
sum_absence[special_leaves]float
Anzahl Tage Sonderurlaub
sum_absence[sick_child]integer
Anzahl Krankheitstage eines Kindes
sum_absence[sick_self]integer
Anzahl Krankheitstage
sum_absence[regular_holidays]float
Anzahl genutzter Urlaubstage aus dem Kontingent
holidays_carryfloat
Urlaubsübertrag der für das Jahr gilt
holidays_quotafloat
Urlaubskontingent
diffinteger
Errechnete Differenz des Stundenkontos (in Sekunden)
overtime_reducedinteger
Für das Jahr gestrichende Überstunden (in Sekunden)
overtime_carryoverinteger
Überstundenübertrag der für das Jahr gilt (in Sekunden)
sum_reduction_plannedinteger
Summe an geplantem Überstundenabbau (in Sekunden)
sum_reduction_usedinteger
Summe wirklich abgefeierter Überstunden; zu unterscheiden von angemeldetem Überstundenabbau (in Sekunden)
sum_hoursinteger
Geleistete Arbeitszeit im Jahr (in Sekunden)
sum_targetinteger|null
Soll-Arbeitszeit für das Jahr (in Sekunden)
users_emailstring
E-Mail-Adresse des zugehörigen Mitarbeiters
users_numberstring|null
Personalnummer des zugehörigen Mitarbeiters
month_detailsArray von Objekten des Typen "userreport_month"
Nur wenn Monatsdetails angefragt werden

Objekttyp „userreport_month“

Dieser Objekttyp wird innerhalb der Eigenschaft "month_details" im Hauptobjekt vom Typ "userreport" verwendet.

Parameter Typ Beschreibung
nrinteger
Monatsnummer (1 bis 12)
sum_targetinteger|null
Soll-Arbeitszeit (in Sekunden)
sum_hoursinteger
Geleistete Arbeitszeit (in Sekunden)
sum_hours_without_ compensationinteger
Geleistete Arbeitszeit bei Ignorierung monatsweiser automatischer Kompensierung (in Sekunden)
sum_reduction_usedinteger
Summe wirklich abgefeierter Überstunden; zu unterscheiden von angemeldetem Überstundenabbau (in Sekunden)
sum_overtime_reducedinteger
Summe ausbezahlter / gestrichener Überstunden (in Sekunden)
diffinteger
Errechnete Differenz des Stundenkontos (in Sekunden)
week_detailsArray von Objekten des Typen "userreport_week"
Nur wenn Wochendetails angefragt werden

Objekttyp „userreport_week“

Dieser Objekttyp wird innerhalb der Eigenschaft "week_details" im Objekt vom Typ "userreport_month" verwendet.

Parameter Typ Beschreibung
nrinteger
Wochennummer nach ISO 8601
sum_targetinteger|null
Soll-Arbeitszeit (in Sekunden)
sum_hoursinteger
Geleistete Arbeitszeit (in Sekunden)
sum_reduction_usedinteger
Summe wirklich abgefeierter Überstunden; zu unterscheiden von angemeldetem Überstundenabbau (in Sekunden)
diffinteger
Errechnete Differenz des Stundenkontos (in Sekunden)
day_detailsArray von Objekten des Typen "userreport_day"
Nur wenn Tagesdetails angefragt werden

Objekttyp „userreport_day“

Dieser Objekttyp wird innerhalb der Eigenschaft "day_details" im Objekt vom Typ "userreport_week" verwendet.

Parameter Typ Beschreibung
datestring
Datum
count_absence[sick_self]integer
Abwesenheit wegen Krankheit an diesem Tag (0 oder 1)
count_reduction_usedinteger|null
Abgefeierte Überstunden; zu unterscheiden von angemeldetem Überstundenabbau (in Sekunden)
count_absence[military_service]integer
Abwesenheit wegen Militär-/Ersatzdienst an diesem Tag (0 oder 1)
count_absence[quarantine]integer
Quarantäne an diesem Tag (0 oder 1)
count_absence[out_of_office]float
Arbeit außer Haus an diesem Tag (0, 0.5 oder 1)
count_absence[home_office]float
Home-Office an diesem Tag (0, 0.5 oder 1)
count_absence[maternity_protection]float
Abwesenheit wegen Mutterschutz an diesem Tag (0, 0.5 oder 1)
count_absence[school]float
Abwesenheit wegen Schule / Weiterbildung an diesem Tag (0, 0.5 oder 1)
count_absence[special_leaves]float
Abwesenheit wegen Sonderurlaub an diesem Tag (0, 0.5 oder 1)
weekdayinteger
Nummer, welchen den Wochentag identifiziert
count_absence[sick_child]integer
Abwesenheit wegen Krankheit eines Kindes an diesem Tag (0 oder 1)
count_absence[regular_holidays]float
Genutzter regulärer Urlaub für diesen Tag (0, 0.5 oder 1)
breaksarray
Durchgeführte Pausen (Unter-Array-Schlüssel: [string] since, [string] until, [integer] length)
Nur falls der Berichtstyp „4“ angefragt wird; wird nicht für Tage in der Zukunft ausgegeben
work_endstring|null
Ende der Arbeitszeit (z.B. im Format „YYYY-MM-DD HH:MM:SS“; vgl. Abschnitt „Lokalisierung“)
Nur falls der Berichtstyp „4“ angefragt wird; wird nicht für Tage in der Zukunft ausgegeben
work_startstring|null
Beginn der Arbeitszeit (z.B. im Format „YYYY-MM-DD HH:MM:SS“; vgl. Abschnitt „Lokalisierung“)
Nur falls der Berichtstyp „4“ angefragt wird; wird nicht für Tage in der Zukunft ausgegeben
diffinteger
Errechnete Differenz des Stundenkontos (in Sekunden)
Wird nicht für Tage in der Zukunft ausgegeben
hours_without_compensationinteger|null
Geleistete Arbeitszeit bei Ignorierung tageweiser automatischer Kompensierung (in Sekunden)
Wird nicht für Tage in der Zukunft ausgegeben
hoursinteger|null
Geleistete Arbeitszeit (in Sekunden)
Wird nicht für Tage in der Zukunft ausgegeben
target_rawinteger|null
Soll-Arbeitszeit die sich ergeben hätte, wenn diese nicht durch einen Feiertag oder eine Abwesenheit (Urlaub, Überstundenabbau, ...) reduziert worden wäre (in Sekunden)
targetinteger|null
Soll-Arbeitszeit (in Sekunden)
nonbusinessboolean
Ist der Tag ein Feiertag?

Berichte zu allen Mitarbeitern abrufen

Anfrage
GET /api/userreports
Notwendige Parameter yearinteger
Optionale Parameter typeinteger
0: Es werden nur Kennzahlen zum Jahr ausgegeben (default)
1: Es werden auch Kennzahlen zu Monaten ausgeben
2: Es werden auch Monats-und Wochen-Kennzahlen ausgeben
3: Es werden auch Monats-, Wochen- und Tageskennzahlen ausgegeben
4: Es werden auch Monats-, Wochen- und Tageskennzahlen ausgegeben, sowie tageweise die Beginn- und Endzeit der Arbeit und Pausen
Antwort
{
  "userreports": 
  [
    [object of type userreport],
    [object of type userreport], 
    ...
  ]
}
Beispielhafte verschachtelte Antwort bei Nutzung der vollen Details (Anfragetyp 3):
{
  "userreports": 
  [
    {
      'id' : 123,
      'name': 'Max Mustermann',
      'sum_target': 1419,
      ...
      'month_details' : 
      [
      	{
          'nr': 1,
          'sum_target': 142,
          ...,
          'week_details': 
          [
            {
              'nr': 1,
              'sum_target': 40,
              ...
              'day_details': 
              [
                {
                  'date': '2016-01-01',
                  'weekday': 5,
                  ...
                },
                {
                  'date': '2016-01-01',
                  'weekday': 6,
                  ...
                },
                ...
                [WEITERE TAGE DER WOCHE]
              ]
            },
            {
              'nr': 2,
              'sum_target': 40,
              ...
              'day_details': 
              [
                {
                  'date': '2016-01-04',
                  'weekday': 1,
                  ...
                },
                {
                  'date': '2016-01-05',
                  'weekday': 2,
                  ...
                },
                ...
                [WEITERE TAGE DER WOCHE]
              ]
            },
            ... 
            [WEITERE WOCHEN]
          ]
      	},
      	...
      	[WEITERE MONATE]
      ]
    },
    ...
    [WEITERE BERICHTE ZU MITARBEITERN]
  ]
}

Stundenkonto zu einem einzelnen Mitarbeiter abrufen

Anfrage
GET /api/userreports/[Users-ID]
Notwendige Parameter year (integer)
Optionale Parameter type
0: Es werden nur Kennzahlen zum Jahr ausgegeben (default)
1: Es werden auch Kennzahlen zu Monaten ausgeben
2: Es werden auch Monats-und Wochen-Kennzahlen ausgeben
3: Es werden auch Monats-, Wochen- und Tageskennzahlen ausgegeben
4: Es werden auch Monats-, Wochen- und Tageskennzahlen ausgegeben, sowie tageweise die Beginn- und Endzeit der Arbeit und Pausen
Antwort
{
  "userreport": [object of type userreport]
}

Vergleichen Sie hierzu auch die weiteren Erklärungen im Bereich "Berichte zu allen Mitarbeitern abrufen".

stripes illustration
Kontaktieren Sie uns!

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

Jetzt kontaktieren!

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 6.000 weiteren Unternehmen:

Bechtle Mannheim LogoBechtlePeerigon LogoPeerigon GmbH
Phoenix Logistik LogoPhoenix LogistikFieda LogoFidea