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 2026-02-23 12:40 (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 https://api.flowtly.eu/agreements

Verträge auflisten

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

GET https://api.flowtly.eu/agreements/action-needed

Verträge mit offenen Aufgaben abrufen

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

POST https://api.flowtly.eu/agreements

Vertrag erstellen

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

GET https://api.flowtly.eu/agreements/{id}

Vertrag per ID abrufen

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

PATCH https://api.flowtly.eu/agreements/{id}

Vertrag aktualisieren

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

GET https://api.flowtly.eu/agreements/without-file

Retrieves the collection of Agreement resources.

Retrieves the collection of Agreement resources.

GET https://api.flowtly.eu/agreements/without-file/active

Retrieves the collection of Agreement resources.

Retrieves the collection of Agreement resources.

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 https://api.flowtly.eu/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 https://api.flowtly.eu/employees

Mitarbeiter auflisten

Rufe Mitarbeiterprofile mit Paginierung und Filtern ab.

POST https://api.flowtly.eu/employees

Mitarbeiter erstellen

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

GET https://api.flowtly.eu/employees/{id}

Mitarbeiter per ID abrufen

Liest ein konkretes Mitarbeiterprofil.

PATCH https://api.flowtly.eu/employees/{id}

Mitarbeiter aktualisieren

Passe Mitarbeiterdetails wie Name oder E-Mail an.

DELETE https://api.flowtly.eu/employees/{id}

Mitarbeiter löschen

Entfernt ein Mitarbeiterprofil.

GET https://api.flowtly.eu/employees/{id}/working-hours-stats/{date}

Arbeitszeit-Statistiken

Aggregierte Arbeitsstunden für ein Datum abrufen.

GET https://api.flowtly.eu/employees/me

Retrieves the collection of Employee resources.

Retrieves the collection of Employee resources.

GET https://api.flowtly.eu/employees/preview

Retrieves the collection of Employee resources.

Retrieves the collection of Employee resources.

GET https://api.flowtly.eu/employees/search

Retrieves the collection of Employee resources.

Retrieves the collection of Employee resources.

GET https://api.flowtly.eu/employees/{id}/documents

Retrieves a Employee resource.

Retrieves a Employee resource.

GET https://api.flowtly.eu/employees/{id}/feedback-suggestion

Retrieves a Employee resource.

Retrieves a Employee resource.

GET https://api.flowtly.eu/employees/{id}/project-rates

Retrieves a Employee resource.

Retrieves a Employee resource.

DELETE https://api.flowtly.eu/employees/{id}/user

Removes the Employee resource.

Removes the Employee resource.

POST https://api.flowtly.eu/employees/{id}/user

Creates a Employee resource.

Creates a Employee resource.

Schemafelder

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

Entitätsüberblick

Kunde

Halten Sie CRM und Delivery mit Flowtly-Kundendaten, Kontakten und Dokumentreferenzen synchron.

Endpoints

GET https://api.flowtly.eu/clients

Kunden auflisten

Rufen Sie Kunden mit Pagination für Account-Review und Segmentierung ab.

POST https://api.flowtly.eu/clients

Kunden erstellen

Erstellen Sie einen Kundendatensatz mit rechtlichen und Kontaktinformationen.

GET https://api.flowtly.eu/clients/{id}

Kunden per ID abrufen

Lesen Sie ein einzelnes Kundenprofil mit zugehörigen Kontakten.

PATCH https://api.flowtly.eu/clients/{id}

Kunden aktualisieren

Ändern Sie Kundendaten nach Onboarding oder Account-Änderungen.

GET https://api.flowtly.eu/clients/search

Retrieves the collection of Client resources.

Retrieves the collection of Client resources.

GET https://api.flowtly.eu/clients/{id}/documents

Retrieves a Client resource.

Retrieves a Client resource.

Anwendungsfälle

Synchronisieren Sie qualifizierte CRM-Accounts vor Projektstart in Flowtly.
Nutzen Sie Kundenupdates, um Rechnungen, Verträge und Account-Ownership konsistent zu halten.

Schemafelder

Client-client.read_client_contact.read_storage.read
Feld Typ Beschreibung
id integer —
country string —
currency string —
defaultCost string | null —
status string —
attributeSet string | null —
name string —
dueDays integer —
tinType string —
tinCountry string | null —
tin string | null —
externalPaymentCustomerId string | null —
invoiceComment string | null —
defaultTaxRate string | null —
documentsLanguage string —
addressPhoneNumber string | null —
addressCity string | null —
addressPostCode string | null —
addressStreetLine string | null —
addressBuildingNumber string | null —
addressLocaleNumber string | null —
addressCountry string | null —
clientContacts array —
costGroup array | null —
costGroupIcon string | null —
vatNumber string | null —
Whatsapp