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

QUINCE API. Задачі

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

МетодОпис
/api/v2/task/listОтримання списку задач
/api/v2/task/loadОтримання однієї задачі за Id
/api/v2/task/addСтворення задач
/api/v2/task/updateОновлення задач
/api/v2/task/status/listОтримання статусів задач
/api/v2/task/status/addСтворення статусу задачі
/api/v2/task/status/updateОновлення статусу задачі
/api/v2/task/status/deleteВидалення або архівування статусу задачі
/api/v2/task/project_status/listОтримання статусів задач у межах проєктів
/api/v2/task/project_status/addДодавання статусу до проєкту
/api/v2/task/project_status/updateОновлення налаштувань статусу в проєкті
/api/v2/task/project_status/deleteВидалення статусу з проєкту
/api/v2/task/tag/listОтримання тегів задач
/api/v2/task/tag/addСтворення тегу задач
/api/v2/task/tag/updateОновлення тегу задач
/api/v2/task/tag/deleteВидалення тегу задач
/api/v2/attachment/listОтримання вкладень задачі через EntityType: "task"
/api/v2/attachment/addДодавання вкладення до задачі через EntityType: "task"
/api/v2/attachment/deleteВидалення зв’язку вкладення із задачею через EntityType: "task"

Для сумісності також підтримуються CRM-шляхи /api/v2/crm/task/list, /api/v2/crm/task/load, /api/v2/crm/task/add і /api/v2/crm/task/update.

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

Назва методу: /api/v2/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/task/load

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

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

{
  "Id": 24680
}

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

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

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

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

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

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

ПолеТипОпис
arrayarrayМасив задач. Обов’язковий.
array[].IdintegerІдентифікатор задачі. Обов’язковий для /api/v2/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.
array[].TagsarrayСписок тегів задачі. Можна передавати масив ідентифікаторів тегів або об’єкти з Tag, TagId чи Id.
array[].TagValuesarrayАльтернативна назва для списку тегів.
ПолеОпис
ObjectLinks[].EntityКод сутності, з якою пов’язана задача.
ObjectLinks[].ObjectІдентифікатор об’єкта.
ObjectLinks[].IdАльтернативне поле для ідентифікатора об’єкта, якщо Object не передано.
ObjectLinks[].LinkTypeТип зв’язку. Якщо не передати, використовується RelatesTo.

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

Якщо передати Tags або TagValues, API синхронізує теги задачі з переданим списком. Якщо поле тегів не передати, наявні теги зберігаються. Щоб очистити теги задачі, передайте порожній масив: "Tags": [].

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

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

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

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

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

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

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

Статуси задач

Методи /api/v2/task/status/* керують загальним довідником статусів задач.

ПолеОпис
IdІдентифікатор статусу.
NameНазва статусу.
PriorityПорядок сортування.
KindТип стану: N - новий або звичайний, P - у роботі, D - завершений, C - скасований.
ColorКод кольору статусу.
VoidОзнака архівного статусу.

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

{
  "Name": "Очікує клієнта",
  "Priority": 40,
  "Kind": "P",
  "Color": "blue"
}

Статуси задач у проєктах

Методи /api/v2/task/project_status/* керують тим, які статуси доступні в конкретному проєкті.

ПолеОпис
ProjectІдентифікатор проєкту. Обов’язковий для add, update і delete.
TaskStatusІдентифікатор статусу задачі. Також підтримується назва Status.
AltNameАльтернативна назва статусу в межах проєкту.
IsUsedЧи використовується статус у проєкті.
IsDefaultЧи є статус початковим для задач у цьому проєкті. Якщо передати true, інші статуси проєкту перестають бути початковими.

Приклад додавання статусу до проєкту

{
  "Project": 10,
  "TaskStatus": 125,
  "AltName": "Очікує клієнта",
  "IsUsed": true,
  "IsDefault": false
}

Теги задач

Методи /api/v2/task/tag/* керують довідником тегів задач. Теги можна передавати в Tags або TagValues під час створення чи оновлення задач.

ПолеОпис
IdІдентифікатор тегу.
NameНазва тегу.
ColorКолір тегу.
PriorityПорядок сортування.
ParentБатьківський тег, якщо використовується ієрархія.
FolderОзнака папки.
VoidОзнака архівного тегу.
HintКоротка підказка.

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

{
  "Name": "VIP",
  "Color": "purple",
  "Priority": 10
}

Вкладення задач

Вкладення задач працюють через загальні методи /api/v2/attachment/list, /api/v2/attachment/add і /api/v2/attachment/delete. Для задач потрібно передавати EntityType: "task" і EntityId з ідентифікатором задачі.

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

{
  "EntityType": "task",
  "EntityId": 24680,
  "Name": "brief.pdf",
  "Mime": "application/pdf",
  "Base64": "JVBERi0xLjQ..."
}

Приклад отримання вкладень задачі

{
  "filter": {
    "EntityType": "task",
    "EntityId": 24680
  }
}

Приклад видалення вкладення із задачі

{
  "EntityType": "task",
  "EntityId": 24680,
  "AttachmentId": 501
}