KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
Склад (WM)
Сделки (DM)
Типы
Статусы
Сделки
GET Список
POST Создать
Сделка
Аналитика
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Сделки

Методы для управления сделками организации.

# Список сделок

GET
/companies/{id}/modules/dm/deals

Возвращает список сделок с пагинацией и фильтрацией.

Структура ответа

RESPONSE_DATA:
application/json
dealsrequired
array
Сделки
Список сделок (Deal[])
paginationrequired
array
pagination

Сделка

DEAL:
application/json
idrequired
string
ID
Уникальный идентификатор сделки
commentoptional
string
Комментарий
Комментарий к сделке
type_idoptional
string
ID типа
Идентификатор типа сделки
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)
client_idoptional
string
ID клиента
Идентификатор клиента
clientoptional
array
Клиент
Данные клиента (ClientDetail). Подробнее в статье модуля CRM.
employeesrequired
array
Сотрудники
Список сотрудников (Employee[])
statusoptional
array
Статус
Текущий статус сделки (DealStatus)
typeoptional
array
Тип
Тип сделки (DealType)

Параметры запроса

GET_DEALS_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
type_idoptional
string
ID типа
Фильтр по типу сделки
status_idoptional
string
ID статуса
Фильтр по статусу
client_idoptional
string
ID клиента
Фильтр по клиенту
employee_idoptional
string
ID сотрудника
Фильтр по сотруднику
searchoptional
string
Поиск
Поиск по комментарию

Примеры ответов

200
{
    "status": true,
    "message": "Deals retrieved successfully",
    "data": {
        "deals": [
            {
                "id": "k00e8400-e29b-41d4-a716-446655440160",
                "comment": "Срочная продажа",
                "type_id": "i00e8400-e29b-41d4-a716-446655440140",
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z",
                "client_id": "d00e8400-e29b-41d4-a716-446655440090",
                "client": { ... },
                "employees": [],
                "status": {
                    "id": "j00e8400-e29b-41d4-a716-446655440150",
                    "name": "Новый",
                    "color": "#2196F3"
                },
                "type": {
                    "id": "i00e8400-e29b-41d4-a716-446655440140",
                    "name": "Продажа"
                }
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/deals",
        "method": "GET"
    }
}

# Создание сделки

POST
/companies/{id}/modules/dm/deals

Создаёт новую сделку.

Структура запроса

CREATE_REQUEST:
application/json
commentoptional
string
Комментарий
Комментарий к сделке
type_idoptional
string
ID типа
Идентификатор типа сделки

Структура ответа

DEAL:
application/json
idrequired
string
ID
Уникальный идентификатор сделки
commentoptional
string
Комментарий
Комментарий к сделке
type_idoptional
string
ID типа
Идентификатор типа сделки
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)
client_idoptional
string
ID клиента
Идентификатор клиента
clientoptional
array
Клиент
Данные клиента (ClientDetail). Подробнее в статье модуля CRM.
employeesrequired
array
Сотрудники
Список сотрудников (Employee[])
statusoptional
array
Статус
Текущий статус сделки (DealStatus)
typeoptional
array
Тип
Тип сделки (DealType)

Примеры ответов

201
{
    "status": true,
    "message": "Deal created successfully",
    "data": {
        "id": "k00e8400-e29b-41d4-a716-446655440161",
        "comment": null,
        "type_id": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:05:00Z",
        "client_id": null,
        "client": null,
        "employees": [],
        "status": null,
        "type": null
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/deals",
        "method": "POST"
    }
}