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

Контрагенты

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

# Список контрагентов

GET
/companies/{id}/modules/fm/counterparties

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

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

RESPONSE_DATA:
application/json
counterpartiesrequired
array
Контрагенты
Список контрагентов (Counterparty[])
paginationrequired
array
pagination

Контрагент

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

GET_COUNTERPARTIES_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
typeoptional
enum
bankorganizationperson
Тип
Фильтр по типу
statusoptional
enum
activeinactive
Статус
Фильтр по статусу
searchoptional
string
Поиск
Поиск по названию

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

200
{
    "status": true,
    "message": "Counterparties retrieved successfully",
    "data": {
        "counterparties": [
            {
                "id": "c00e8400-e29b-41d4-a716-446655440060",
                "name": "ООО Ромашка",
                "comment": "Поставщик",
                "type": "organization",
                "status": "active",
                "metadata": null,
                "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/fm/counterparties",
        "method": "GET"
    }
}

# Создание контрагента

POST
/companies/{id}/modules/fm/counterparties

Создаёт нового контрагента.

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

CREATE_REQUEST:
application/json
namerequired
string
Название
Название контрагента
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
commentoptional
string
Комментарий
Комментарий
statusoptional
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные

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

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

201
{
    "status": true,
    "message": "Counterparty created successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440061",
        "name": "ИП Иванов",
        "comment": null,
        "type": "person",
        "status": "active",
        "metadata": 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/fm/counterparties",
        "method": "POST"
    }
}

# Получение контрагента

GET
/companies/{id}/modules/fm/counterparties/{counterpartyId}

Возвращает информацию о контрагенте.

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

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Counterparty retrieved successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440060",
        "name": "ООО Ромашка",
        "comment": "Поставщик",
        "type": "organization",
        "status": "active",
        "metadata": null,
        "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/fm/counterparties/...",
        "method": "GET"
    }
}

# Обновление контрагента

PATCH
/companies/{id}/modules/fm/counterparties/{counterpartyId}

Обновляет данные контрагента.

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

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typeoptional
enum
bankorganizationperson
Тип
Тип контрагента
metadataoptional
array
Метаданные
Дополнительные данные

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

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Counterparty updated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440061",
        "name": "ИП Иванов (обновлено)",
        "comment": "Поставщик материалов",
        "type": "person",
        "status": "active",
        "metadata": null,
        "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/fm/counterparties/...",
        "method": "PATCH"
    }
}

# Деактивация контрагента

POST
/companies/{id}/modules/fm/counterparties/{counterpartyId}/deactivate

Деактивирует контрагента.

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

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Counterparty deactivated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440061",
        "name": "ИП Иванов (обновлено)",
        "comment": "Поставщик материалов",
        "type": "person",
        "status": "inactive",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:15:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/fm/counterparties/.../deactivate",
        "method": "POST"
    }
}

# Активация контрагента

POST
/companies/{id}/modules/fm/counterparties/{counterpartyId}/activate

Активирует деактивированного контрагента.

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

COUNTERPARTY:
application/json
idrequired
string
ID
Уникальный идентификатор контрагента
namerequired
string
Название
Название контрагента
commentoptional
string
Комментарий
Комментарий
typerequired
enum
bankorganizationperson
Тип
Тип контрагента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Counterparty activated successfully",
    "data": {
        "id": "c00e8400-e29b-41d4-a716-446655440061",
        "name": "ИП Иванов (обновлено)",
        "comment": "Поставщик материалов",
        "type": "person",
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:20:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:20:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/fm/counterparties/.../activate",
        "method": "POST"
    }
}