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

Типы сделок

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

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

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

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

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

RESPONSE_DATA:
application/json
deal_typesrequired
array
Типы
Список типов сделок (DealType[])
paginationrequired
array
pagination

Тип сделки

DEAL_TYPE:
application/json
idrequired
string
ID
Уникальный идентификатор типа
namerequired
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

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

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

200
{
    "status": true,
    "message": "Deal types retrieved successfully",
    "data": {
        "deal_types": [
            {
                "id": "i00e8400-e29b-41d4-a716-446655440140",
                "name": "Продажа",
                "comment": "Стандартная продажа",
                "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/types",
        "method": "GET"
    }
}

# Создание типа

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

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

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

CREATE_REQUEST:
application/json
namerequired
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий

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

DEAL_TYPE:
application/json
idrequired
string
ID
Уникальный идентификатор типа
namerequired
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

201
{
    "status": true,
    "message": "Deal type created successfully",
    "data": {
        "id": "i00e8400-e29b-41d4-a716-446655440141",
        "name": "Закупка",
        "comment": null,
        "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/types",
        "method": "POST"
    }
}

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

GET
/companies/{id}/modules/dm/types/{typeId}

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

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

DEAL_TYPE:
application/json
idrequired
string
ID
Уникальный идентификатор типа
namerequired
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Deal type retrieved successfully",
    "data": {
        "id": "i00e8400-e29b-41d4-a716-446655440140",
        "name": "Продажа",
        "comment": "Стандартная продажа",
        "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/types/...",
        "method": "GET"
    }
}

# Обновление типа

PATCH
/companies/{id}/modules/dm/types/{typeId}

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

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

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий

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

DEAL_TYPE:
application/json
idrequired
string
ID
Уникальный идентификатор типа
namerequired
string
Название
Название типа сделки
commentoptional
string
Комментарий
Комментарий
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Deal type updated successfully",
    "data": {
        "id": "i00e8400-e29b-41d4-a716-446655440141",
        "name": "Закупка (обновлено)",
        "comment": "Закупка у поставщиков",
        "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/types/...",
        "method": "PATCH"
    }
}

# Удаление типа

DELETE
/companies/{id}/modules/dm/types/{typeId}

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

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

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

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

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