QUINCEFIN
Відкрити меню

QUINCE API. CRM-події

Список методів

МетодОпис
/api/v2/crm/event/listОтримання списку CRM-подій
/api/v2/crm/event/loadОтримання однієї події за Id
/api/v2/crm/event/addСтворення CRM-подій
/api/v2/crm/event/updateОновлення CRM-подій

Отримання списку CRM-подій

Назва методу: /api/v2/crm/event/list

Повертає список CRM-подій. Для навігації використовується номер сторінки page. Якщо розмір сторінки не перевизначений системними налаштуваннями, API повертає до 100 елементів.

Параметри запиту

ПолеТипОпис
filterobjectФільтр подій. Поля фільтра працюють з логікою AND.
filter.IdintegerІдентифікатор події.
filter.EventTypeintegerІдентифікатор типу події.
filter.EventStatusstringСтатус події.
filter.PartnerintegerІдентифікатор партнера.
filter.PersonintegerІдентифікатор контактної особи.
filter.DocumentintegerІдентифікатор пов’язаного документа.
filter.ResponsibleintegerІдентифікатор відповідального користувача.
filter.DateFromstringДата, починаючи з якої повертати події.
filter.DateTostringДата, до якої повертати події. У SQL-фільтрі використовується умова Date < DateTo.
filter.ArchivebooleanОзнака повернення архівних подій. Передається в API як Void.
filter.MobileAppbooleanЯкщо true, API використовує збільшений ліміт вибірки.
pageintegerНомер сторінки. Якщо не передати, використовується перша сторінка.

Основні поля відповіді

ПолеОпис
IdІдентифікатор події.
DateДата події.
MainEntityОсновна сутність події.
EventTypeІдентифікатор типу події.
EventTypeNameНазва типу події.
ProviderEventTypeТип події у зовнішньому провайдері.
EventChannelІдентифікатор каналу події.
EventChannelNameНазва каналу події.
EventStatusСтатус події.
ResponsibleІдентифікатор відповідального користувача.
ResponsibleNameІм’я відповідального користувача.
IntegrationProfileІдентифікатор інтеграційного профілю.
EmailIdІдентифікатор email у зовнішній системі.
DirectionНапрям події, визначається типом події.
NameНазва події.
PartnerІдентифікатор партнера.
PartnerNameНазва партнера.
PersonІдентифікатор контактної особи.
PersonNameІм’я контактної особи.
TypeТип пов’язаної сутності.
DocumentІдентифікатор пов’язаного документа.
Call_IdІдентифікатор дзвінка.
Call_ExternalNumberЗовнішній номер дзвінка.
Call_InternalNumberВнутрішній номер дзвінка.
Call_StatusСтатус дзвінка.
Call_LinkToRecordПосилання на запис дзвінка.
ContentТекст або зміст події.
VoidОзнака архівного запису.
DateCreatedДата створення.
DateModifiedДата останнього редагування.

Приклад запиту

{
  "filter": {
    "Partner": 123,
    "DateFrom": "2026-06-01",
    "DateTo": "2026-06-04",
    "Archive": false
  },
  "page": 1
}

Отримання однієї події

Назва методу: /api/v2/crm/event/load

Повертає одну CRM-подію за Id. Ідентифікатор можна передати напряму в тілі запиту або в filter.Id.

Приклад запиту

{
  "Id": 98765
}

Якщо Id не передати, API поверне помилку Execution terminated. "Id" is required.

Створення та оновлення CRM-подій

Назва методу створення: /api/v2/crm/event/add

Назва методу оновлення: /api/v2/crm/event/update

Методи додають або оновлюють події пакетами. Якщо системний ліміт пакета не перевизначений, максимальний розмір пакета - 100 елементів.

Параметри запиту

ПолеТипОпис
arrayarrayМасив подій. Обов’язковий.
array[].IdintegerІдентифікатор події. Обов’язковий для /api/v2/crm/event/update.
array[].DatestringДата події. Якщо не передати, використовується поточна дата сервера.
array[].MainEntitystringОсновна сутність події.
array[].EventTypeintegerІдентифікатор типу події. Обов’язковий для створення та оновлення.
array[].ProviderEventTypestringТип події у зовнішньому провайдері.
array[].EventChannelintegerІдентифікатор каналу події.
array[].EventStatusstringСтатус події. Якщо не передати, використовується planned.
array[].ResponsibleintegerІдентифікатор відповідального. Якщо не передати, використовується поточний API-користувач.
array[].IntegrationProfileintegerІдентифікатор інтеграційного профілю. Значення 0 зберігається як null.
array[].EmailIdstringІдентифікатор email у зовнішній системі.
array[].NamestringНазва події. Якщо не передати, використовується назва типу події.
array[].PartnerintegerІдентифікатор партнера.
array[].PersonintegerІдентифікатор контактної особи.
array[].TypestringТип пов’язаної сутності.
array[].DocumentintegerІдентифікатор пов’язаного документа.
array[].Call_IdstringІдентифікатор дзвінка.
array[].Call_ExternalNumberstringЗовнішній номер дзвінка.
array[].Call_InternalNumberstringВнутрішній номер дзвінка.
array[].Call_StatusstringСтатус дзвінка.
array[].Call_LinkToRecordstringПосилання на запис дзвінка.
array[].ContentstringТекст або зміст події.
array[].VoidbooleanОзнака архівного запису.

Приклад створення

{
  "array": [
    {
      "Date": "2026-06-03 10:30:00",
      "EventType": 15,
      "EventStatus": "planned",
      "Partner": 123,
      "Person": 456,
      "Name": "Дзвінок клієнту",
      "Content": "Уточнити деталі замовлення"
    }
  ]
}

Приклад оновлення

{
  "array": [
    {
      "Id": 98765,
      "EventType": 15,
      "EventStatus": "completed",
      "Content": "Клієнт підтвердив замовлення"
    }
  ]
}

Формат відповіді для add і update

ПолеОпис
successОзнака успішного виконання.
data[].IdІдентифікатор створеної або оновленої події.
data[].TempIdТимчасовий номер елемента в пакеті, який дає змогу зіставити відповідь із запитом.

Якщо array не передати або передати не масив, API поверне success: false і текст помилки Not valid format or empty array.