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/tasks: Aufgaben (gruppierte Zeiteinträge) auslesen

Objekttyp „task“

Parameter	Typ	Beschreibung
day	string	Tag an dem die Aufgabe ausgeführt wurde im Format YYYY-MM-DD
customers_id	integer	Die ID des zugehörigen Kunden
customers_name	string	Der Name des zugehörigen Kunden
projects_id	integer	Die ID des zugehörigen Projekts
projects_name	string	Der Name des zugehörigen Projekts
services_id	integer	Die ID der zugehörigen Leistung
services_name	string	Der Name der zugehörigen Leistung
lumpSums_id	integer	Die ID der zugehörigen Pauschale
lumpSums_amount	float	Die Menge der zugehörigen Pauschale
lumpSums_name	string	Der Name der zugehörigen Pauschale
lumpSums_price	float	Die Stückpreis der zugehörigen Pauschale
lumpSums_unit	string	Die Einheit der zugehörigen Pauschale
users_id	integrer	Die ID des zugehörigen Mitarbeiters
billable	integer	Abrechenbarkeit (1 oder 0)
texts_id	integer	Die ID der Textbeschreibung
texts_id	integer	Die ID der Textbeschreibung
text	string	Textbeschreibung
time_since	string	Anfangszeit (Zeitstempel, je nach Anfrage formatiert)
time_until	string	Endzeit, NULL falls Eintrag noch läuft (Zeitstempel, je nach Anfrage formatiert)
duration	integer	Dauer des Eintrags in Sekunden
duration_time	string	Dauer des Eintrags in HH:MM:SS Format
duration_text	string	Dauer lokalisiert
is_clocking	boolean	Aufgabe läuft noch
has_just_lumpSums	boolean	Hat die Aufgabe nur Pauschaleinträge?
[revenue]	float	Der Umsatz der Aufgabe (nur bei notwendigen Mitarbeiterrechten)

Aufgaben der letzten Tage auflisten

Anfrage

GET /api/tasks

Notwendige Parameter	keine

Optionale Parameter	count (integer, Anzahl der Tage für welche Taks aufgelistet werden sollen, Standard 8, max. 30)

Antwort

{
  "days":
  {
    {
      "date": [Datum im Format YYYY-MM-DD],
      "date_text": [Datum lokalisiert],
      "duration": [Dauer in Sekunden, integer],
      "duration_text": [Dauer im Format H:MM h],
      "tasks":
      {
        [object of type task],
        [object of type task],
		...
      }
    },
    ...
  }
}

Aufgabendauer abrufen

Liefert die Dauer der Aufgabe in Sekunden.

Anfrage

GET /api/tasks/duration

Notwendige Parameter	task[customers_id], task[projects_id], task[services_id] oder task[lumpSum_id], task[text], task[billable]

Optionale Parameter	excludeIds (Liste von Entry-Ids die nicht in die Dauer einberechnet werden sollen)

Antwort

{
  "task": 
  {
    "duration": integer
  }
}