Clients & counterparties – 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.

Clients & counterparties

Customer master data, contacts, notes, and counterparty management.

Entity overview

Client

Keep CRM and delivery systems aligned with Flowtly client records, contacts, and document references.

Endpoints

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

List clients

Retrieves the collection of Client resources.

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

Create client

Creates a Client resource.

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

List search

Retrieves the collection of Client resources.

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

Get client by ID

Retrieve a single resource by its identifier.

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

Update client

Update resource fields using JSON Merge Patch.

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

Get client by ID

Retrieve a single resource by its identifier.

Use cases

Sync qualified CRM accounts into Flowtly before project kickoff.
Use client updates to keep invoicing, agreements, and account ownership aligned.

Schema fields

Client-client.read_client_contact.read_storage.read
Field Type Description
id integer id field.
country string country field.
currency string currency field.
defaultCost string | null defaultCost field.
status string status field.
attributeSet string | null attributeSet field.
name string name field.
dueDays integer dueDays field.
tinType string tinType field.
tinCountry string | null tinCountry field.
tin string | null tin field.
externalPaymentCustomerId string | null externalPaymentCustomerId field.
invoiceComment string | null invoiceComment field.
defaultTaxRate string | null defaultTaxRate field.
documentsLanguage string documentsLanguage field.
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 —

Entity overview

Client contact

Store and manage multiple contacts per client for communication, invoicing, and project coordination.

Endpoints

GET https://api.flowtly.eu/client-contacts

List client contacts

Retrieves the collection of ClientContact resources.

POST https://api.flowtly.eu/client-contacts

Create client contact

Creates a ClientContact resource.

GET https://api.flowtly.eu/client-contacts/{id}

Get client contact by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/client-contacts/{id}

Delete client contact

Remove the resource.

PATCH https://api.flowtly.eu/client-contacts/{id}

Update client contact

Update resource fields using JSON Merge Patch.

Use cases

Import decision-maker contacts from your CRM for project stakeholder mapping.
Sync billing contacts to ensure invoices reach the right person.

Schema fields

ClientContact-client.read_client_contact.read_storage.read
Field Type Description
id integer id field.
type string type field.
position integer position field.
email string email field.
name string name field.
title string | null title field.
phone string | null phone field.

Entity overview

Client note

Track sales intel, account history, and relationship context alongside client records.

Endpoints

GET https://api.flowtly.eu/client-notes

List client notes

Retrieves the collection of ClientNote resources.

POST https://api.flowtly.eu/client-notes

Create client note

Creates a ClientNote resource.

GET https://api.flowtly.eu/client-notes/{id}

Get client note by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/client-notes/{id}

Delete client note

Remove the resource.

PATCH https://api.flowtly.eu/client-notes/{id}

Update client note

Update resource fields using JSON Merge Patch.

Use cases

Push CRM activity notes to Flowtly for cross-team visibility.
Log key account decisions for audit and handover purposes.

Schema fields

ClientNote-client_note.read
Field Type Description
id string id field.
client string client field.
employee string employee field.
note string note field.
updatedAt string updatedAt field.

Entity overview

Counterparty

Manage counterparty master data with legal identifiers, bank accounts, and addresses for transactions and compliance.

Endpoints

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

List counterpartys

Retrieves the collection of Counterparty resources.

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

Create counterparty

Creates a Counterparty resource.

POST https://api.flowtly.eu/counterparties/enrich-branding-ai

Create enrich branding ai

Queue counterparties branding enrich via AI

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

Get counterparty by ID

Retrieve a single resource by its identifier.

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

Delete counterparty

Remove the resource.

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

Update counterparty

Update resource fields using JSON Merge Patch.

POST https://api.flowtly.eu/counterparties/{id}/enrich-branding-ai

Queue single counterparty branding enrich via AI

Queue single counterparty branding enrich via AI

POST https://api.flowtly.eu/counterparties/{id}/merge

Merge counterparties

Merge counterparties

Use cases

Deduplicate vendors and clients by syncing counterparty records with your ERP.
Validate counterparty tax IDs against government registries.

Schema fields

Counterparty-counterparty.read_counterparty.item.read
Field Type Description
id integer id field.
type string type field.
supplier string | null supplier field.
client string | null client field.
requireAttachment boolean requireAttachment field.
cyclic boolean cyclic field.
budgetNeutral boolean budgetNeutral field.
logoUrl string | null logoUrl field.
corporateWebsiteUrl string | null corporateWebsiteUrl field.
defaultProject string | null defaultProject field.
bankAccounts array bankAccounts field.
transactionsCount integer transactionsCount field.
tin string | null tin field.
supplierTin string | null supplierTin field.
clientTin string | null —
displayName string —
costGroup array | null —
costGroupIcon string | null —
Whatsapp