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/projects: Projekte verwalten

Objekttyp „project“

Parameter	Typ	Beschreibung
id	integer	Die ID des Projekts
customers_id	integer	Die ID des zugehörigen Kunden
name	string	Der Name des Projekts
number	string\|null	Projektnummer
active	boolean	Ist das Projekt aktiviert?
billable_default	boolean	Abrechenbarkeit (1 oder 0)
note	string\|null	Notiz zu dem Projekt Nur bei notwendigen Mitarbeiterrechten
budget_money	float\|null	Projektbudget Nur bei notwendigen Mitarbeiterrechten
budget_is_hours	boolean	Ist das Budget ein Stundenbudget? Nur bei notwendigen Mitarbeiterrechten
budget_is_not_strict	boolean	Ist das Budget ein Soll-Budget? Nur bei notwendigen Mitarbeiterrechten
completed	boolean	Ist das Projekt abgeschlossen?
billed_money	float\|null	Abgerechneter Betrag Nur bei notwendigen Mitarbeiterrechten
billed_completely	bool\|null	Ist das Projekt komplett abgerechnet? Nur bei notwendigen Mitarbeiterrechten
revenue_factor	float\|null	Faktor mit dem zugehörige Stundensätze und Umsätze multipliziert werden müssen, um die effektiven Werte zu erhalten Nur bei notwendigen Mitarbeiterrechten. Bei einem abgeschlossenem Projekt mit harten Budget das zu 400% ausgenutzt wurde, ist der Faktor "0,25". " "null" bei Projekten mit hartem Budget, welche noch nicht abgeschlossen sind. "1" bei weichen oder keinem Budget.

Projekte auflisten

GET /api/projects

Optionale Parameter	filter[customers_id]	integer

Antwort

{
  "projects": 
  {
    [object of type project],
    [object of type project], 
    ...
  }
}

Projekt abrufen

Anfrage

GET /api/projects/[ID]

Antwort

{
  "project": [object of type project]
}

Projekt anlegen

Anfrage

POST /api/projects

Notwendige Parameter	name, customers_id

Optionale Parameter	number, active, billable_default, budget_money, budget_is_hours, budget_is_not_strict, note

Antwort

{
  "project": [object of type project]
}

Projekt bearbeiten

Anfrage

PUT /api/projects/[ID]

Notwendige Parameter	keine

Optionale Parameter	name, number, active, billable_default, budget_money, budget_is_hours, budget_ist_not_strict, note, hourly_rate, customers_id, completed, billed_money, billed_completely

Antwort

{
  "project": [object of type project]
}

Projekt deaktivieren

Anfrage

DELETE /api/projects/[ID]

Antwort

{
  "project": [object of type project]
}