← Referência da API
Clientes & contrapartes
Clientes, contactos e contrapartes — mantenha seu CRM e Flowtly sincronizados.
Cliente
Endpoints
| GET | /clients | Retrieves the collection of Client resources. |
| POST | /clients | Creates a Client resource. |
| GET | /clients/{id} | Retrieves a Client resource. |
| PATCH | /clients/{id} | Updates the Client resource. |
| GET | /clients/{id}/documents | Retrieves a Client resource. |
| GET | /clients/search | Retrieves the collection of Client resources. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| 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 | Retrieves the collection of ClientContact resources. |
| POST | /client-contacts | Creates a ClientContact resource. |
| GET | /client-contacts/{id} | Retrieves a ClientContact resource. |
| PATCH | /client-contacts/{id} | Updates the ClientContact resource. |
| DELETE | /client-contacts/{id} | Removes the ClientContact resource. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| 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 | Retrieves the collection of ClientNote resources. |
| POST | /client-notes | Creates a ClientNote resource. |
| GET | /client-notes/{id} | Retrieves a ClientNote resource. |
| PATCH | /client-notes/{id} | Updates the ClientNote resource. |
| DELETE | /client-notes/{id} | Removes the ClientNote resource. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | |
| client* | string (iri-reference) | |
| employee* | string (iri-reference) | |
| note* | string | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |
Contraparte
Endpoints
| GET | /counterparties | Retrieves the collection of Counterparty resources. |
| POST | /counterparties | Creates a Counterparty resource. |
| GET | /counterparties/{id} | Retrieves a Counterparty resource. |
| PATCH | /counterparties/{id} | Updates the Counterparty resource. |
| DELETE | /counterparties/{id} | Removes the Counterparty resource. |
| POST | /counterparties/{id}/enrich-branding-ai | Queue single counterparty branding enrich via AI |
| POST | /counterparties/{id}/merge | Merge counterparties |
| POST | /counterparties/enrich-branding-ai | Queue counterparties branding enrich via AI |
| POST | /counterparty | Create supplier/client + counterparty by type |
| PATCH | /counterparty/{id} | Update supplier/client + counterparty by type |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | |
| type | string | |
| requireAttachment | boolean | |
| cyclic | boolean | |
| budgetNeutral | boolean | |
| logoUrl | stringnull | |
| corporateWebsiteUrl | stringnull | |
| displayName | string | |
| costGroupIcon | stringnull |