clocko:do API:
Projekte verwalten

Endpunkt api/v2/projects

Die erste Version dieses Endpunktes (api/projects) ist veraltet und nur noch bis 31.12.2022 verfügbar.

Objekttyp „project“

Parameter Typ Beschreibung
idinteger
Die ID des Projekts
customers_idinteger
Die ID des zugehörigen Kunden
namestring
Der Name des Projekts
numberstring|null
Projektnummer
activeboolean
Ist das Projekt aktiviert?
billable_defaultboolean
Abrechenbarkeit (1 oder 0)
notestring|null
Notiz zu dem Projekt
Nur bei notwendigen Mitarbeiterrechten
budget_moneyfloat|null
Projektbudget
Nur bei notwendigen Mitarbeiterrechten
budget_is_hoursboolean
Ist das Budget ein Stundenbudget?
Nur bei notwendigen Mitarbeiterrechten
budget_is_not_strictboolean
Ist das Budget ein Soll-Budget?
Nur bei notwendigen Mitarbeiterrechten
completedboolean
Ist das Projekt abgeschlossen?
billed_moneyfloat|null
Abgerechneter Betrag
Nur bei notwendigen Mitarbeiterrechten
billed_completelybool|null
Ist das Projekt komplett abgerechnet?
Nur bei notwendigen Mitarbeiterrechten
revenue_factorfloat|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

Anfrage
GET /api/v2/projects
Optionale Parameter filter[customers_id]
integer
filter[active]
boolean|null

Da Sie als Rückgabe sehr viele Projekte erhalten können, ist für diese Abfrage die seitenweise Ausgabe aktiv.

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

Projekt abrufen

Anfrage
GET /api/v2/projects/[ID]
Antwort
{
  "project": [object of type project]
}

Projekt anlegen

Anfrage
POST /api/v2/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/v2/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 löschen

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