Структура документа «Отпуск» в API

Параметр
* — обязательный
** — условно-обязательный
синий — только для чтения

Тип

Описание

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

строка

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

Номер

строка

номер документа. Если номер документа не указан, значение генерируется автоматически

Дата

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

дата документа. Если дата документа не указана, ставится текущая дата

Редакция

объект

данные о редакции отпуска

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

строка

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

ПримечаниеИС

строка

текстовое примечание для изменяемой редакции

Тип*

строка

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

Регламент

объект

регламент документа. Чтобы привязать регламент, заполните одно из полей — «Название» или «Идентификатор»

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

строка

идентификатор регламента документооборота в Saby. Чтобы его получить, создайте документ в Saby и вызовите для него «СБИС.ПрочитатьДокумент»

Название

строка

название регламента документооборота в Saby. Если передан идентификатор, название не учитывается

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

объект

указывает, по какой из наших компаний формируется отпуск. Допускается передавать только реквизиты головной организации. В зависимости от формы организации заполняется только один из информационных блоков — СвЮЛ или СвФЛ

СвЮЛ

объект

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

ИНН*

строка

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

КПП*

строка

КПП организации, 9 символов

КодФилиала

строка

код филиала

КодСтраны

строка

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

Название

строка

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

СвФЛ

объект

сведения об индивидуальном предпринимателе

ИНН*

строка

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

КодФилиала

строка

код филиала

КодСтраны

строка

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

Фамилия

строка

фамилия

Имя

строка

имя

Отчество

строка

отчество

Автор

объект

автор документа. Если задан идентификатор, сотрудник ищется по нему, иначе по ФИО

Фамилия

строка

фамилия автора

Имя

строка

имя автора

Отчество

строка

отчество автора

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

строка

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

Вложение

массив

сведения о приложенных документах

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

строка

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

Название

строка

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

Удален

строка

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

Дата

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

дата загрузки

Файл

объект

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

Имя

строка

имя файла

Ссылка

строка

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

Тип

строка

тип вложения

ВидОтпуска*

строка

вид отпуска. Возможные значения

ДатаСобытия**

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

дата события, для которого создается отпуск. Например, дата рождения ребенка. Заполняется, если в параметре «ВидОтпуска» передано название отпуска по коллективному договору и в документе отпуска в Saby указана дата в поле «событие»

Сумма**

строка

сумма отпускных для отпуска с учетом и оплачиваемого отпуска

ПоПлану

строка

если отпуск плановый, передайте «Да», вне плана — «Нет»

СУчетом

строка

если отпуск с учетом других отпускных периодов, передайте «Да», без учета — «Нет»

Сотрудник*

объект

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

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

строка

идентификатор конкретной должности сотрудника

ВнешнийИдентификатор

строка

идентификатор сотрудника во внешней системе. Поле «ИдентификаторИС» метода «СБИС.ЗаписатьСотрудника»

Фамилия

строка

фамилия сотрудника

Имя

строка

имя сотрудника

Отчество

строка

отчество сотрудника

ДатаТрудовогоДоговора

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

дата трудового договора

НомерТрудовогоДоговора

строка

номер трудового договора

ТабельныйНомер

строка

табельный номер сотрудника

Интервал*

объект

данные о начале и окончании отпуска

ДатаНачала

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

дата начала отпуска

ДатаКонца

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

дата окончания отпуска

Дни

строка

количество дней отпуска

Оплачиваемый

строка

признак необходимости оплаты. Возможные значения: «Да», «Нет». Используется для отпуска по гособязанностям и учебного. Значение по умолчанию — «Да»

Детализация*

массив

детализация данных по должности и рабочему периоду. Можно передать информацию только по одной должности

Интервал

объект

данные о начале и окончании отпуска для конкретной должности

ДатаНачала

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

дата начала отпуска

ДатаКонца

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

дата окончания отпуска

Дни

строка

количество дней отпуска

ДолжностьСотрудника**

объект

указывает, по какой должности оформляется отпуск. Обязателен, если предается параметр «Детализация»

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

строка

идентификатор конкретной должности сотрудника

Название

строка

название должности. Используется для поиска, если не указан идентификатор

ДатаТрудовогоДоговора

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

дата трудового договора

НомерТрудовогоДоговора

строка

номер трудового договора

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

строка

идентификатор конкретной должности сотрудника

ТипПредоставления

строка

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

Для основной должности значение параметра всегда будет «Оплатить»

СпособРасчета

строка

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

• «Основной и доп. дни»;
• «Только основной»;
• «Только доп. дни»

ПоРабочимПериодамNew

массив

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

ПериодНачало

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

дата начала рабочего периода

ПериодКонец

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

дата окончания рабочего периода

Расшифровка

объект

информация о конкретном рабочем периоде и количестве дней отпуска

ДатаНачала

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

дата начала отпуска в рабочем периоде

ДатаКонца

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

дата окончания отпуска в рабочем периоде

Дни

строка

количество дней отпуска за рабочий период

ОсновныеДни

строка

количество дней основного отпуска

ДетализацияДопДней

массив

данные о дополнительных днях отпуска, которые положены сотруднику

ПричинаПредоставления

строка

причина предоставления дополнительного отпуска. Возможные значения

ДопДни

строка

количество дополнительных дней отпуска

ДатаНачала

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

дата начала отпуска в рабочем периоде

ДатаКонца

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

дата окончания отпуска в рабочем периоде

Расчеты

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

детализация расчетов по рабочим периодам

ДатаНачала

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

дата начала расчетов

ДатаКонца

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

дата окончания расчетов

Сумма

строка

сумма отпускных за период

ПричинаОтзыва

строка

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

РасшифровкаПричины

строка

примечание к отзыву

ИдДокументаОснования

строка
UUID

идентификатор отпуска