← Referência da API

Clientes & contrapartes

Clientes, contactos e contrapartes — mantenha seu CRM e Flowtly sincronizados.

Cliente

Endpoints

GET /clients
POST /clients
GET /clients/{id}
PATCH /clients/{id}
GET /clients/{id}/documents
GET /clients/search

Campos de schema

CampoTipo
country* string (iri-reference)
currency* string (iri-reference)
defaultCost string,null (iri-reference)
status* string
attributeSet string,null (iri-reference)
name* string
dueDays integer
tinType* string
tinCountry stringnull
tin stringnull
externalPaymentCustomerId stringnull
invoiceComment stringnull
defaultTaxRate stringnull
documentsLanguage string
addressPhoneNumber stringnull
addressCity stringnull
addressPostCode stringnull
addressStreetLine stringnull
addressBuildingNumber stringnull
addressLocaleNumber stringnull
addressCountry string,null (iri-reference)
clientContacts array
vatNumber stringnull

Contato do Cliente

Endpoints

GET /client-contacts
POST /client-contacts
GET /client-contacts/{id}
PATCH /client-contacts/{id}
DELETE /client-contacts/{id}

Campos de schema

CampoTipo
id integer
client string (iri-reference)
type* string
position integer
email* string (email)
name* string
title stringnull
phone stringnull
createdAt string (date-time)
updatedAt string (date-time)
possibleTypes string

Nota do Cliente

Endpoints

GET /client-notes
POST /client-notes
GET /client-notes/{id}
PATCH /client-notes/{id}
DELETE /client-notes/{id}

Campos de schema

CampoTipo
id string
client* string (iri-reference)
employee* string (iri-reference)
note* string
createdAt string (date-time)
updatedAt string (date-time)

Contraparte

Endpoints

GET /counterparties
POST /counterparties
GET /counterparties/{id}
PATCH /counterparties/{id}
DELETE /counterparties/{id}
POST /counterparties/{id}/enrich-branding-ai
POST /counterparties/{id}/merge
POST /counterparties/enrich-branding-ai
POST /counterparty
PATCH /counterparty/{id}

Campos de schema

CampoTipo
id integer
type string
requireAttachment boolean
cyclic boolean
budgetNeutral boolean
logoUrl stringnull
corporateWebsiteUrl stringnull
displayName string
costGroupIcon stringnull