Verträge & Compliance – 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.

Verträge & Compliance

Verwalte Verträge, Aufbewahrung und Beschaffungsprozesse.

Entitätsüberblick

Vertrag

Stelle Vertragsmetadaten anderen Systemen bereit, damit Budgetierung, Einkauf und HR dieselbe Datenbasis nutzen.

Endpoints

GET /api/agreements

Verträge auflisten

Liest Hydra-Sammlungen mit Filtern für Typ, Mitarbeitende und Aktivitätsstatus.

GET /api/agreements/action-needed

Verträge mit offenen Aufgaben abrufen

Verträge abrufen, die wegen fehlender Freigaben oder offener Punkte markiert sind.

POST /api/agreements

Vertrag erstellen

Legt einen Vertrag mit Anbieter-/Kundendaten, Abrechnungsrhythmus und Betrag an.

GET /api/agreements/{id}

Vertrag per ID abrufen

Holt einen einzelnen Vertrag, um Status, Wert und zuständige Personen zu prüfen.

PATCH /api/agreements/{id}

Vertrag aktualisieren

Vertragsstatus, Laufzeiten oder Verantwortliche nachträglich per PATCH anpassen.

Anwendungsfälle

Synchronisiere unterschriebene Kundenverträge aus deinem CLM, um Forecasts und Compliance-Checks zu harmonisieren.
Übertrage Lieferantenverträge mit Ausgabenlimits, damit Finance Verlängerungen automatisch überwacht.

Schemafelder

Agreement-agreement.read
Feld Typ Beschreibung
id integer Interne Flowtly-ID des Vertrags.
employee string | null IRI der verantwortlichen Person.
type string Vertragstyp wie Lieferant, Kunde oder Employment.
variant string Eigener Subtyp für Automationen.
amount number Gespeicherter Betrag (netto oder brutto).
minutesPerWeek integer Geplante Minuten pro Woche.
jobSize integer Jobgröße für Forecasting.
amountType string Kennzeichnung, ob die Summe netto oder brutto ist.
billingType string Abrechnungsrhythmus, z. B. monatlich.
positionName string | null Freitextbezeichnung des Vertrags.
position string | null IRI zum standardisierten Positionsdatensatz.
dateFrom string Startdatum des Vertrags.
dateTo string | null Enddatum (leer bei unbefristet).
currency string Referenzwährung für Beträge.
cost string | null IRI des verknüpften Kostenobjekts.
active boolean Gibt an, ob der Vertrag aktiv ist.
hoursPerWeek integer Eingeplante Stunden pro Woche.
status string Workflow-Status wie draft oder active.

Beispiele

POST /api/agreements

Lieferantenvertrag registrieren

Erstellt einen Lieferantenvertrag und verknüpft ihn mit der verantwortlichen Person sowie dem Währungs-IRI in Flowtly.

Request-Payload 
{
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12
}
Response-Payload 
{
    "@id": "/api/agreements/agr_Y29H",
    "@type": "Agreement",
    "id": 5021,
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12,
    "active": true,
    "status": "draft"
}

Entitätsüberblick

Mitarbeiter

Lege Mitarbeitende für Zuweisungen, Freigaben und Zugriffe an und verwalte sie.

Endpoints

GET /api/employees

Mitarbeiter auflisten

Rufe Mitarbeiterprofile mit Paginierung und Filtern ab.

POST /api/employees

Mitarbeiter erstellen

Füge einen Mitarbeiter mit Name, E-Mail und optionalem Avatar hinzu.

GET /api/employees/{id}

Mitarbeiter per ID abrufen

Liest ein konkretes Mitarbeiterprofil.

PATCH /api/employees/{id}

Mitarbeiter aktualisieren

Passe Mitarbeiterdetails wie Name oder E-Mail an.

DELETE /api/employees/{id}

Mitarbeiter löschen

Entfernt ein Mitarbeiterprofil.

GET /api/employees/{id}/working-hours-stats/{date}

Arbeitszeit-Statistiken

Aggregierte Arbeitsstunden für ein Datum abrufen.

Schemafelder

User-user.read
Feld Typ Beschreibung
id integer Interne Mitarbeiter-ID.
email string E-Mail-Adresse des Mitarbeiters.
firstname string Vorname des Mitarbeiters.
lastname string Nachname des Mitarbeiters.
avatarUrl string | null Avatar-URL des Mitarbeiters.
Whatsapp