clocko:do API:
Benutzer- und Firmeneinstellungen auslesen

Endpunkt api/v2/aggregates/users/me

Ü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
idinteger
Die ID des Unternehmens
namestring|null
Name des Unternehmens
timezone_defaultstring
Standard-Zeitzone des Unternehmens
currencystring
Währung des Unternehmens
allow_entries_multilineboolean
Dürfen Zeit- und Pauschaleinträge mit mehrzeiligen Beschreibungen angelegt werden?
allow_entries_for_customersboolean
Dürfen Zeit- und Pauschaleinträge direkt auf Kunden gebucht werden (ohne Projekt)?
force_linked_entry_timesboolean
Muss die Dauer eines Zeiteintrags der Different zwischen Anfang und Ende entsprechen?
default_customers_idinteger|null
ID des Standard-Kunden
default_services_idinteger|null
ID der Standard-Leistung
module_absenceboolean
Ist das Abwesenheits-Modul für das Unternehmen aktiv?
module_target_hoursboolean
Ist das Sollstunden-Modul für das Unternehmen aktiv?
module_user_reportsboolean
Ist das Mitarbeiterberichte-Modul für das Unternehmen aktiv?
nonbusiness_group_defaultinteger|null
ID der Standard-Feiertagsgruppe
worktime_regulation_defaultinteger|null
ID der Standard-Arbeitszeitvorschrift
worktime_evaluate_regulations_sincestring|null
Datum, ab dem für das Unternehmen Arbeitszeitvorschriften ausgewertet werden
im Format YYYY-MM-DD
worktime_force_breaksboolean
Wird fehlende Pausenzeit von der erfasssten Arbeitszeit abgezogen?
holidays_count_defaultfloat
Anzahl der Ferientage im Standard-Ferienkontingent des Unternehmens
absence_reduces_target_hoursboolean
Werden für Abwesenheiten die Soll-Stunden des Tages reduziert?
Falls nicht, wird auf dem Stundenkonto Zeit gutgeschrieben
compensate_day_defaultfloat
Standardwert für automatisch abgegoltene Zeit bei Überstunden pro Tag (in Minuten)
compensate_month_defaultfloat
Standardwert für automatisch abgegoltene Zeit bei Überstunden pro Tag (in Stunden)
target_hours_default[monday]float
Standardwert für Sollstunden am Montag
target_hours_default[tuesday]float
Standardwert für Sollstunden am Dienstag
target_hours_default[wednesday]float
Standardwert für Sollstunden am Mittwoch
target_hours_default[thursday]float
Standardwert für Sollstunden am Donnerstag
target_hours_default[friday]float
Standardwert für Sollstunden am Freitag
target_hours_default[saturday]float
Standardwert für Sollstunden am Samstag
target_hours_default[sunday]float
Standardwert für Sollstunden am Sonntag
onboarding_completeboolean
Wurde die Registrierung vollständig abgeschlossen?

Objekttyp „worktime_regulation“

Parameter Typ Beschreibung
idinteger
Die ID der Arbeitszeitvorschrift
add_to_worktimeboolean
Zählen vorgeschriebene Pausen als Arbeitszeit?
weekly_maxfloat
Maximal zulässige Arbeitszeit pro Woche (in Stunden)
daily_maxfloat
Maximal zulässige Arbeitszeit pro Tag (in Stunden)
interval_maxfloat
Maximal zulässige Arbeitszeit am Stück (in Stunden)
rulesarray
Enthält Objekte des Typs „breakrule“

Objekttyp „breakrule“

Parameter Typ Beschreibung
worktimefloat
Tägliche Arbeitszeit (in Stunden), ab der die Regel gilt
break_suminteger
Notwendige Gesamt-Pausenzeit
rulesobject
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]

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