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

Сделка

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

# Детали сделки

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

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

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

DEAL_WITH_POSITIONS:
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)
positionsrequired
array
Позиции
Список позиций в сделке (DealPosition[])

Позиция сделки

DEAL_POSITION:
application/json
idrequired
string
ID
Идентификатор позиции
namerequired
string
Название
Название позиции
commentoptional
string
Комментарий
Комментарий
pricerequired
int
Цена
Цена за единицу
quantityrequired
int
Количество
Количество
unitrequired
string
Единица
Единица измерения
unit_idoptional
string
ID товарной позиции
Идентификатор товарной позиции из каталога
position_idoptional
string
ID складской позиции
Идентификатор складской позиции
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)
catalog_unitoptional
array
Товарная позиция
Данные товарной позиции из каталога (CatalogUnit). Подробнее в статье модуля WM.
catalog_positionoptional
array
Складская позиция
Данные складской позиции (StockPosition). Подробнее в статье модуля WM.

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

200
{
    "status": true,
    "message": "Deal retrieved successfully",
    "data": {
        "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": "Продажа"
        },
        "positions": [
            {
                "id": "l00e8400-e29b-41d4-a716-446655440170",
                "name": "Ноутбук Dell XPS",
                "comment": "Флагманская модель",
                "price": 150000,
                "quantity": 1,
                "unit": "шт",
                "unit_id": "f00e8400-e29b-41d4-a716-446655440110",
                "position_id": null,
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z",
                "catalog_unit": { ... },
                "catalog_position": null
            }
        ]
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/deals/...",
        "method": "GET"
    }
}

# Обновление сделки

PATCH
/companies/{id}/modules/dm/deals/{dealId}

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

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

UPDATE_REQUEST:
application/json
commentoptional
string
Комментарий
Комментарий к сделке
type_idoptional
string
ID типа
Идентификатор типа сделки
client_idoptional
string
ID клиента
Идентификатор клиента
status_idoptional
string
ID статуса
Идентификатор статуса
employeesoptional
array
Сотрудники
Полная замена списка сотрудников (string[])
positionsoptional
array
Позиции
Список позиций для обновления (UpdateDealPosition[])

Позиция для обновления

UPDATE_DEAL_POSITION:
application/json
idoptional
string
ID
Идентификатор позиции (для обновления существующей)
nameoptional
string
Название
Название позиции
commentoptional
string
Комментарий
Комментарий
priceoptional
int
Цена
Цена за единицу
quantityoptional
int
Количество
Количество
unitoptional
string
Единица
Единица измерения
unit_idoptional
string
ID товарной позиции
Идентификатор товарной позиции из каталога
position_idoptional
string
ID складской позиции
Идентификатор складской позиции
deleteoptional
boolean
Удалить
Если true — удалить позицию

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

DEAL_WITH_POSITIONS:
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)
positionsrequired
array
Позиции
Список позиций в сделке (DealPosition[])

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

200
{
    "status": true,
    "message": "Deal updated successfully",
    "data": {
        "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:10: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": "Продажа"
        },
        "positions": []
    },
    "meta": {
        "timestamp": "2026-06-14T12:10:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/dm/deals/...",
        "method": "PATCH"
    }
}

# Удаление сделки

DELETE
/companies/{id}/modules/dm/deals/{dealId}

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

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

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

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

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

# Накладная

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

Генерирует накладную по сделке.

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

INVOICE_REQUEST:
application/json
legal_nameoptional
string
Юр. название
Юридическое название компании
innoptional
string
ИНН
ИНН компании
ogrnoptional
string
ОГРН
ОГРН компании
bank_nameoptional
string
Банк
Название банка
warranty_termsoptional
string
Гарантия
Условия гарантии
additional_termsoptional
string
Доп. условия
Дополнительные условия
positionsrequired
array
Позиции
Список позиций для накладной (InvoicePosition[])
total_amountrequired
int
Итого
Общая сумма
commentoptional
string
Комментарий
Комментарий

Позиция накладной

INVOICE_POSITION:
application/json
namerequired
string
Название
Название позиции
quantityrequired
int
Количество
Количество
pricerequired
int
Цена
Цена за единицу

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

INVOICE_RESPONSE:
application/json
download_urlrequired
string
Ссылка (deprecated)
Прямая ссылка на скачивание. Устарело — используйте object_path из doc.
docrequired
array
Документ
Сгенерированный документ (Doc)

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

200
{
    "status": true,
    "message": "Invoice generated successfully",
    "data": {
        "download_url": "https://cdn.kroncl.com/invoices/invoice-2026-06-14.pdf",
        "doc": {
            "id": "m00e8400-e29b-41d4-a716-446655440180",
            "object_path": "invoices/invoice-2026-06-14.pdf",
            "module": "dm",
            "type": "invoice",
            "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/deals/.../invoice",
        "method": "POST"
    }
}