clocko:do API:
Sollstunden verwalten

Endpunkt api/targethours

Über diese Ressource können Sie alle Sollstunden-Einstellungen verwalten.

Abstrakter Objekttyp „targethoursRow“

Parameter Typ Beschreibung
idinteger
Die ID der Sollstunden-Einstellung
typestring
Art der Sollstunden:
'weekly': Wochensollstunden
'monthly': Monatssollstunden
date_sincestring
Datum ab welchem die Sollstunden gelten
im Format YYYY-MM-DD
date_untilstring|null
Datum bis zu welchem die Sollstunden gelten
im Format YYYY-MM-DD
compensation_monthlyfloat
Automatische Abgeltung pro Monat in Stunden
users_idinteger
Die ID des zugehörigen Mitarbeiters

Objekttyp „targethoursRowWeekly“

Objekttyp „targethoursRow“ erweitert um:

Parameter Typ Beschreibung
mondayfloat
Sollstunden für Montag
tuesdayfloat
Sollstunden für Dienstag
wednesdayfloat
Sollstunden für Mittwoch
thursdayfloat
Sollstunden für Donnerstag
fridayfloat
Sollstunden für Freitag
saturdayfloat
Sollstunden für Samstag
sundayfloat
Sollstunden für Sonntag
absence_fixed_creditboolean
true falls bei Abwesenheit die durchschnittliche Soll-Arbeitszeit verrechnet wird, false falls die Sollstunden des jeweiligen Tags verrechnet werden.
compensation_dailyfloat
Automatische Abgeltung pro Tag in Minuten

Objekttyp „targethoursRowMonthly“

Objekttyp „targethoursRow“ erweitert um:

Parameter Typ Beschreibung
monthly_targetfloat
Die zu erreichenden monatlichen Sollstunden
workday_tuesdayboolean
Ist Dienstag ein Arbeitstag?
workday_wednesdayboolean
Ist Mittwoch ein Arbeitstag?
workday_thursdayboolean
Ist Donnerstag ein Arbeitstag?
workday_fridayboolean
Ist Freitag ein Arbeitstag?
workday_saturdayboolean
Ist Samstag ein Arbeitstag?
workday_sundayboolean
Ist Sonntag ein Arbeitstag?
workday_mondayboolean
Ist Montag ein Arbeitstag?

Sollstunden auflisten

Anfrage
GET /api/targethours
Optionale Parameter users_id (integer)
Benutzer auf welchen eingeschränkt werden soll
Antwort
{
  "targethours": 
  {
    [object of type targethoursRow],
    [object of type targethoursRow], 
    ...
  }
}

Einzelne Sollstunden-Einstellung abrufen

Anfrage
GET /api/targethours/[ID]
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden anlegen

Anfrage
POST /api/targethours
Pflichtparameter für type: weekly users_id, type, monday, tuesday, wednesday, thursday, friday, saturday, sunday, compensation_daily, compensation_monthly
Pflichtparameter für type: monthly users_id, type, workday_monday, workday_tuesday, workday_wednesday, workday_thursday, workday_friday, workday_saturday, workday_sunday, monthly_target, compensation_monthly
Optionale Parameter date_until
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden bearbeiten

Anfrage
PUT /api/targethours/[ID]
Pflichtparameter für type: weekly users_id, type, monday, tuesday, wednesday, thursday, friday, saturday, sunday, compensation_daily, compensation_monthly
Pflichtparameter für type: monthly users_id, type, workday_monday, workday_tuesday, workday_wednesday, workday_thursday, workday_friday, workday_saturday, workday_sunday, monthly_target, compensation_monthly
Optionale Parameter date_until
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden löschen

Anfrage
DELETE /api/targethours/[ID]
Antwort
{
  "success": true
}
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