Clockodo 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.

Inhalt

Objekttyp „company“
Objekttyp „worktime_regulation“
Objekttyp „breakrule“
Einstellungen auslesen

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_work_time	boolean	Ist das Arbeitszeit-Modul für das Unternehmen aktiv?
module_target_hours	boolean	Ist das Sollstunden-Modul für das Unternehmen aktiv? [deprecated]
module_user_reports	boolean	Ist das Mitarbeiterberichte-Modul für das Unternehmen aktiv? [deprecated]
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	integer	Abzug fehlender Pausenzeit 0: kein Abzug 1: voller Abzug 2: voller Abzug / gleitender Abzug ab 2022
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 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_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\|null	Maximal zulässige Arbeitszeit pro Woche (in Stunden)
daily_max	float\|null	Maximal zulässige Arbeitszeit pro Tag (in Stunden)
interval_max	float\|null	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
splitting	object\|null	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]

API-Dokumentation Grundlagen der Clockodo REST-API
api/absencesAbwesenheiten (Urlaubstage, Krankheitstage, ...) verwalten
api/v2/clockKontrolle der Stoppuhr
api/v2/customersKunden verwalten
api/v2/entriesZeit- und Pauschaleinträge verwalten
api/v2/entriesTextsBeschreibungen von Zeit- und Pauscheleinträgen auslesen
api/v2/entrygroupsGanze Gruppen von Zeiteinträgen auslesen und verwalten (insbesondere zu Auswertungs- und Rechnungszwecken nützlich)
api/holidayscarryUrlaubsüberträge verwalten
api/holidaysquotaUrlaubskontingente verwalten
api/v2/lumpsumservicesPauschalleistungen verwalten
api/nonbusinessdaysFeiertage ausgewertet auslesen
api/nonbusinessgroupsFeiertagsgruppen auslesen
api/v2/usersNonbusinessGroupsGeltungszeiträume für Feiertagsgruppen verwalten
api/overtimecarryÜberstundenüberträge verwalten
api/v2/projectsProjekte verwalten
api/registerClockodo-Accounts anlegen
api/v2/servicesLeistungen verwalten
api/v2/surchargesZuschlagsmodelle verwalten
api/targethoursSollstunden verwalten
api/v2/teamsTeams verwalten
api/userreportsStundenkonten auslesen
api/v2/usersMitarbeiter verwalten
api/v2/users/access/customers-projectsKunden- und Projektrechte auslesen
api/v2/users/access/servicesLeistungsrechte auslesen
api/v2/aggregates/users/meBenutzer- und Firmeneinstellungen auslesen
api/v2/workTimesArbeitszeiten auslesen
api/v2/workTimes/changeRequestsAnträge auf Änderung der Arbeitszeit verwalten
WebhooksAutomatische Benachrichtigungen erhalten für definierte Events

Kontaktieren Sie uns!

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

Jetzt kontaktieren!

Clockodo API: Benutzer- und Firmeneinstellungen auslesen