Budgets & spend – build on Flowtly

Use this curated snapshot of the Flowtly OpenAPI schema to plan integrations, automate workflows, and sync the data your teams rely on.

Documentation status

Last synced on 2026-02-23 12:40 (app version 2.0.0)

Only a subset of entities is made public. Run both sync commands to refresh this documentation when the Flowtly app ships new capabilities.

Budgets & spend

Control financial plans, allocations, and transactions.

Entity overview

Budget

Expose Flowtly budgets to finance tooling to ensure allocations, alerts, and approvals stay synchronized.

Endpoints

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

List budgets

Retrieve paginated budgets with optional filtering by type or validity.

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

Create budget

Post a new budget with date window, grouping, and configuration flags.

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

Get budget by ID

Fetch a specific budget to inspect allocations and metadata.

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

Update budget

Patch budget dates, granularity, or configuration flags.

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

Delete budget

Remove a budget that should no longer be tracked.

GET https://api.flowtly.eu/budget-contractors

List budget-contractors

Retrieve budget-contractor records.

POST https://api.flowtly.eu/budget-contractors

Create budget-contractor

Create a new budget-contractor mapping.

GET https://api.flowtly.eu/budget-contractors/{id}

Get budget-contractor

Fetch a budget-contractor by ID.

DELETE https://api.flowtly.eu/budget-contractors/{id}

Delete budget-contractor

Remove a budget-contractor mapping.

GET https://api.flowtly.eu/budget-employees

List budget-employees

Retrieve employee budget allocations.

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

Create budget-employee

Create a new budget-employee allocation.

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

Get budget-employee

Fetch a budget-employee allocation.

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

Delete budget-employee

Remove a budget-employee allocation.

GET https://api.flowtly.eu/budget-groups

List budget-groups

Retrieve budget groups.

POST https://api.flowtly.eu/budget-groups

Create budget-group

Create a new budget group.

GET https://api.flowtly.eu/budget-groups/{id}

Get budget-group

Fetch a budget group by ID.

PATCH https://api.flowtly.eu/budget-groups/{id}

Update budget-group

Patch a budget group.

DELETE https://api.flowtly.eu/budget-groups/{id}

Delete budget-group

Remove a budget group.

GET https://api.flowtly.eu/budget-invoices

List budget-invoices

Retrieve budget-linked invoices.

POST https://api.flowtly.eu/budget-invoices

Create budget-invoice

Create a budget invoice mapping.

GET https://api.flowtly.eu/budget-invoices/{id}

Get budget-invoice

Fetch a budget invoice mapping.

DELETE https://api.flowtly.eu/budget-invoices/{id}

Delete budget-invoice

Remove a budget invoice mapping.

GET https://api.flowtly.eu/budget-projects

List budget-projects

Retrieve project allocations under budgets.

POST https://api.flowtly.eu/budget-projects

Create budget-project

Create a budget-project allocation.

GET https://api.flowtly.eu/budget-projects/{id}

Get budget-project

Fetch a budget-project allocation.

DELETE https://api.flowtly.eu/budget-projects/{id}

Delete budget-project

Remove a budget-project allocation.

Use cases

Provision annual cost centers from your ERP and keep Flowtly up to date with the latest limits.
Sync marketing campaign budgets so performance tools can stop spend when Flowtly flags overruns.

Schema fields

Budget-budget.read_budget_employee.read
Field Type Description
id string Identifier of the budget.
name string Human-readable label (e.g. EMEA Marketing FY25).
type string Either global or employee-level budget.
granularity string Aggregation interval for reporting (month, quarter).
budgetGroup string | null Optional reference to a budget group.
dateFrom string | null Start of the validity window.
dateTo string | null End of the validity window.
config array Feature flags such as spend alerts.
budgetEmployees array Employee allocations tied to the budget.

Examples

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

Create a global marketing budget

Sets up a FY25 marketing budget tied to an existing budget group with automation flags.

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"
    ]
}

Entity overview

Budget transaction

Share spend data bi-directionally so both procurement suites and Flowtly agree on the latest committed amounts.

Endpoints

GET https://api.flowtly.eu/budget-transactions

List budget transactions

Retrieve the ledger of financial events impacting a budget.

POST https://api.flowtly.eu/budget-transactions

Create budget transaction

Link an external transaction and optional employee to a Flowtly budget.

GET https://api.flowtly.eu/budget-transactions/{id}

Get budget transaction

