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-04-03 18:31 (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

Financial plans, allocations, cost groups, 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

Retrieves the collection of Budget resources.

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

Create budget

Creates a Budget resource.

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

Get budget by ID

Retrieve a single resource by its identifier.

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

Delete budget

Remove the resource.

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

Update budget

Update resource fields using JSON Merge Patch.

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_budget_project.read

Field	Type	Description
`id`	string	id field.
`name`	string	name field.
`type`	string	type field.
`granularity`	string	granularity field.
`budgetGroup`	string \| null	budgetGroup field.
`attributeSet`	string \| null	attributeSet field.
`dateFrom`	string \| null	dateFrom field.
`dateTo`	string \| null	dateTo field.
`config`	array	config field.
`budgetEmployees`	array	budgetEmployees field.
`budgetProjects`	array	budgetProjects field.

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

Retrieves the collection of BudgetTransaction resources.

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

Create budget transaction

Creates a BudgetTransaction resource.

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

Get budget transaction by ID

Retrieve a single resource by its identifier.

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

Delete budget transaction

Remove the resource.

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

Update budget transaction

Update resource fields using JSON Merge Patch.

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	budget field.
`transaction`	object	transaction field.
`employee`	string \| null	employee field.
`amount`	string \| null	amount field.

Entity overview

Budget group

Organize budgets into logical groups (departments, projects, cost centers) for roll-up reporting.

Endpoints

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

List budget groups

Retrieves the collection of BudgetGroup resources.

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

Create budget group

Creates a BudgetGroup resource.

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

Get budget group by ID

Retrieve a single resource by its identifier.

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

Delete budget group

Remove the resource.

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

Update budget group

Update resource fields using JSON Merge Patch.

Use cases

Mirror your chart of accounts hierarchy into Flowtly budget groups.

Create budget groups per business unit for consolidated spend dashboards.

Schema fields

BudgetGroup-budget_group.read_budget_group.projects.read

Field	Type	Description
`id`	string	id field.
`name`	string	name field.
`projects`	array	projects field.

Entity overview

Cost & supplier

Track operational costs, group them for analysis, and manage contractor/supplier relationships.

Endpoints

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

List cost & suppliers

Retrieves the collection of CostGroup resources.

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

Create cost & supplier

Creates a CostGroup resource.

POST https://api.flowtly.eu/contractors/nip-validation

Create nip validation

Creates a Cost resource.

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

List search

Retrieves the collection of Cost resources.

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

Delete cost & supplier

Remove the resource.

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

Update cost & supplier

Update resource fields using JSON Merge Patch.

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

List cost & suppliers

Retrieves the collection of CostGroup resources.

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

Create cost & supplier

Creates a CostGroup resource.

GET https://api.flowtly.eu/costs/payment-due/{date}

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

Update cost & supplier

Update resource fields using JSON Merge Patch.

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

List cost & suppliers

Retrieves the collection of CostGroup resources.

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

Create cost & supplier

Creates a CostGroup resource.

POST https://api.flowtly.eu/suppliers/nip-validation

Create nip validation

Creates a Cost resource.

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

List search

Retrieves the collection of Cost resources.

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

Delete cost & supplier

Remove the resource.

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

Update cost & supplier

Update resource fields using JSON Merge Patch.

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

List cost & suppliers

Retrieves the collection of CostGroup resources.

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

Create cost & supplier

Creates a CostGroup resource.

POST https://api.flowtly.eu/cost-groups/assign-icons-ai

Create assign icons ai

Assign cost group icons via AI

GET https://api.flowtly.eu/cost-groups/chart

List chart

Get cost groups chart

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

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

Update cost & supplier

Update resource fields using JSON Merge Patch.

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

Get cost & supplier by ID

Retrieve a single resource by its identifier.

POST https://api.flowtly.eu/cost-groups/{id}/merge

Merge cost groups

Use cases

Sync vendor invoices into cost records for real-time margin tracking.

Import contractor rates from procurement to automate project costing.

Schema fields

Cost-cost.read_cost_group.read

Field	Type	Description
`id`	integer	id field.
`costGroup`	object	costGroup field.
`ownerEmployee`	string \| null	ownerEmployee field.
`tinType`	string	tinType field.
`tin`	string \| null	tin field.
`tinCountry`	string \| null	tinCountry field.
`cyclic`	boolean	cyclic field.
`paymentDeadline`	integer \| null	paymentDeadline field.
`name`	string	name field.
`description`	string \| null	description field.
`matchRegex`	string \| null	matchRegex field.
`requireAttachment`	boolean \| null	requireAttachment field.
`taxAmount`	string \| null	taxAmount field.
`notIncludeInChart`	boolean	notIncludeInChart field.
`eInvoicingReferenceNumber`	string \| null	eInvoicingReferenceNumber field.
`eInvoicingSourceXmlUrl`	string \| null	—
`eInvoicingVisualUrl`	string \| null	—
`createdAt`	string	—
`costGroupIcon`	string \| null	—
`contractorGroup`	object	—

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

Retrieves the collection of TransactionAttachment resources.

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

Create transaction

Creates a TransactionAttachment resource.

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

Create import

Creates a Transaction resource.

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

List unassigned

Retrieves the collection of Transaction resources.

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

List with problems

Retrieves the collection of Transaction resources.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Delete transaction

Remove the resource.

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

Update transaction

Update resource fields using JSON Merge Patch.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Creates a TransactionAttachment resource.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Creates a TransactionAttachment resource.

POST https://api.flowtly.eu/transactions/{id}/allocation/preview

Creates a TransactionAllocationPreviewInput resource.

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

List transactions

Retrieves the collection of TransactionAttachment resources.

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

Create transaction

Creates a TransactionAttachment resource.

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

Create create

Creates a TransactionAttachment resource.

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

List search

Retrieves the collection of TransactionAttachment resources.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Delete transaction

Remove the resource.

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

Update transaction

Update resource fields using JSON Merge Patch.

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

Creates a TransactionAttachment resource.

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

Creates a TransactionAttachment resource.

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

Creates a TransactionAttachment resource.

POST https://api.flowtly.eu/transaction-attachments/{id}/mark-manual-paid

Creates a TransactionAttachment resource.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Get transaction by ID

Retrieve a single resource by its identifier.

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

Creates a TransactionAttachment resource.

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

Create zip

Download transaction attachments as zip

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

List mt940

Retrieves a TransactionMt940Export resource.

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

List pdf

Retrieves a TransactionPdfExport 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

TransactionAttachment-transaction.read_transaction_attachment.read_cost.read_storage.read

Field	Type	Description
`id`	integer	id field.
`cost`	object	cost field.
`counterparty`	object	counterparty field.
`currency`	string \| null	currency field.
`relatedMonth`	string \| null	relatedMonth field.
`externalId`	string	externalId field.
`employee`	string \| null	employee field.
`amount`	integer \| null	amount field.
`amountNet`	integer \| null	amountNet field.
`name`	string	name field.
`description`	string	description field.
`note`	string \| null	note field.
`receivedAt`	string	receivedAt field.
`approvalsCount`	integer	approvalsCount field.
`suggestionsCount`	integer	suggestionsCount field.
`sourceType`	string	—
`type`	string	—
`paidAt`	string \| null	—
`transaction`	object	—
`invoiceLines`	array	—
`createdAt`	string	—
`counterpartyName`	string \| null	—
`status`	string	—

Entity overview

Bank account

Manage bank account records used for payment routing, reconciliation, and treasury reporting.

Endpoints

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

List bank accounts

Retrieves the collection of BankAccount resources.

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

Create bank account

Creates a BankAccount resource.

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

Get bank account by ID

Retrieve a single resource by its identifier.

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

Update bank account

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/bank-accounts

List bank accounts

Retrieves the collection of BankAccount resources.

POST https://api.flowtly.eu/bank-accounts

Create bank account

Creates a BankAccount resource.

GET https://api.flowtly.eu/bank-accounts/{id}

Get bank account by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/bank-accounts/{id}

Update bank account

Update resource fields using JSON Merge Patch.

Use cases

Sync account balances for cash-flow forecasting inside Flowtly.

Schema fields

BankAccount-bank_account.read_bank.read

Field	Type	Description
`id`	integer	id field.
`bank`	object	bank field.
`type`	string	type field.
`default`	boolean	default field.
`hidden`	boolean	hidden field.
`name`	string	name field.
`number`	string \| null	number field.
`prefix`	string \| null	prefix field.
`currency`	string \| null	currency field.
`defaultImportFormat`	string	defaultImportFormat field.

Entity overview

Tax group & rule

Define tax groups with associated rules for accurate invoice and transaction tax computation.

Endpoints

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

List tax group & rules

Retrieves the collection of TaxRule resources.

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

Create tax group & rule

Creates a TaxRule resource.

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

Get tax group & rule by ID

Retrieve a single resource by its identifier.

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

Update tax group & rule

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/tax-rules

List tax group & rules

Retrieves the collection of TaxRule resources.

POST https://api.flowtly.eu/tax-rules

Create tax group & rule

Creates a TaxRule resource.

GET https://api.flowtly.eu/tax-rules/{id}

Get tax group & rule by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/tax-rules/{id}

Delete tax group & rule

Remove the resource.

PATCH https://api.flowtly.eu/tax-rules/{id}

Update tax group & rule

Update resource fields using JSON Merge Patch.

Use cases

Import VAT rate tables from your accounting system for consistent invoicing.

Configure country-specific tax rules for multi-jurisdiction billing.

Schema fields

TaxGroup-tax_group.read_tax_rule.read

Field	Type	Description
`id`	string	id field.
`name`	string	name field.
`isDefault`	boolean	isDefault field.
`taxRules`	array	taxRules field.

Entity overview

Currency

Query available currencies used across invoices, budgets, and transactions.

Endpoints

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

List currencys

Retrieves the collection of Currency resources.

GET https://api.flowtly.eu/currencies/{!sourceCurrency}/rates/{!targetCurrency}/{date}

Get currency by ID

Retrieve a single resource by its identifier.

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

Get currency by ID

Retrieve a single resource by its identifier.

Use cases

Look up supported currencies before creating multi-currency invoices.

Sync exchange rates for consolidated financial reporting.

Schema fields

Currency-currency.read

Field	Type	Description
`id`	string	id field.
`name`	string	name field.