Skip to content

Invoicing & payments – 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.

Invoicing & payments

Invoice lifecycle, rows, transactions, e-invoicing, and payment methods.

Entity overview

Invoice

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

Endpoints

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

Create send

Creates a Invoice resource.

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

List invoices

Retrieves the collection of Invoice resources.

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

Create invoice

Creates a Invoice resource.

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

List draft

Retrieves the collection of Invoice resources.

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

Get invoice by ID

Retrieve a single resource by its identifier.

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

Create send

Creates a Invoice resource.

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

Get invoice by ID

Retrieve a single resource by its identifier.

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

Delete invoice

Remove the resource.

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

Update invoice

Update resource fields using JSON Merge Patch.

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

Get invoice by ID

Retrieve a single resource by its identifier.

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 id field.
name string name field.
type string type field.
parent object parent field.
childrenInvoices array childrenInvoices field.
client string client field.
tinType string tinType field.
tinCountry string | null tinCountry field.
tin string | null tin field.
bankAccount string bankAccount field.
amountNet number amountNet field.
amount number amount field.
currency string | null currency field.
conversionRate number | null conversionRate field.
generatedPdfExternalId string | null generatedPdfExternalId field.
issueDate string
saleDate string
dueDate string
targetAmount number | null
paymentMethod string
paidInAdvance boolean
notes string | null
correctionReason string | null
invoiceRows array
eInvoicing object
invoiceTransactions array
internalComment string
targetAmountNet number | null
status string

Entity overview

Invoice row

Manage invoice line items with quantity, unit price, tax, and description for granular billing control.

Endpoints

GET https://api.flowtly.eu/invoice-rows

List invoice rows

Retrieves the collection of InvoiceRow resources.

POST https://api.flowtly.eu/invoice-rows

Create invoice row

Creates a InvoiceRow resource.

GET https://api.flowtly.eu/invoice-rows/{id}

Get invoice row by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/invoice-rows/{id}

Update invoice row

Update resource fields using JSON Merge Patch.

Use cases

Generate invoice rows from approved timesheets automatically.
Push line-item corrections from your accounting system.

Schema fields

InvoiceRow-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Field Type Description
id integer id field.
classificationNumber string | null classificationNumber field.
unit string | null unit field.
quantity number quantity field.
vatRate string vatRate field.
netPrice string netPrice field.
netDiscountAmount string netDiscountAmount field.
productName string productName field.
project string | null project field.
parentInvoiceRow object parentInvoiceRow field.
invoiceChildrenRows array invoiceChildrenRows field.

Entity overview

Invoice transaction

Track which bank transactions settle which invoices for automated reconciliation.

Endpoints

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

List invoice transactions

Retrieves the collection of InvoiceTransaction resources.

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

Create invoice transaction

Creates a InvoiceTransaction resource.

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

Get invoice transaction by ID

Retrieve a single resource by its identifier.

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

Delete invoice transaction

Remove the resource.

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

Update invoice transaction

Update resource fields using JSON Merge Patch.

Use cases

Match incoming payments to open invoices from your banking feed.
Reconcile partial payments and overpayments across invoice sets.

Schema fields

InvoiceTransaction-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Field Type Description
id integer id field.
invoice object invoice field.
transaction object transaction field.
amount number | null amount field.
date string date field.

Entity overview

E-invoicing (KSeF)

Send, receive, and query e-invoices through the KSeF government platform for tax compliance.

Endpoints

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/download/xml

List xml

Retrieves the collection of InvoiceDownload resources.

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/{id}/download/upo

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/{id}/download/xml

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

POST https://api.flowtly.eu/e-invoicing/invoices/inbound/queue

Create queue

Creates a InboundInvoiceQueue resource.

POST https://api.flowtly.eu/e-invoicing/invoices/inbound/sync

Create sync

Creates a InboundInvoiceSync resource.

POST https://api.flowtly.eu/e-invoicing/invoices/{id}/correction

Creates a InvoiceCorrectionSend resource.

Creates a InvoiceCorrectionSend resource.

GET https://api.flowtly.eu/e-invoicing/invoices/download/xml

List xml

Retrieves the collection of InvoiceDownload resources.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/pdf

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/preview/pdf

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/upo

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/xml

Get e-invoicing (ksef) by ID

Retrieve a single resource by its identifier.

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

Creates a InvoiceSend resource.

Creates a InvoiceSend resource.

POST https://api.flowtly.eu/e-invoicing/ksef/session

Create session

Creates a KsefSession resource.

Use cases

Auto-submit sales invoices to KSeF and store the official UPO receipt.
Download inbound purchase invoices from KSeF into your AP workflow.

Schema fields

InvoiceEInvoicing.jsonld-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Field Type Description
@context object
@id string
@type string
id integer
provider string
status string
referenceNumber string | null
documentId string | null
acquisitionTimestamp string | null
upoUrl string | null
verificationLink string | null
rejectionReason string | null
providerPayload array | null
einvoicingNumber string | null

Entity overview

Payment method

Configure payment methods (bank transfer, card, etc.) and track payment transactions.

Endpoints

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

List payment methods

Retrieves the collection of PaymentMethod resources.

GET https://api.flowtly.eu/payment-methods

List payment methods

Retrieves the collection of PaymentMethod resources.

POST https://api.flowtly.eu/payment-methods/create-setup-intent

Create create setup intent

Creates a PaymentMethod resource.

GET https://api.flowtly.eu/payment-methods/{id}

Get payment method by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/payment-methods/{id}

Delete payment method

Remove the resource.

PATCH https://api.flowtly.eu/payment-methods/{id}

Update payment method

Update resource fields using JSON Merge Patch.

Use cases

Set default payment terms per client for invoice generation.
Query payment history for customer account statements.

Schema fields

PaymentMethod-payment_method.read
Field Type Description
id string id field.
type string type field.
ccBrand string ccBrand field.
ccLastDigits string ccLastDigits field.
ccExpMonth integer ccExpMonth field.
ccExpYear integer ccExpYear field.
externalId string externalId field.
Whatsapp