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

Документы компании

Документы компании — все сгенерированные модулями файлы: отчёты, накладные и прочее. Для получения бинарных файлов используйте метод объектного хранилища.

# Получение документов

GET
/companies/{id}/modules/docs

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

Query-параметры

QUERY_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы
limitoptional
int
Лимит
Записей на странице
moduleoptional
string
Модуль
Фильтр по модулю (fm, crm, hrm, wm, dm)
typeoptional
string
Тип
Фильтр по типу документа
searchoptional
string
Поиск
Поиск по документам

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

RESPONSE_DATA:
application/json
docsrequired
array
Документы
Список документов (Doc[])
paginationrequired
array
pagination

Документ

DOC:
application/json
idrequired
string
ID
Уникальный идентификатор документа
object_pathrequired
string
Путь
Путь к файлу в объектном хранилище
moduleoptional
string
Модуль
Модуль, сгенерировавший документ (fm, crm, hrm, wm, dm)
typeoptional
string
Тип
Тип документа (report, invoice и др.)
commentoptional
string
Комментарий
Комментарий, указанный при генерации
created_atrequired
string
Создан
Дата генерации (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Docs retrieved successfully",
    "data": {
        "docs": [
            {
                "id": "bb0e8400-e29b-41d4-a716-446655440100",
                "object_path": "reports/fm-report-2026-06-14.pdf",
                "module": "fm",
                "type": "report",
                "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/docs",
        "method": "GET"
    }
}

# Получение документа

GET
/companies/{id}/modules/docs/{docId}

Возвращает метаданные одного документа. Для скачивания файла используйте путь из поля object_path через методы объектного хранилища.

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

DOC:
application/json
idrequired
string
ID
Уникальный идентификатор документа
object_pathrequired
string
Путь
Путь к файлу в объектном хранилище
moduleoptional
string
Модуль
Модуль, сгенерировавший документ (fm, crm, hrm, wm, dm)
typeoptional
string
Тип
Тип документа (report, invoice и др.)
commentoptional
string
Комментарий
Комментарий, указанный при генерации
created_atrequired
string
Создан
Дата генерации (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Doc retrieved successfully",
    "data": {
        "id": "bb0e8400-e29b-41d4-a716-446655440100",
        "object_path": "reports/fm-report-2026-06-14.pdf",
        "module": "fm",
        "type": "report",
        "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/docs/...",
        "method": "GET"
    }
}

# Настройки документов

GET
/companies/{id}/modules/docs/settings

Возвращает текущие настройки для генерации документов: реквизиты, банковские данные, гарантийные условия.

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

DOCS_SETTINGS:
application/json
legal_nameoptional
string
Юр. наименование
Юридическое наименование организации
legal_addressoptional
string
Юр. адрес
Юридический адрес
innoptional
string
ИНН
ИНН организации
ogrnoptional
string
ОГРН
ОГРН / ОГРНИП
bank_nameoptional
string
Банк
Наименование банка
bank_bicoptional
string
БИК
БИК банка
bank_accountoptional
string
Р/с
Расчётный счёт
director_nameoptional
string
Директор
ФИО руководителя
accountant_nameoptional
string
Бухгалтер
ФИО главного бухгалтера
warranty_termsoptional
string
Гарантии
Гарантийные условия
additional_termsoptional
string
Доп. условия
Дополнительные условия продажи
created_atrequired
string
Созданы
Дата создания настроек (RFC 3339)
updated_atrequired
string
Обновлены
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Settings retrieved successfully",
    "data": {
        "legal_name": "ООО Автосервис на Пушкина",
        "legal_address": "г. Москва, ул. Пушкина, д. 1",
        "inn": "7700000000",
        "ogrn": "1234567890123",
        "bank_name": "Сбербанк",
        "bank_bic": "044525225",
        "bank_account": "40702810000000000000",
        "director_name": "Иванов Иван Иванович",
        "accountant_name": null,
        "warranty_terms": "30 дней с момента ремонта",
        "additional_terms": null,
        "created_at": "2026-04-24T00:20:54Z",
        "updated_at": "2026-06-14T00:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/docs/settings",
        "method": "GET"
    }
}

# Обновить настройки

PATCH
/companies/{id}/modules/docs/settings

Обновляет настройки документов. Все поля опциональны — передавайте только те, которые нужно изменить.

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

UPDATE_REQUEST:
application/json
legal_nameoptional
string
Юр. наименование
Новое юридическое наименование
legal_addressoptional
string
Юр. адрес
Новый юридический адрес
innoptional
string
ИНН
Новый ИНН
ogrnoptional
string
ОГРН
Новый ОГРН
bank_nameoptional
string
Банк
Новое наименование банка
bank_bicoptional
string
БИК
Новый БИК
bank_accountoptional
string
Р/с
Новый расчётный счёт
director_nameoptional
string
Директор
Новый руководитель
accountant_nameoptional
string
Бухгалтер
Новый бухгалтер
warranty_termsoptional
string
Гарантии
Новые гарантийные условия
additional_termsoptional
string
Доп. условия
Новые дополнительные условия

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

DOCS_SETTINGS:
application/json
legal_nameoptional
string
Юр. наименование
Юридическое наименование организации
legal_addressoptional
string
Юр. адрес
Юридический адрес
innoptional
string
ИНН
ИНН организации
ogrnoptional
string
ОГРН
ОГРН / ОГРНИП
bank_nameoptional
string
Банк
Наименование банка
bank_bicoptional
string
БИК
БИК банка
bank_accountoptional
string
Р/с
Расчётный счёт
director_nameoptional
string
Директор
ФИО руководителя
accountant_nameoptional
string
Бухгалтер
ФИО главного бухгалтера
warranty_termsoptional
string
Гарантии
Гарантийные условия
additional_termsoptional
string
Доп. условия
Дополнительные условия продажи
created_atrequired
string
Созданы
Дата создания настроек (RFC 3339)
updated_atrequired
string
Обновлены
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Settings updated successfully",
    "data": {
        "legal_name": "ООО Автосервис на Пушкина",
        "legal_address": "г. Москва, ул. Пушкина, д. 1",
        "inn": "7700000000",
        "ogrn": "1234567890123",
        "bank_name": "Сбербанк",
        "bank_bic": "044525225",
        "bank_account": "40702810000000000000",
        "director_name": "Петров Пётр Петрович",
        "accountant_name": null,
        "warranty_terms": "60 дней с момента ремонта",
        "additional_terms": null,
        "created_at": "2026-04-24T00:20:54Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/docs/settings",
        "method": "PATCH"
    }
}