Отчёты
Методы для генерации отчётов по модулю CRM.
- Для получения коллекции сгенерированных модулем отчётов используйте метод документов компании с фильтрацией по module.
- Для получения бинарного файла отчёта используйте метод объектного хранилища.
# Создание отчёта
POST/companies/{id}/modules/crm/report
Генерирует Excel-отчёт по модулю CRM. Каждая сущность — отдельный лист. В поле types запроса передаётся массив нужных типов. Сгенерированный документ будет доступен в списке документов компании.
Структура запроса
GENERATE_REQUEST:
application/json
typesrequired
array
Типы
Типы отчётов для генерации (string[]: clients, sources)
commentoptional
string
Комментарий
Комментарий к отчёту
Структура ответа
RESPONSE_DATA:
application/json
download_urlrequired
string
Ссылка (deprecated)
Прямая ссылка на скачивание. Устарело — используйте object_path из doc.
docrequired
array
Документ
Сгенерированный документ (Doc)
Документ
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)
Примеры ответов
{
"status": true,
"message": "Report generated successfully",
"data": {
"download_url": "https://cdn.kroncl.com/reports/crm-report-2026-06-14.pdf",
"doc": {
"id": "a20e8400-e29b-41d4-a716-446655440170",
"object_path": "reports/crm-report-2026-06-14.pdf",
"module": "crm",
"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/crm/report",
"method": "POST"
}
}