clocko:do API:
Zuschlagsmodelle verwalten

Objekttyp „surchargeModel“

Parameter Typ Beschreibung
idinteger
Die ID des Zuschlagsmodells
namestring
Der Name des Zuschlagsmodells
accumulationboolean
Sollen Nachtzuschläge zusätzlich zu einem anderen Zuschlag gelten?
Wenn false, gilt der Zuschlag mit dem höheren Prozentwert.
nightsurcharge|null
Konfiguration für den Nachtzuschlag
night_increasedsurcharge|null
Konfiguration für den erhöhten Nachtzuschlag
nonbusinesssurcharge|null
Konfiguration für den Feiertags-Zuschlag
nonbusiness_specialsurcharge|null
Konfiguration für den Feiertags-Zuschlag für besondere Feiertage
sundaysurcharge|null
Konfiguration für den Sonntags-Zuschlag
saturdaysurcharge|null
Konfiguration für den Samstags-Zuschlag

Ein surchargeModel enthält nur die Keys der Zuschläge, die konfiguriert wurden.

Objekttyp „surcharge“

Parameter Typ Beschreibung
percentinteger
Anteil der Arbeitszeit, der als Zuschlag im Stundenkonto erscheint
time_sincestring
Beginn des Zeitraums, in dem der Zuschlag gilt
Format hh:mm:ss, z.B. 23:00:00
time_untilstring
Ende des Zeitraums, in dem der Zuschlag gilt
Format hh:mm:ss, z.B. 23:00:00
time_since_is_previous_dayboolean
Beginnt der Zuschlags-Zeitraum bereits am Vortag?
Nicht für "night" und "night_increased", da diese Zuschläge jeden Tag gelten
time_until_is_next_dayboolean
Endet der Zuschlags-Zeitraum erst am Folgetag?
Nicht für "night" und "night_increased", da diese Zuschläge jeden Tag gelten

Zuschlagsmodelle auflisten

Anfrage
GET /api/v2/surcharges
Antwort
{
  "surcharges": 
  {
    [object of type surchargeModel],
    [object of type surchargeModel], 
    ...
  }
}

Einzelnes Zuschlagsmodell abrufen

Anfrage
GET /api/v2/surcharges/[ID]
Antwort
{
  "surcharge": [object of type surchargeModel]
}

Zuschlagsmodell anlegen

Anfrage
POST /api/v2/surcharges
Pflichtparameter name, accumulation
Optionale Parameter night, night_increased, nonbusiness, nonbusiness_special, sunday, saturday
JSON-Body eines POST-Requests (Beispiel)
{
    "name": "Neues Zuschlagsmodell",
    "accumulation": true,
    "sunday": {
        "percent": 50,
        "time_since": "00:00:00",
        "time_until": "04:00:00",
        "time_since_is_previous_day": false,
        "time_until_is_next_day": true
    },
    "nonbusiness": {
        "percent": 125,
        "time_since": "00:00:00",
        "time_until": "04:00:00",
        "time_since_is_previous_day": false,
        "time_until_is_next_day": true
    },
    "night": {
        "percent": 25,
        "time_since": "22:00:00",
        "time_until": "06:00:00"
    },
    "night_increased": {
        "percent": 40,
        "time_since": "00:00:00",
        "time_until": "04:00:00"
    }
}
Antwort
{
  "surcharge": [object of type surchargeModel]
}

Zuschlagsmodell bearbeiten

Anfrage
PUT /api/v2/surcharges/[ID]
Optionale Parameter name, accumulation, night, night_increased, nonbusiness, nonbusiness_special, sunday, saturday

Übergeben Sie für einen Zuschlag (z.B. night_increased) null statt eines Objekts, um diesen Zuschlag aus dem Zuschlagsmodell zu entfernen. Auch das Setzen von percent = 0 entfernt einen Zuschlag aus dem Modell.

Antwort
{
  "surcharge": [object of type surchargeModel]
}

Zuschlagsmodell löschen

Anfrage
DELETE /api/v2/surcharges/[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