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

QUINCE API. Задачі

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

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

Отримання списку задач

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

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

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

ПолеТипОпис
filterobjectФільтр задач. Поля фільтра працюють з логікою AND.
filter.IdintegerІдентифікатор задачі.
filter.NamestringПошук за назвою задачі. Пошук виконується як входження рядка без урахування регістру.
filter.ProjectintegerІдентифікатор проєкту.
filter.OwnerintegerІдентифікатор власника задачі.
filter.AssigneeintegerІдентифікатор виконавця задачі.
filter.TaskStatusintegerІдентифікатор статусу задачі.
filter.ArchivebooleanОзнака повернення архівних задач. Передається в API як Void.
filter.MobileAppbooleanЯкщо true, API використовує збільшений ліміт вибірки.
pageintegerНомер сторінки. Якщо не передати, використовується перша сторінка.

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

ПолеОпис
IdІдентифікатор задачі.
NumberНомер задачі.
NameНазва задачі.
ProjectІдентифікатор проєкту.
ProjectNameНазва проєкту.
DescriptionОпис.
OwnerІдентифікатор власника задачі.
OwnerNameІм’я власника задачі.
AssigneeІдентифікатор виконавця.
AssigneeNameІм’я виконавця.
DateStartДата початку.
DateDueПланова дата завершення.
DateCompletedФактична дата завершення.
TaskStatusІдентифікатор статусу.
TaskStatusNameНазва статусу.
TaskTypeІдентифікатор типу задачі.
TaskTypeNameНазва типу задачі.
TaskPriorityПріоритет задачі.
VoidОзнака архівного запису.
DateCreatedДата створення.
DateModifiedДата останнього редагування.

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

{
  "filter": {
    "Assignee": 7,
    "TaskStatus": 3,
    "Archive": false
  },
  "page": 1
}

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

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

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

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

{
  "Id": 24680
}

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

Створення та оновлення задач

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

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

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

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

ПолеТипОпис
arrayarrayМасив задач. Обов’язковий.
array[].IdintegerІдентифікатор задачі. Обов’язковий для /api/v2/crm/task/update.
array[].NamestringНазва задачі. Обов’язкова для створення та оновлення.
array[].ProjectintegerІдентифікатор проєкту. Якщо не передати, використовується проєкт задач за замовчуванням.
array[].DescriptionstringОпис.
array[].OwnerintegerІдентифікатор власника задачі. Якщо не передати, використовується поточний API-користувач.
array[].AssigneeintegerІдентифікатор виконавця.
array[].DateStartstringДата початку.
array[].DateDuestringПланова дата завершення.
array[].DateCompletedstringФактична дата завершення.
array[].TaskStatusintegerІдентифікатор статусу. Якщо не передати, використовується статус за замовчуванням для проєкту.
array[].TaskTypeintegerІдентифікатор типу задачі. Якщо не передати, використовується тип за замовчуванням для проєкту.
array[].TaskPrioritystringПріоритет задачі. Якщо не передати, використовується Medium.
array[].VoidbooleanОзнака архівного запису.
array[].ObjectLinksarrayЗв’язки задачі з іншими сутностями. Також підтримується назва Links.
ПолеОпис
ObjectLinks[].EntityКод сутності, з якою пов’язана задача.
ObjectLinks[].ObjectІдентифікатор об’єкта.
ObjectLinks[].IdАльтернативне поле для ідентифікатора об’єкта, якщо Object не передано.
ObjectLinks[].LinkTypeТип зв’язку. Якщо не передати, використовується RelatesTo.

Якщо передати ObjectLinks або Links, API синхронізує зв’язки задачі із зазначеними об’єктами. Якщо під час оновлення задачі зв’язки не передати, наявні зв’язки зберігаються.

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

{
  "array": [
    {
      "Name": "Передзвонити клієнту",
      "Description": "Уточнити умови оплати",
      "Assignee": 7,
      "DateDue": "2026-06-05 12:00:00",
      "TaskPriority": "High",
      "ObjectLinks": [
        {
          "Entity": "M_LEAD",
          "Object": 12345
        }
      ]
    }
  ]
}

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

{
  "array": [
    {
      "Id": 24680,
      "Name": "Передзвонити клієнту",
      "TaskStatus": 4,
      "DateCompleted": "2026-06-05 11:40:00"
    }
  ]
}

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

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

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