API: документооборот — API

Главная / Документация / APIAPI: документооборотДокументооборот: полный перечень из 39 методов с параметрами и схемами тел.Обновлено 24.06.2026Пути - без префикса `/api/v1`. Детальные схемы - в `/api/docs`. Где право не указано - доступ по сессии и роли согласно ролевой модели; пометка о причастности означает проверку доступа внутри обработчика.Входящая корреспонденция (`/incoming-letters`)

Метод

Путь

Право

GET

`/incoming-letters`

сессия

POST

`/incoming-letters`

`incoming_letters.register`

GET

`/incoming-letters/{letter_id}`

сессия

PUT

`/incoming-letters/{letter_id}`

`incoming_letters.update`

POST

`/incoming-letters/{letter_id}/projects`

`incoming_letters.link_project`

POST

`/incoming-letters/{letter_id}/tasks`

`incoming_letters.link_project`

POST

`/incoming-letters/{letter_id}/take`

исполнитель

POST

`/incoming-letters/{letter_id}/submit-control`

исполнитель

POST

`/incoming-letters/{letter_id}/close`

по доступу

POST

`/incoming-letters/{letter_id}/return-to-work`

по доступу

Статусы: `registered`, `in_progress`, `on_control`, `done`. Номер: `ВХ-ГГГГ-NNN`.Исходящая корреспонденция (`/outgoing-letters`)

Метод

Путь

Право

GET

`/outgoing-letters`

сессия

POST

`/outgoing-letters`

`outgoing_letters.create`

GET

`/outgoing-letters/{letter_id}`

сессия

PUT

`/outgoing-letters/{letter_id}`

по доступу

POST

`/outgoing-letters/{letter_id}/mark-sent`

`outgoing_letters.mark_sent`

DELETE

`/outgoing-letters/{letter_id}/attachments/{attachment_id}`

по доступу

Статусы: `draft`, `on_approval`, `on_signing`, `approved`, `sent`, `returned`, `revoked`. Номер: `ИСХ-ГГГГ-NNN`.Поручения (`/orders`)

Метод

Путь

Право

GET

`/orders`

сессия

POST

`/orders`

`orders.create`

GET

`/orders/{order_id}`

сессия

PUT

`/orders/{order_id}`

`orders.update`

POST

`/orders/{order_id}/report`

исполнитель

POST

`/orders/{order_id}/accept`

постановщик

POST

`/orders/{order_id}/return`

постановщик

PUT

`/orders/{order_id}/responsible`

по доступу

Статусы: `new`, `in_progress`, `on_review`, `completed`, `overdue`, `returned`.Документы (`/documents`)

Метод

Путь

Доступ

GET

`/documents`

сессия

GET

`/documents/{document_id}`

сессия

POST

`/documents`

любой пользователь (создание)

PATCH

`/documents/{document_id}`

автор или администратор

POST

`/documents/{document_id}/attachments`

автор или администратор (только PDF/DOCX)

DELETE

`/documents/{document_id}`

автор или администратор

POST

`/documents/{document_id}/printform?template_id=...`

автор или администратор

Статусы: `draft`, `on_approval`, `approved`, `archived`. Согласование - через `/approval-requests` (тип цели `custom_document`).Типы документов (`/document-types`)

Метод

Путь

Доступ

GET

`/document-types`

сессия (`only_active`)

GET

`/document-types/{type_id}`

сессия

POST

`/document-types`

роль `admin_system`

PATCH

`/document-types/{type_id}`

роль `admin_system`

DELETE

`/document-types/{type_id}`

роль `admin_system` (блок при наличии документов)

GET

`/document-types/{type_id}/templates`

сессия

Управление шаблонами (POST/PATCH/DELETE `.../templates[/{id}]`) - роль `admin_system`. Подробно - `cat-document-types`.Почтовый ящик (`/mailbox`)

Метод

Путь

Назначение

GET/PUT

`/mailbox/settings`

Настройки IMAP

POST

`/mailbox/test-connection`

Проверка соединения

POST

`/mailbox/fetch`

Ручная загрузка писем

GET

`/mailbox/messages`

Список писем

GET

`/mailbox/messages/{message_id}`

Письмо

PATCH

`/mailbox/messages/{message_id}/assign`

Назначить исполнителя

PATCH

`/mailbox/messages/{message_id}/status`

Сменить статус

POST

`/mailbox/messages/{message_id}/convert`

Конвертировать во входящее

Доступ - роль `admin_system` или `office`. Статусы письма: `new`, `in_progress`, `converted`, `archived`.Письма-уведомления (`/emails`)

Метод

Путь

Назначение

GET

`/emails`

Список

GET

`/emails/{email_id}`

Письмо

POST

`/emails`

Создать

PUT

`/emails/{email_id}`

Изменить

POST

`/emails/{email_id}/send`

Отправить

DELETE

`/emails/{email_id}`

Удалить

Комментарии и вложенияКомментарии и вложения для писем и документов используют общий механизм `/{target_type}/{target_id}/comments` и `/attachments` - см. `dev-api-tasks`, раздел "Комментарии и вложения".См. также: `guide-incoming`, `guide-outgoing`, `guide-orders`, `guide-documents`, `guide-mail`, `dev-api-approvals`.Документация соответствует версии продукта 0.9.0. Дата проверки: 2026-06-23.

Интеграции и REST API

Функциональная карта