Clientes e contrapartes – construir no Flowtly

Utilize este instantâneo selecionado do esquema OpenAPI do Flowtly para planear integrações, automatizar fluxos de trabalho e sincronizar os dados em que as suas equipas confiam.

Estado da documentação

Última sincronização em 2026-04-03 18:31 (versão da aplicação 2.0.0)

Apenas um subconjunto de entidades é tornado público. Execute ambos os comandos de sincronização para atualizar esta documentação quando a aplicação Flowtly disponibilizar novas capacidades.

Clientes e contrapartes

Dados-mestre de clientes, contactos, notas e gestão de contrapartes.

Visão geral da entidade

Cliente

Manter os sistemas de CRM e entrega alinhados com os registos de clientes, contactos e referências de documentos do Flowtly.

Endpoints

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

Listar clientes

Obtém a coleção de recursos Client.

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

Criar cliente

Cria um recurso Client.

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

Listar pesquisa

Obtém a coleção de recursos Client.

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

Obter cliente por ID

Obter um único recurso pelo seu identificador.

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

Atualizar cliente

Atualizar campos do recurso utilizando JSON Merge Patch.

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

Obter cliente por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Sincronizar contas qualificadas do CRM no Flowtly antes do arranque do projeto.
Utilizar atualizações de clientes para manter a faturação, os acordos e a propriedade da conta alinhados.

Campos do esquema

Client-client.read_client_contact.read_storage.read
Campo Tipo Descrição
id integer Campo id.
country string Campo country.
currency string Campo currency.
defaultCost string | null Campo defaultCost.
status string Campo status.
attributeSet string | null Campo attributeSet.
name string Campo name.
dueDays integer Campo dueDays.
tinType string Campo tinType.
tinCountry string | null Campo tinCountry.
tin string | null Campo tin.
externalPaymentCustomerId string | null Campo externalPaymentCustomerId.
invoiceComment string | null Campo invoiceComment.
defaultTaxRate string | null Campo defaultTaxRate.
documentsLanguage string Campo documentsLanguage.
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 —

Visão geral da entidade

Contacto de cliente

Armazenar e gerir múltiplos contactos por cliente para comunicação, faturação e coordenação de projetos.

Endpoints

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

Listar contactos de clientes

Obtém a coleção de recursos ClientContact.

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

Criar contacto de cliente

Cria um recurso ClientContact.

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

Obter contacto de cliente por ID

Obter um único recurso pelo seu identificador.

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

Eliminar contacto de cliente

Eliminar o recurso.

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

Atualizar contacto de cliente

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Importar contactos decisores do seu CRM para mapeamento de partes interessadas do projeto.
Sincronizar contactos de faturação para garantir que as faturas chegam à pessoa certa.

Campos do esquema

ClientContact-client.read_client_contact.read_storage.read
Campo Tipo Descrição
id integer Campo id.
type string Campo type.
position integer Campo position.
email string Campo email.
name string Campo name.
title string | null Campo title.
phone string | null Campo phone.

Visão geral da entidade

Nota de cliente

Acompanhar informações de vendas, histórico de contas e contexto de relacionamento junto dos registos de clientes.

Endpoints

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

Listar notas de clientes

Obtém a coleção de recursos ClientNote.

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

Criar nota de cliente

Cria um recurso ClientNote.

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

Obter nota de cliente por ID

Obter um único recurso pelo seu identificador.

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

Eliminar nota de cliente

Eliminar o recurso.

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

Atualizar nota de cliente

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Enviar notas de atividade do CRM para o Flowtly para visibilidade entre equipas.
Registar decisões de conta-chave para efeitos de auditoria e transferência.

Campos do esquema

ClientNote-client_note.read
Campo Tipo Descrição
id string Campo id.
client string Campo client.
employee string Campo employee.
note string Campo note.
updatedAt string Campo updatedAt.

Visão geral da entidade

Contraparte

Gerir dados-mestre de contrapartes com identificadores legais, contas bancárias e endereços para transações e conformidade.

Endpoints

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

Listar contrapartes

Obtém a coleção de recursos Counterparty.

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

Criar contraparte

Cria um recurso Counterparty.

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

Criar enriquecimento de branding por IA

Colocar contrapartes na fila para enriquecimento de branding via IA

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

Obter contraparte por ID

Obter um único recurso pelo seu identificador.

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

Eliminar contraparte

Eliminar o recurso.

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

Atualizar contraparte

Atualizar campos do recurso utilizando JSON Merge Patch.

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

Colocar uma única contraparte na fila para enriquecimento de branding via IA

Colocar uma única contraparte na fila para enriquecimento de branding via IA

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

Fundir contrapartes

Fundir contrapartes

Casos de uso

Desduplicar fornecedores e clientes sincronizando registos de contrapartes com o seu ERP.
Validar NIF de contrapartes junto de registos governamentais.

Campos do esquema

Counterparty-counterparty.read_counterparty.item.read
Campo Tipo Descrição
id integer Campo id.
type string Campo type.
supplier string | null Campo supplier.
client string | null Campo client.
requireAttachment boolean Campo requireAttachment.
cyclic boolean Campo cyclic.
budgetNeutral boolean Campo budgetNeutral.
logoUrl string | null Campo logoUrl.
corporateWebsiteUrl string | null Campo corporateWebsiteUrl.
defaultProject string | null Campo defaultProject.
bankAccounts array Campo bankAccounts.
transactionsCount integer Campo transactionsCount.
tin string | null Campo tin.
supplierTin string | null Campo supplierTin.
clientTin string | null —
displayName string —
costGroup array | null —
costGroupIcon string | null —
Whatsapp