clockin API - Häufig gestellte Fragen

Wie kann ich die Ist-Stunden eines Projekts über die API abrufen?

Die Ist-Zeiten pro Projekt lassen sich über den Endpunkt /v3/workdays/search ermitteln. Jeder Workday enthält eine Liste von Activities – also einzelne Arbeitszeiteinträge mit Start- und Endzeit. Jede Activity kann eine project_id enthalten, der gesamte Workday selbst jedoch nicht. Um die Ist-Stunden für ein Projekt zu berechnen, müssen alle Activities mit der gewünschten project_id aus den Workdays extrahiert und summiert werden.

 

Kann ich über die API abrufen, welcher Mitarbeiter auf welches Projekt wie viele Stunden gebucht hat?

Ja, über /v3/workdays/search können die Arbeitszeiten der Mitarbeiter abgefragt werden. Die einzelnen Einträge enthalten jeweils die employee_id sowie die project_id. Durch Gruppierung und Summierung dieser Einträge lassen sich die gebuchten Stunden je Mitarbeiter und Projekt ermitteln.

Wie kann ich alle Mitarbeiter einem Projekt zuordnen?

Mitarbeiter können einem Projekt entweder manuell durch Angabe aller employee_ids zugeordnet werden oder alternativ per API über einen zweiten Aufruf: POST /v3/projects/{project}/employees/attachHier können die gewünschten Mitarbeiter-IDs als Payload übergeben werden.

Kann ich das Stundenkonto eines Mitarbeiters via API abrufen?

Das Stundenkonto als Gesamtsaldo wird derzeit nicht direkt über die API bereitgestellt. Über den Endpunkt /v3/workdays/search kann jedoch für einzelne Tage die Soll-Ist-Differenz abgefragt werden. Eine vollständige Berechnung des Stundenkontos muss auf Basis dieser Tageswerte clientseitig erfolgen.

Wie kann ich vergangene Stempelzeiten in Clockin übertragen?

Über einen POST-Request an den Endpunkt /events können auch zurückliegende Zeiten in Clockin eingetragen werden. Dies ist beispielsweise relevant, um Resturlaub oder Überstunden nachträglich zu berechnen.

Kann ich mehrtägige Aufträge mit einzelnen Tagen als Projekttermine via API erfassen?

Nein, das ist aktuell nicht möglich. Projekttermine werden derzeit von der API nicht unterstützt.