> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Документы

> Справочник полей документа, прикреплённых файлов и фильтра списка документов.

Справочник к странице [«Документы: карточки, файлы и статусы»](/ru/logic/documents/crud).

## Документ

*Основная сущность документооборота: одна карточка документа (договор, акт и т.п.), сгенерированного из шаблона или загруженного вручную. Связывается с произвольным бизнес-объектом (например, заявкой на аренду) через тип и идентификатор связанного объекта.*

**Идентификация**

| Поле                         | Тип   | Описание                                                                        |
| ---------------------------- | ----- | ------------------------------------------------------------------------------- |
| UUID документа               | текст | Публичный идентификатор, используется во внешних/подписных ссылках              |
| Компания-арендодатель        | связь | Компания, которой принадлежит документ                                          |
| Порядковый номер             | число | Сквозной номер в рамках компании и шаблона, выдаётся автосчётчиком              |
| Название документа           | текст | —                                                                               |
| Ссылка на документ-основание | связь | На другой документ (например, прежнюю версию); в реальной логике не заполняется |

**Содержимое**

| Поле             | Тип          | Описание                                                                                     |
| ---------------- | ------------ | -------------------------------------------------------------------------------------------- |
| Источник         | список       | Сгенерирован / Загружен                                                                      |
| Формат документа | список       | HTML / PDF / DOCX / DOC                                                                      |
| Содержимое       | текст (HTML) | Только для сгенерированных документов; у загруженных — пусто, файл лежит в «Файле документа» |
| Шаблон           | связь        | Пусто для загруженных документов                                                             |
| Создатель        | число        | ID пользователя, без прямой связи                                                            |
| Доп. данные      | JSON         | Произвольные служебные данные                                                                |

**Связь с объектом и подписание**

| Поле                            | Тип                | Описание                                                                                        |
| ------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------- |
| Тип связанного объекта          | текст              | Копируется из шаблона                                                                           |
| ID связанного объекта           | число              | Например, ID заявки на аренду                                                                   |
| Подписан                        | флаг (вычисляемый) | Включается, когда все подписи документа получили статус «Подписан» и подписантов не меньше двух |
| Дата создания / Дата обновления | дата/время         | —                                                                                               |

## Файл документа

*Физический файл, прикреплённый к документу: оригинал, служебный слой для подписи или итоговый подписанный файл. У одного документа не может быть двух файлов одного типа.*

| Поле                            | Тип        | Описание                            |
| ------------------------------- | ---------- | ----------------------------------- |
| Документ                        | связь      | Документ, которому принадлежит файл |
| Тип файла                       | список     | См. «Тип файла документа» ниже      |
| Файл                            | файл       | Хранится в облачном хранилище       |
| Доп. данные                     | JSON       | Произвольные служебные данные       |
| Дата создания / Дата обновления | дата/время | —                                   |

## Фильтр списка документов

*Набор параметров фильтрации в списке документов. Часть фильтров работает через существование связанной подписи, а не через поля самого документа.*

ID документа, тип и ID связанного объекта, шаблон, формат документа, источник, создатель, дата создания (диапазон), «Подписан», статус подписи, «Активные» (есть хотя бы одна подпись) — а также способ подписания, подписант (по внешнему ID) и тип подписанта, которые фильтруют документы через связанные подписи.

## Статусы и справочники

### Источник документа

*Каким образом появился документ; влияет на то, какие поля документа разрешено редактировать.*

* Сгенерирован
* Загружен

### Тип (формат) документа

*Формат содержимого документа.*

* HTML
* PDF
* DOCX
* DOC

### Тип файла документа

*Роль конкретного физического файла, прикреплённого к документу.*

* Оригинал — исходный файл (сгенерированный или загруженный)
* Слой для подписи — служебный слой с местами для подписи/печатей поверх оригинала
* Файл с ЭЦП — итоговый файл, подписанный через ЭЦП/ЕГОВ
* Подписанный файл — итоговый файл после ручного/визуального подписания