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

Категории

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

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

GET
/companies/{id}/modules/fm/transactions/categories

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

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

RESPONSE_DATA:
application/json
categoriesrequired
array
Категории
Список категорий (Category[])
paginationrequired
array
pagination

Категория

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
descriptionoptional
string
Описание
Описание категории
directionrequired
enum
incomeexpense
Направление
Направление
systemrequired
boolean
Системная
Системная категория
slugrequired
string
Slug
Уникальный идентификатор
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

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

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

200
{
    "status": true,
    "message": "Categories retrieved successfully",
    "data": {
        "categories": [
            {
                "id": "b00e8400-e29b-41d4-a716-446655440050",
                "name": "Продажи",
                "description": "Доходы от продаж",
                "direction": "income",
                "system": false,
                "slug": "sales",
                "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/transactions/categories",
        "method": "GET"
    }
}

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

POST
/companies/{id}/modules/fm/transactions/categories

Создаёт новую категорию транзакций.

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

CREATE_REQUEST:
application/json
namerequired
string
Название
Название категории
directionrequired
enum
incomeexpense
Направление
Направление
descriptionoptional
string
Описание
Описание категории

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

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
descriptionoptional
string
Описание
Описание категории
directionrequired
enum
incomeexpense
Направление
Направление
systemrequired
boolean
Системная
Системная категория
slugrequired
string
Slug
Уникальный идентификатор
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

201
{
    "status": true,
    "message": "Category created successfully",
    "data": {
        "id": "b00e8400-e29b-41d4-a716-446655440051",
        "name": "Закупки",
        "description": "Расходы на закупки",
        "direction": "expense",
        "system": false,
        "slug": "purchases",
        "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/transactions/categories",
        "method": "POST"
    }
}

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

GET
/companies/{id}/modules/fm/transactions/categories/{categoryId}

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

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

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
descriptionoptional
string
Описание
Описание категории
directionrequired
enum
incomeexpense
Направление
Направление
systemrequired
boolean
Системная
Системная категория
slugrequired
string
Slug
Уникальный идентификатор
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category retrieved successfully",
    "data": {
        "id": "b00e8400-e29b-41d4-a716-446655440050",
        "name": "Продажи",
        "description": "Доходы от продаж",
        "direction": "income",
        "system": false,
        "slug": "sales",
        "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/transactions/categories/...",
        "method": "GET"
    }
}

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

PATCH
/companies/{id}/modules/fm/transactions/categories/{categoryId}

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

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

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название категории
descriptionoptional
string
Описание
Описание категории
directionoptional
enum
incomeexpense
Направление
Направление

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

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
descriptionoptional
string
Описание
Описание категории
directionrequired
enum
incomeexpense
Направление
Направление
systemrequired
boolean
Системная
Системная категория
slugrequired
string
Slug
Уникальный идентификатор
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category updated successfully",
    "data": {
        "id": "b00e8400-e29b-41d4-a716-446655440051",
        "name": "Закупки (обновлено)",
        "description": "Расходы на закупки и материалы",
        "direction": "expense",
        "system": false,
        "slug": "purchases",
        "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/transactions/categories/...",
        "method": "PATCH"
    }
}

# Удаление категории

DELETE
/companies/{id}/modules/fm/transactions/categories/{categoryId}

Удаляет категорию.

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

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

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

200
{
    "status": true,
    "message": "Category deleted successfully",
    "data": {
        "category_id": "b00e8400-e29b-41d4-a716-446655440051",
        "deleted": true
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/fm/transactions/categories/...",
        "method": "DELETE"
    }
}