Inspect a transaction linked to a budget to review spend impact.

PATCH https://api.flowtly.eu/budget-transactions/{id}

Update budget transaction

Adjust the linked budget, employee, or booked amount.

DELETE https://api.flowtly.eu/budget-transactions/{id}

Delete budget transaction

Remove an incorrect budget transaction link.

GET https://api.flowtly.eu/income-transactions

List income-transactions

Retrieve income transactions.

POST https://api.flowtly.eu/income-transactions

Create income-transaction

Create an income transaction entry.

GET https://api.flowtly.eu/income-transactions/{id}

Get income-transaction

Fetch an income transaction by ID.

PATCH https://api.flowtly.eu/income-transactions/{id}

Update income-transaction

Patch an income transaction entry.

DELETE https://api.flowtly.eu/income-transactions/{id}

Delete income-transaction

Delete an income transaction entry.

GET https://api.flowtly.eu/project-transactions

List project-transactions

Retrieve project transactions.

POST https://api.flowtly.eu/project-transactions

Create project-transaction

Create a project transaction entry.

PATCH https://api.flowtly.eu/project-transactions/{id}

Update project-transaction

Patch a project transaction entry.

DELETE https://api.flowtly.eu/project-transactions/{id}

Delete project-transaction

Delete a project transaction entry.

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

List transactions

Retrieve generic transactions.

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

Create transaction

Create a generic transaction.

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

Get transaction

Fetch a transaction by ID.

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

Update transaction

Patch a transaction.

POST https://api.flowtly.eu/transactions/import

Import transactions

Bulk import transactions.

GET https://api.flowtly.eu/transactions/unassigned

List unassigned transactions

Retrieve transactions not yet linked to a budget.

GET https://api.flowtly.eu/transaction-attachments

List transaction-attachments

Retrieve transaction attachments.

POST https://api.flowtly.eu/transaction-attachments

Create transaction-attachment

Create a transaction attachment.

GET https://api.flowtly.eu/transaction-attachments/{id}

Get transaction-attachment

Fetch a transaction attachment by ID.

PATCH https://api.flowtly.eu/transaction-attachments/{id}

Update transaction-attachment

Patch a transaction attachment.

DELETE https://api.flowtly.eu/transaction-attachments/{id}

Delete transaction-attachment

Delete a transaction attachment.

POST https://api.flowtly.eu/transaction-attachments/create

Upload transaction-attachment

Upload a new transaction attachment.

GET https://api.flowtly.eu/transaction-attachments/search

Search transaction-attachments

Search transaction attachments by query.

POST https://api.flowtly.eu/transaction-attachments/{id}/apply-suggestion

Creates a TransactionAttachment resource.

Creates a TransactionAttachment resource.

POST https://api.flowtly.eu/transaction-attachments/{id}/apply-supplier-suggestion

Creates a TransactionAttachment resource.

Creates a TransactionAttachment resource.

POST https://api.flowtly.eu/transaction-attachments/{id}/detach

Creates a TransactionAttachment resource.

Creates a TransactionAttachment resource.

GET https://api.flowtly.eu/transaction-attachments/{id}/suggestions

Retrieves the collection of TransactionAttachment resources.

Retrieves the collection of TransactionAttachment resources.

GET https://api.flowtly.eu/transaction-attachments/{id}/suggestions-debug

Retrieves a TransactionAttachment resource.

Retrieves a TransactionAttachment resource.

POST https://api.flowtly.eu/transaction-attachments/{id}/suggestions/{suggestionId}/apply

Creates a TransactionAttachment resource.

Creates a TransactionAttachment resource.

POST https://api.flowtly.eu/transactions/attachments/zip

Download transaction attachments as zip

Creates a TransactionAttachmentsZipExport resource.

GET https://api.flowtly.eu/transactions/export/mt940

Retrieves a TransactionMt940Export resource.

Retrieves a TransactionMt940Export resource.

GET https://api.flowtly.eu/transactions/with-problems

Retrieves the collection of Transaction resources.

Retrieves the collection of Transaction resources.

GET https://api.flowtly.eu/transactions/{id}/suggestions

Retrieves the collection of Transaction resources.

Retrieves the collection of Transaction resources.

POST https://api.flowtly.eu/transactions/{id}/suggestions/{suggestionId}/apply

Creates a Transaction resource.

Creates a Transaction resource.

Use cases

Push invoice payments from your accounting system so Flowtly reflects true-to-date spend.
Attach HR or vendor expenses to budgets the moment they are approved in your finance stack.

