Projekte & Delivery – Flowtly Developer-Plattform

Nutze diesen kuratierten Ausschnitt des Flowtly-OpenAPI-Schemas, um Integrationen zu planen, Workflows zu automatisieren und kritische Daten zu synchronisieren.

Dokumentationsstatus

Zuletzt synchronisiert am 2024-07-08 12:00 (App-Version 2.0.0)

Nur ein Teil der Entitäten ist öffentlich. Führe beide Sync-Befehle aus, sobald Flowtly neue Funktionen veröffentlicht, um die Daten zu aktualisieren.

Projekte & Delivery

Teile Projektdaten, Mitglieder und Abrechnungsinfos.

Entitätsüberblick

Projekt

Nutze Flowtly-Projekte als Single Source of Truth für PMO und Finance.

Endpoints

GET /api/projects

Projekte auflisten

Liest Projekte mit Filtern nach Kunde, Status oder Vertragstyp.

POST /api/projects

Projekt erstellen

Legt ein Projekt mit Billing-Typ, Kunde und Zeitplan an.

GET /api/projects/{id}

Projekt per ID abrufen

Zeigt Details zu Projektmitgliedern, Währung und Feldern.

PATCH /api/projects/{id}

Projekt aktualisieren

Projektstammdaten, Termine oder Abrechnungsart per PATCH ändern.

GET /api/projects/preview

Preview projects

Preview project data before creation.

GET /api/projects/search

Search projects

Search projects by filters.

GET /api/projects/{id}/profitability

Get project profitability

Inspect profitability metrics for a project.

Anwendungsfälle

Erstelle Projekte aus dem CRM nach Deal-Gewinn, um Staffing zu starten.
Aktualisiere Projektstatus aus externen Tools, damit Flowtly-Prognosen stimmen.

Schemafelder

Project-project.read
Feld Typ Beschreibung
id integer Interne Projekt-ID.
client string | null IRI des Kunden.
currency string | null Währung für Billing und Budgets.
dateFrom string | null Geplanter Projektstart.
dateTo string | null Geplantes Projektende.
name string Projektname.
publicDescription string | null Öffentlich sichtbare Beschreibung.
type string Abrechnungsmodell, z. B. fixed-price oder T&M.
clientHash string Gehashter Kunden-Identifier für Dedupe.
notes string | null Interne Notizen.
color string Farbcode zur Anzeige.
priceNet string | null Netto-Projektpreis (falls gesetzt).
taxGroup string | null IRI der Steuergruppe.
projectMembers array Liste der Mitglieder-IRIs.
status string Lifecycle-Status des Projekts.
flattenType string Normalisierter Projekttyp in Flowtly.

Beispiele

POST /api/projects

Projekt „Aurora Rollout“ erstellen

Fügt ein T&M-Projekt mit CRM-Kunde und geplanten Terminen hinzu.

Request-Payload
{
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "notes": "Expansion to Germany and France"
}
Response-Payload
{
    "@id": "/api/projects/prj_aurora",
    "@type": "Project",
    "id": 9821,
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "status": "active"
}

Entitätsüberblick

Attribut

Lege benutzerdefinierte Attribute an und erweitere damit die Flowtly-Datenmodelle.

Endpoints

GET /api/attributes

Attribute auflisten

Rufe Attribute mit Paginierung und Filtern ab.

POST /api/attributes

Attribut erstellen

Definiere ein neues Attribut mit Slug, Namen und Typ.

GET /api/attributes/{id}

Attribut per ID abrufen

Liest eine konkrete Attributdefinition.

PATCH /api/attributes/{id}

Attribut aktualisieren

Passe Name oder Beschreibung eines Attributs an.

DELETE /api/attributes/{id}

Attribut löschen

Entfernt eine Attributdefinition.

Schemafelder

Attribute-attribute.read
Feld Typ Beschreibung
id integer ID des Attributs.
name string Anzeigename des Attributs.
slug string Slug, unter dem das Attribut referenziert wird.
type string Datentyp des Attributs.
description string | null Optionale Beschreibung des Attributzwecks.
Whatsapp