Структура документа «Инструкция» в API

Параметр
* — обязательный

Тип

Описание

Идентификатор

строка
UUID

уникальный идентификатор документа, используется для обращения к документу

Дата

строка
«ДД.ММ.ГГГГ»

дата документа

Тип*

строка
UUID

тип документа. Принимает значение «InstructionDoc»

НашаОрганизация*

объект

указывает, для какой из наших компаний создается инструкция. Можно передавать только реквизиты головного офиса. В зависимости от формы организации заполняется только один из информационных блоков

СвЮЛ

объект

сведения о юридическом лице

ИНН*

строка

для компаний в РФ — 10 символов. Для иностранных организаций количество символов может отличаться в зависимости от требований законодательства их стран

КПП*

строка

9 символов

КодФилиала

строка

код филиала

КодСтраны

строка

код страны в формате ISO 3166-1 Numeric

Название

строка

название организации

СвФЛ

объект

сведения о физическом лице

ИНН*

строка

для компаний в РФ — 12 символов. Для иностранных организаций количество символов может отличаться в зависимости от требований законодательства их стран

КодФилиала

строка

код филиала

КодСтраны

строка

код страны в формате ISO 3166-1 Numeric

Фамилия

строка

фамилия

Имя

строка

имя

Отчество

строка

отчество

Вложение

объект

файл вложения

Идентификатор

строка

используется для адресации вложения

Название

строка

название вложения

Удален

строка

признак удаления вложения. Возможные значения — «Да» и «Нет»

Файл

объект

вложение документа

Имя

строка

имя файла

ДвоичныеДанные

строка

ссылка на объект в файловом хранилище

Расширение

объект

дополнительные сведения о документе

Инструкция

объект

сведения об инструкции

Сведения

объект

информация о файле инструкции. Обязательно заполняется при загрузке новой инструкции

Путь

строка

каталог, в котором располагается инструкция в хранилище. Вложенность передается через разделитель «\». Например, «Кадровые документы\Приказы»

Название

строка

имя файла инструкции. Указывается, если надо переименовать уже загруженный файл

ПолноеНазвание

строка

полное название инструкции

Файл

объект

файл редакции. Чтобы создать новую редакцию, снимите старую с публикации, затем загрузите новую через API

Путь

строка

путь к файлу, который был загружен на диск

Идентификатор

строка

идентификатор файла, который был загружен на диск. Значение возвращается в поле fileid в результате записи файла на диск

Версия

строка

версия файла, который был загружен на диск. Значение возвращается в поле versionid в результате записи файла на диск

ТребуетсяПодпись

число

признак, требуется ли подпись от получателя инструкции. Возможные значения: «0» — требуется, «1» — не требуется. По умолчанию «0»

СрокОзнакомления

число

количество дней для ознакомления с инструкцией. По умолчанию «0» — срок не ограничен

Опубликована

число

признак, что инструкция опубликована. Возможные значения: «0» — не опубликована, «1» — опубликована. По умолчанию «0»

Скачивание

число

разрешение на скачивание инструкций. Возможные значения: «0» — запрещено, «1» — разрешено. По умолчанию «1»

ЗапретНаПросмотр

число

запрет на просмотр инструкции после ознакомления. Возможные значения:

• «-1» — не запрещать;
• «0» — запретить сразу после ознакомления;
• <значение> — запретить спустя указанное количество дней после ознакомления.

По умолчанию «-1»

Получатели

объект

сведения о получателях инструкции

Включить

массив объектов

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

Сотрудник

строка

идентификатор физического лица сотрудника

Исключить

массив объектов

список сотрудников, которых надо исключить из списка на ознакомление

Сотрудник

строка

внешний идентификатор сотрудника

Тип

число

тип удаления. Возможные значения: «0» — переместить в архив, «1» — навсегда удалить из списка. История ознакомлений не сохраняется