Budgets & Ausgaben – 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.

Budgets & Ausgaben

Steuere Finanzpläne, Zuweisungen und Transaktionen.

Entitätsüberblick

Budget

Spiele Flowtly-Budgets in Finanztools ein, damit Limits, Alerts und Freigaben synchron bleiben.

Endpoints

GET /api/budgets

Budgets auflisten

Liest paginierte Budgets mit Filtern nach Typ oder Zeitraum.

POST /api/budgets

Budget erstellen

Legt ein Budget mit Zeitraum, Gruppe und Optionen an.

GET /api/budgets/{id}

Budget per ID abrufen

Zeigt Details und Zuweisungen eines Budgets.

PATCH /api/budgets/{id}

Budget aktualisieren

Budgetlaufzeit, Granularität oder Konfiguration per PATCH anpassen.

DELETE /api/budgets/{id}

Budget löschen

Ein Budget entfernen, das nicht mehr nachverfolgt werden soll.

GET /api/budget-contractors

List budget-contractors

Retrieve budget-contractor records.

POST /api/budget-contractors

Create budget-contractor

Create a new budget-contractor mapping.

GET /api/budget-contractors/{id}

Get budget-contractor

Fetch a budget-contractor by ID.

DELETE /api/budget-contractors/{id}

Delete budget-contractor

Remove a budget-contractor mapping.

GET /api/budget-employees

List budget-employees

Retrieve employee budget allocations.

POST /api/budget-employees

Create budget-employee

Create a new budget-employee allocation.

GET /api/budget-employees/{id}

Get budget-employee

Fetch a budget-employee allocation.

DELETE /api/budget-employees/{id}

Delete budget-employee

Remove a budget-employee allocation.

GET /api/budget-groups

List budget-groups

Retrieve budget groups.

POST /api/budget-groups

Create budget-group

Create a new budget group.

GET /api/budget-groups/{id}

Get budget-group

Fetch a budget group by ID.

PATCH /api/budget-groups/{id}

Update budget-group

Patch a budget group.

DELETE /api/budget-groups/{id}

Delete budget-group

Remove a budget group.

GET /api/budget-invoices

List budget-invoices

Retrieve budget-linked invoices.

POST /api/budget-invoices

Create budget-invoice

Create a budget invoice mapping.

GET /api/budget-invoices/{id}

Get budget-invoice

Fetch a budget invoice mapping.

DELETE /api/budget-invoices/{id}

Delete budget-invoice

Remove a budget invoice mapping.

GET /api/budget-projects

List budget-projects

Retrieve project allocations under budgets.

POST /api/budget-projects

Create budget-project

Create a budget-project allocation.

GET /api/budget-projects/{id}

Get budget-project

Fetch a budget-project allocation.

DELETE /api/budget-projects/{id}

Delete budget-project

Remove a budget-project allocation.

Anwendungsfälle

Richte jährliche Kostenstellen im ERP ein und halte Flowtly mit aktuellen Limits synchron.
Synchronisiere Marketingbudgets, damit Performance-Tools Ausgaben bei Flowtly-Alerts stoppen.

Schemafelder

Budget-budget.read_budget_employee.read
Feld Typ Beschreibung
id string Eindeutige Budget-ID.
name string Anzeigename des Budgets.
type string Geltungsbereich (global oder employee).
granularity string Reporting-Granularität wie Monat.
budgetGroup string | null IRI der Budgetgruppe.
dateFrom string | null Beginn des Budgets.
dateTo string | null Ende des Budgets.
config array Liste aktivierter Optionen (Alerts usw.).
budgetEmployees array Zugeordnete Mitarbeitende.

Beispiele

POST /api/budgets

Marketingbudget FY25 anlegen

Erstellt ein FY25-Budget samt Gruppe und Automatisierungsflags.

Request-Payload 
{
    "name": "EMEA Marketing FY25",
    "type": "global",
    "granularity": "month",
    "dateFrom": "2024-01-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "budgetGroup": "/api/budget-groups/emarketing",
    "config": [
        "spend_alerts",
        "auto-freeze"
    ]
}
Response-Payload 
{
    "@id": "/api/budgets/bgt_fy25",
    "@type": "Budget",
    "id": "bgt_fy25",
    "name": "EMEA Marketing FY25",
    "type": "global",
    "granularity": "month",
    "dateFrom": "2024-01-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "budgetGroup": "/api/budget-groups/emarketing",
    "config": [
        "spend_alerts",
        "auto-freeze"
    ]
}

