Клієнти та контрагенти
Клієнти, контакти та контрагенти — синхронізуйте вашу CRM та Flowtly.
Клієнт
Endpoints
| GET | /clients | Отримує колекцію ресурсів Client. |
| POST | /clients | Створює ресурс Client. |
| GET | /clients/{id} | Отримує ресурс Client. |
| PATCH | /clients/{id} | Оновлює ресурс Client. |
| GET | /clients/{id}/documents | Отримує ресурс Client. |
| GET | /clients/search | Отримує колекцію ресурсів Client. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| 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 |
Контакт клієнта
Endpoints
| GET | /client-contacts | Отримує колекцію ресурсів ClientContact. |
| POST | /client-contacts | Створює ресурс ClientContact. |
| GET | /client-contacts/{id} | Отримує ресурс ClientContact. |
| PATCH | /client-contacts/{id} | Оновлює ресурс ClientContact. |
| DELETE | /client-contacts/{id} | Видаляє ресурс ClientContact. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| 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 |
Примітка клієнта
Endpoints
| GET | /client-notes | Отримує колекцію ресурсів ClientNote. |
| POST | /client-notes | Створює ресурс ClientNote. |
| GET | /client-notes/{id} | Отримує ресурс ClientNote. |
| PATCH | /client-notes/{id} | Оновлює ресурс ClientNote. |
| DELETE | /client-notes/{id} | Видаляє ресурс ClientNote. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| id | string | |
| client* | string (iri-reference) | |
| employee* | string (iri-reference) | |
| note* | string | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |
Контрагент
Endpoints
| GET | /counterparties | Отримує колекцію ресурсів Counterparty. |
| POST | /counterparties | Створює ресурс Counterparty. |
| GET | /counterparties/{id} | Отримує ресурс Counterparty. |
| PATCH | /counterparties/{id} | Оновлює ресурс Counterparty. |
| DELETE | /counterparties/{id} | Видаляє ресурс Counterparty. |
| 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 |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| id | integer | |
| type | string | |
| requireAttachment | boolean | |
| cyclic | boolean | |
| budgetNeutral | boolean | |
| logoUrl | stringnull | |
| corporateWebsiteUrl | stringnull | |
| displayName | string | |
| costGroupIcon | stringnull |
Банківський рахунок контрагента
Endpoints
| POST | /counterparty-bank-accounts | Створює ресурс CounterpartyBankAccount. |
| DELETE | /counterparty-bank-accounts/{id} | Видаляє ресурс CounterpartyBankAccount. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| id | integer | |
| counterparty | string (iri-reference) | |
| accountNumber | string | |
| accountNumberNormalized | string | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |