REST-API

Die clockodo-API ermöglicht die Anbindung von clockodo an andere Systeme. Rechnungs- und Projektmanagement-Anwendungen oder eigene Shell-Skripte sind Beispiele für nützliche Mash-Ups mit clockodo.

api/v2/aggregates/users/me: Benutzer- und Firmeneinstellungen auslesen

Über diese Ressource können Sie Benutzer- und Firmeneinstellungen für den angemeldeten Benutzer auslesen. Das Bearbeiten ist aktuell nicht möglich.


Objekttyp „company“

Parameter Typ Beschreibung
id integer Die ID des Unternehmens
name string|null Name des Unternehmens
timezone_default string Standard-Zeitzone des Unternehmens
currency string Währung des Unternehmens
allow_entries_multiline boolean Dürfen Zeit- und Pauschaleinträge mit mehrzeiligen Beschreibungen angelegt werden?
allow_entries_for_customers boolean Dürfen Zeit- und Pauschaleinträge direkt auf Kunden gebucht werden (ohne Projekt)?
force_linked_entry_times boolean Muss die Dauer eines Zeiteintrags der Different zwischen Anfang und Ende entsprechen?
default_customers_id integer|null ID des Standard-Kunden
default_services_id integer|null ID der Standard-Leistung
module_absence boolean Ist das Abwesenheits-Modul für das Unternehmen aktiv?
module_target_hours boolean Ist das Soll-Stunden-Modul für das Unternehmen aktiv?
module_user_reports boolean Ist das Mitarbeiterberichte-Modul für das Unternehmen aktiv?
nonbusiness_group_default integer|null ID der Standard-Feiertagsgruppe
worktime_regulation_default integer|null ID der Standard-Arbeitszeitvorschrift
worktime_evaluate_regulations_since string|null Datum, ab dem für das Unternehmen Arbeitszeitvorschriften ausgewertet werden im Format YYYY-MM-DD
worktime_force_breaks boolean Wird fehlende Pausenzeit von der erfasssten Arbeitszeit abgezogen?
holidays_count_default float Anzahl der Urlaubstage im Standard-Urlaubskontingent des Unternehmens
absence_reduces_target_hours boolean Werden für Abwesenheiten die Soll-Stunden des Tages reduziert? Falls nicht, wird auf dem Stundenkonto Zeit gutgeschrieben
compensate_day_default float Standardwert für automatisch abgegoltene Zeit bei Überstunden pro Tag (in Minuten)
compensate_month_default float Standardwert für automatisch abgegoltene Zeit bei Überstunden pro Tag (in Stunden)
target_hours_default[monday] float Standardwert für Soll-Stunden am Montag
target_hours_default[tuesday] float Standardwert für Soll-Stunden am Dienstag
target_hours_default[wednesday] float Standardwert für Soll-Stunden am Mittwoch
target_hours_default[thursday] float Standardwert für Soll-Stunden am Donnerstag
target_hours_default[friday] float Standardwert für Soll-Stunden am Freitag
target_hours_default[saturday] float Standardwert für Soll-Stunden am Samstag
target_hours_default[sunday] float Standardwert für Soll-Stunden am Sonntag
onboarding_complete boolean Wurde die Registrierung vollständig abgeschlossen?

Objekttyp „worktime_regulation“

Parameter Typ Beschreibung
id integer Die ID der Arbeitszeitvorschrift
add_to_worktime boolean Zählen vorgeschriebene Pausen als Arbeitszeit?
weekly_max float Maximal zulässige Arbeitszeit pro Woche (in Stunden)
daily_max float Maximal zulässige Arbeitszeit pro Tag (in Stunden)
interval_max float Maximal zulässige Arbeitszeit am Stück (in Stunden)
rules array enthält Objekte des Typs „breakrule“

Objekttyp „breakrule“

Parameter Typ Beschreibung
worktime float tägliche Arbeitszeit (in Stunden), ab der die Regel gilt
break_sum integer Notwendige Gesamt-Pausenzeit
rules object enthält die Pausen-Aufteilungsoptionen als Key-Value-Paare Der Key gibt die Anzahl der Pausen an, auf die die Pausezeit verteilt werden darf, der Wert enthält die Mindestlänge einer einzelnen Pause (in Minuten)

Einstellungen auslesen

Anfrage
GET /api/v2/aggregates/users/me
Antwort
{
    "user": [object of type user],
    "company": [object of type company],
    "worktime_regulation": [object of type worktime_regulation]
}

Vgl. Sie hier die Beschreibung zum Objekttyp "user" [object of type user]