Entitätsüberblick

Budgettransaktion

Sorge dafür, dass Beschaffung und Flowtly dieselben Ist-Ausgaben sehen.

Endpoints

GET /api/budget-transactions

Budgettransaktionen auflisten

Ruft das Journal aller Ausgabenereignisse für Budgets ab.

POST /api/budget-transactions

Budgettransaktion erstellen

Verlinkt eine externe Transaktion samt optionalem Mitarbeitenden mit einem Budget.

GET /api/budget-transactions/{id}

Budgettransaktion abrufen

Eine mit einem Budget verknüpfte Transaktion einsehen, um Ausgaben zu prüfen.

PATCH /api/budget-transactions/{id}

Budgettransaktion aktualisieren

Verknüpftes Budget, Mitarbeitenden oder Betrag anpassen.

DELETE /api/budget-transactions/{id}

Budgettransaktion löschen

Eine fehlerhafte Budget-Transaktionsverknüpfung entfernen.

GET /api/income-transactions

List income-transactions

Retrieve income transactions.

POST /api/income-transactions

Create income-transaction

Create an income transaction entry.

GET /api/income-transactions/{id}

Get income-transaction

Fetch an income transaction by ID.

PATCH /api/income-transactions/{id}

Update income-transaction

Patch an income transaction entry.

DELETE /api/income-transactions/{id}

Delete income-transaction

Delete an income transaction entry.

GET /api/project-transactions

List project-transactions

Retrieve project transactions.

POST /api/project-transactions

Create project-transaction

Create a project transaction entry.

PATCH /api/project-transactions/{id}

Update project-transaction

Patch a project transaction entry.

DELETE /api/project-transactions/{id}

Delete project-transaction

Delete a project transaction entry.

GET /api/transactions

List transactions

Retrieve generic transactions.

POST /api/transactions

Create transaction

Create a generic transaction.

GET /api/transactions/{id}

Get transaction

Fetch a transaction by ID.

PATCH /api/transactions/{id}

Update transaction

Patch a transaction.

POST /api/transactions/import

Import transactions

Bulk import transactions.

GET /api/transactions/unassigned

List unassigned transactions

Retrieve transactions not yet linked to a budget.

GET /api/transaction-attachments

List transaction-attachments

Retrieve transaction attachments.

POST /api/transaction-attachments

Create transaction-attachment

Create a transaction attachment.

GET /api/transaction-attachments/{id}

Get transaction-attachment

Fetch a transaction attachment by ID.

PATCH /api/transaction-attachments/{id}

Update transaction-attachment

Patch a transaction attachment.

DELETE /api/transaction-attachments/{id}

Delete transaction-attachment

Delete a transaction attachment.

POST /api/transaction-attachments/create

Upload transaction-attachment

Upload a new transaction attachment.

GET /api/transaction-attachments/search

Search transaction-attachments

Search transaction attachments by query.

Anwendungsfälle

Übertrage Zahlungsdaten aus der Buchhaltung, damit Flowtly den echten Verbrauch zeigt.
Verlinke HR- oder Vendor-Kosten sofort nach Freigabe mit Budgets.

Schemafelder

BudgetTransaction-budget_transaction.read_transaction.read
Feld Typ Beschreibung
budget string IRI des betroffenen Budgets.
transaction object IRI der ursprünglichen ERP-Transaktion.
employee string | null Verantwortliche Person (optional).
amount integer | null Gebuchte Summe gegen das Budget.

Beispiele

POST /api/budget-transactions

ERP-Transaktion mit Budget verknüpfen

Ordnet eine Lieferantenrechnung dem FY25-Budget zu und speichert den Owner.

Request-Payload 
{
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Response-Payload 
{
    "@id": "/api/budget-transactions/btr_11",
    "@type": "BudgetTransaction",
    "id": "btr_11",
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Whatsapp