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	Projektnummer
active	boolean	Ist das Projekt aktiviert?
billable_default	boolean	Abrechenbarkeit (1 oder 0)
note	string	Notiz zu dem Projekt
budget_money	float	Projektbudget
budget_is_hours	boolean	Ist das Budget ein Stundenbudget?
budget_is_not_strict	boolean	Ist das Budget ein Soll-Budget?
completed	boolean	Ist das Projekt abgeschlossen?
billed_money	float	Abgerechneter Betrag
billed_completely	bool	Ist das Projekt komplett abgerechnet?
revenue_factor	float	Faktor mit dem zugehörige Stundensätze und Umsätze multipliziert werden müssen, um die effektiven Werte zu erhalten Bei einem abgeschlossenem Projekt mit harten Budget das zu 400% ausgenutzt wurde, ist der Faktor "0,25". "0" bei Projekten mit hartem Budget, welche noch nicht abgeschlossen sind. "1" bei weichen oder keinem Budget.

Projekte auflisten

Bitte nutzen Sie hierzu /api/customers. Dort werden Kunden und Projekte verschachtelt ausgegeben.

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]
}