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

Статусы сделок

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

# Список статусов

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

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

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

RESPONSE_DATA:
application/json
statusesrequired
array
Статусы
Список статусов сделок (DealStatus[])
paginationrequired
array
pagination

Статус

DEAL_STATUS:
application/json
idrequired
string
ID
Уникальный идентификатор статуса
namerequired
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderrequired
int
Порядок
Порядок сортировки
is_defaultrequired
boolean
По умолчанию
Статус по умолчанию
coloroptional
string
Цвет
Цвет статуса (HEX)
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

GET_DEAL_STATUSES_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
searchoptional
string
Поиск
Поиск по названию

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

200
{
    "status": true,
    "message": "Deal statuses retrieved successfully",
    "data": {
        "statuses": [
            {
                "id": "j00e8400-e29b-41d4-a716-446655440150",
                "name": "Новый",
                "comment": "Начальный статус",
                "sort_order": 1,
                "is_default": true,
                "color": "#2196F3",
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses",
        "method": "GET"
    }
}

# Создание статуса

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

Создаёт новый статус сделки.

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

CREATE_REQUEST:
application/json
namerequired
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderrequired
int
Порядок
Порядок сортировки
coloroptional
string
Цвет
Цвет статуса (HEX)
is_defaultoptional
boolean
По умолчанию
Статус по умолчанию

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

DEAL_STATUS:
application/json
idrequired
string
ID
Уникальный идентификатор статуса
namerequired
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderrequired
int
Порядок
Порядок сортировки
is_defaultrequired
boolean
По умолчанию
Статус по умолчанию
coloroptional
string
Цвет
Цвет статуса (HEX)
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

201
{
    "status": true,
    "message": "Deal status created successfully",
    "data": {
        "id": "j00e8400-e29b-41d4-a716-446655440151",
        "name": "В работе",
        "comment": null,
        "sort_order": 2,
        "is_default": false,
        "color": "#FF9800",
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:05:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses",
        "method": "POST"
    }
}

# Пересортировка статусов

PUT
/companies/{id}/modules/dm/statuses/reorder

Изменяет порядок сортировки статусов.

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

REORDER_REQUEST:
application/json
status_idsrequired
array
ID статусов
Массив ID статусов в новом порядке

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

REORDER_RESPONSE:
application/json
reorderedrequired
boolean
Пересортировано
Статус операции
status_idsrequired
array
ID статусов
Массив ID статусов в новом порядке

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

200
{
    "status": true,
    "message": "Deal statuses reordered successfully",
    "data": {
        "reordered": true,
        "status_ids": [
            "j00e8400-e29b-41d4-a716-446655440150",
            "j00e8400-e29b-41d4-a716-446655440151"
        ]
    },
    "meta": {
        "timestamp": "2026-06-14T12:20:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses/reorder",
        "method": "PUT"
    }
}

# Получение статуса

GET
/companies/{id}/modules/dm/statuses/{statusId}

Возвращает информацию о статусе сделки.

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

DEAL_STATUS:
application/json
idrequired
string
ID
Уникальный идентификатор статуса
namerequired
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderrequired
int
Порядок
Порядок сортировки
is_defaultrequired
boolean
По умолчанию
Статус по умолчанию
coloroptional
string
Цвет
Цвет статуса (HEX)
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Deal status retrieved successfully",
    "data": {
        "id": "j00e8400-e29b-41d4-a716-446655440150",
        "name": "Новый",
        "comment": "Начальный статус",
        "sort_order": 1,
        "is_default": true,
        "color": "#2196F3",
        "created_at": "2026-06-14T12:00:00Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses/...",
        "method": "GET"
    }
}

# Обновление статуса

PATCH
/companies/{id}/modules/dm/statuses/{statusId}

Обновляет данные статуса сделки.

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

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderoptional
int
Порядок
Порядок сортировки
coloroptional
string
Цвет
Цвет статуса (HEX)
is_defaultoptional
boolean
По умолчанию
Статус по умолчанию

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

DEAL_STATUS:
application/json
idrequired
string
ID
Уникальный идентификатор статуса
namerequired
string
Название
Название статуса
commentoptional
string
Комментарий
Комментарий
sort_orderrequired
int
Порядок
Порядок сортировки
is_defaultrequired
boolean
По умолчанию
Статус по умолчанию
coloroptional
string
Цвет
Цвет статуса (HEX)
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Deal status updated successfully",
    "data": {
        "id": "j00e8400-e29b-41d4-a716-446655440151",
        "name": "В работе (обновлено)",
        "comment": "Активная работа над сделкой",
        "sort_order": 2,
        "is_default": false,
        "color": "#FF9800",
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:10:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:10:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses/...",
        "method": "PATCH"
    }
}

# Удаление статуса

DELETE
/companies/{id}/modules/dm/statuses/{statusId}

Удаляет статус сделки.

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

RESPONSE_DELETE:
application/json
status_idrequired
string
ID статуса
ID удалённого статуса
deletedrequired
boolean
Удалён
Статус удаления

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

200
{
    "status": true,
    "message": "Deal status deleted successfully",
    "data": {
        "status_id": "j00e8400-e29b-41d4-a716-446655440151",
        "deleted": true
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/statuses/...",
        "method": "DELETE"
    }
}