Schema fields

BudgetTransaction-budget_transaction.read_transaction.read
Field Type Description
budget string IRI referencing the impacted budget.
transaction object IRI to the original ERP transaction.
employee string | null Employee tied to the spend (nullable).
amount integer | null Amount booked against the budget.

Examples

POST https://api.flowtly.eu/budget-transactions

Link an ERP transaction to a budget

Associates a vendor invoice with the FY25 marketing budget and records the 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
}

Entity overview

Invoice

Expose invoice lifecycle data so finance, operations, and customer teams share one source of truth for billed revenue.

Endpoints

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

List invoices

Retrieve invoice collections with pagination and status filters.

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

Create invoice

Create a new invoice with client, rows, and payment metadata.

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

Get invoice by ID

Read a single invoice resource with rows and linked transactions.

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

Update invoice

Patch invoice status, due date, or metadata after review.

GET https://api.flowtly.eu/invoices/draft

Retrieves the collection of Invoice resources.

Retrieves the collection of Invoice resources.

GET https://api.flowtly.eu/invoices/name/{date}

Retrieves the collection of Invoice resources.

Retrieves the collection of Invoice resources.

POST https://api.flowtly.eu/invoices/send

Creates a Invoice resource.

Creates a Invoice resource.

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

Removes the Invoice resource.

Removes the Invoice resource.

GET https://api.flowtly.eu/invoices/{id}/send

Retrieves a Invoice resource.

Retrieves a Invoice resource.

POST https://api.flowtly.eu/invoices/{id}/send

Creates a Invoice resource.

Creates a Invoice resource.

Use cases

Sync invoices into BI dashboards to monitor overdue receivables and cash-flow risk.
Trigger customer reminder workflows when invoice status changes in Flowtly.

Schema fields

Invoice-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Field Type Description
id integer —
name string —
type string —
parent object —
childrenInvoices array —
client string —
tinType string —
tinCountry string | null —
tin string | null —
bankAccount string —
amountNet number —
amount number —
currency string | null —
conversionRate number | null —
generatedPdfExternalId string | null —
issueDate string —
saleDate string —
dueDate string —
targetAmount number | null —
paymentMethod string —
notes string | null —
invoiceRows array —
eInvoicing object —
invoiceTransactions array —
internalComment string —
targetAmountNet number | null —
status string —

Entity overview

Transaction

Integrate transaction data across banking and ERP systems to keep spend control and margin reporting current.

Endpoints

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

List transactions

Retrieve transaction collections with filtering for assignment and status.

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

Create transaction

Create a transaction entry with amount, currency, and account references.

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

Get transaction by ID

Read a single transaction including attachment and cost linkage.

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

Update transaction

Patch transaction classification, assignment, or reconciliation fields.

POST https://api.flowtly.eu/transactions/attachments/zip

Download transaction attachments as zip

Creates a TransactionAttachmentsZipExport resource.

GET https://api.flowtly.eu/transactions/export/mt940

Retrieves a TransactionMt940Export resource.

Retrieves a TransactionMt940Export resource.

POST https://api.flowtly.eu/transactions/import

Creates a Transaction resource.

Creates a Transaction resource.

GET https://api.flowtly.eu/transactions/unassigned

Retrieves the collection of Transaction resources.

Retrieves the collection of Transaction resources.

GET https://api.flowtly.eu/transactions/with-problems

Retrieves the collection of Transaction resources.

Retrieves the collection of Transaction resources.

GET https://api.flowtly.eu/transactions/{id}/suggestions

Retrieves the collection of Transaction resources.

Retrieves the collection of Transaction resources.

POST https://api.flowtly.eu/transactions/{id}/suggestions/{suggestionId}/apply

Creates a Transaction resource.

Creates a Transaction resource.

Use cases

Sync posted transactions to monthly close tooling for faster reconciliation.
Feed transaction streams into budget alerts and profitability views in real time.

Schema fields

Transaction-transaction.read
Field Type Description
id string —
bankAccount string —
employeeOwner string | null —
cost string | null —
counterparty object —
counterpartyRole string | null —
statementNumber integer —
operationNumber string | null —
description string —
amount number —
endingBalance number —
orderDate string —
execDate string —
relatedDate string | null —
ignored integer —
note string | null —
transactionAttachments array —
budgetTransactions array —
projectTransactions array —
connectedMonth string —
Whatsapp