Присоединяйтесь!

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

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

Документ используется для создания плановых периодов отпусков сотрудников. Работать с «Графиком отпусков» можно только до запуска его в документооборот. После используйте «Изменение графика отпусков».

Описание полей объекта «Документ» с типом «Согласование».

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

Тип

Описание

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

строка

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

Номер

строка

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

Дата

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

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

Редакция

объект

редакция документа

 

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

строка

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

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

строка

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

Тип*

строка

тип документа. Принимает значение «Согласование»

Регламент*

объект

заполняется по одному из полей — «Название» или «Идентификатор»

 

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

строка

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

Название

строка

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

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

объект

указывает, по какой из наших компаний оформляется график отпусков.

Обязателен, если документ передается по юридической структуре. Не указывать, если по управленческой.

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

 

СвЮЛ

объект

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

 

ИНН*

строка

для юридических лиц номер состоит из 10 символов, для индивидуальных предпринимателей и физических лиц — из 12. Для иностранных организаций номер определяется требованиями законодательства их стран

КПП*

строка

9 символов

КодФилиала

строка

код филиала

КодСтраны

строка

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

Название

строка

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

 

СвФЛ

объект

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

 

ИНН*

строка

12 символов

КодФилиала

строка

код филиала

КодСтраны

строка

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

Фамилия

строка

фамилия

Имя

строка

имя

Отчество

строка

отчество

Автор

объект

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

 

Фамилия

строка

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

Имя

строка

имя автора документа

Отчество

строка

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

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

строка

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

Вложение

объект

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

 

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

строка

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

Название

строка

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

Удален

строка

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

Дата

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

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

Файл

объект

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

 

Имя

строка

имя файла

Ссылка

строка

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

Тип

строка

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

Подразделение

объект

информация о подразделении сотрудника

 

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

строка

код подразделения

Название

строка

название подразделения

Структура

строка

структура подразделения. Возможные значения: «Юридическая», «Управленческая», «Активная»

ДатаНачала

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

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

Примечание

строка

комментарий в документе

ПлановыеОтпуска*

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

каждый элемент массива содержит данные для планирования отпусков по одному сотруднику. Определите сотрудника одним из способов (указаны по убыванию приоритета):

  • «ИдентификаторСотрудника». Используется для идентификации сотрудника по конкретной должности. Идентификатор возвращается в параметре extEmployeeId в результате запроса sabyEmployee.ListPositions;
  • «ВнешнийИдентификатор» (лица) + «ДатаТрудовогоДоговора» (строка «ДД.ММ.ГГГГ») и «НомерТрудовогоДоговора». Идентификация сотрудника по естественным ключам;
  • «ВнешнийИдентификатор» (лица) + «ТабельныйНомер». Способ подходит, если во внешней системе табельные номера уникальны для разных трудовых договоров

 

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

строка

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

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

строка

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

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

строка

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

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

строка

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

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

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

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

Интервалы*

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

каждый элемент массива содержит информацию по одному плановому отпуску сотрудника. Заполните поля:

  • «ДатаНачала» и «ДатаОкончания» — чтобы создать плановый период;
  • «ДатаНачала», «ДатаОкончания», «ДатаНачалаСтарая» и «ДатаОкончанияСтарая» — чтобы изменить плановый период;
  • «ДатаНачалаСтарая» и «ДатаОкончанияСтарая» — чтобы удалить.
 

ДатаНачала*

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

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

ДатаОкончания

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

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

ДатаНачалаСтарая

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

значение «ДатаНачала» до изменения документа

ДатаОкончанияСтарая

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

значение «ДатаОкончания» до изменения документа

Примечание

строка

комментарий к отпуску

Примеры

Создать плановый отпуск

Запросить информацию о графике отпусков

Результат запроса информации о графике отпусков

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.