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

Структура документа «Прочий кадровый» в API

Структура документа «Прочий кадровый» в API

С помощью API в Saby можно создавать документ «Прочий кадровый» с мероприятиями ЕФС или без них. Создание мероприятий зависит от указанного регламента.

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

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

Тип

Описание

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

строка

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

Номер

строка

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

Дата

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

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

Редакция

объект

номер редакции

 

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

строка

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

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

строка

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

Тип*

строка

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

Регламент

объект

регламент документа. Чтобы привязать регламент, заполните одно из полей — «Название» или «Идентификатор». Чтобы создать прочий кадровый с мероприятием ЕФС, укажите регламент «Переименование», «Установление (присвоение)» или «Запрет занимать должность»

 

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

строка

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

Название

строка

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

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

объект

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

 

СвЮЛ

объект

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

 

ИНН

строка

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

КПП

строка

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

КодФилиала

строка

код филиала

КодСтраны

строка

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

Название

строка

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

СвФЛ

объект

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

 

ИНН*

строка

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

КодФилиала

строка

код филиала

КодСтраны

строка

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

Фамилия

строка

фамилия

Имя

строка

имя

Отчество

строка

отчество

Автор

объект

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

 

Фамилия

строка

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

Имя

строка

имя автора

Отчество

строка

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

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

строка

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

Вложение

массив

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

 

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

строка

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

Название

строка

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

Удален

строка

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

Дата

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

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

Файл

объект

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

 

Имя

строка

имя файла

Ссылка

строка

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

Сотрудники*

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

список сотрудников, для которых оформляется документ. Если указать одновременно с полем «ПодразделениеСотрудника», в документ будут добавлены оба списка сотрудников. Можно добавить до 200 сотрудников. Определите сотрудника одним из способов (указаны по убыванию приоритета):

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

 

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

строка

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

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

строка

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

Фамилия

строка

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

Имя

строка

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

Отчество

строка

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

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

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

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

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

строка

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

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

строка

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

ПодразделениеСотрудника**

объект

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

Заполните один из параметров: «Код», «Название» или «ВнешнийИдентификатор»

 

Код

строка

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

Название

строка

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

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

строка

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

ПодразделенияСотрудников**

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

подразделения, по которым проводится документ. Будут добавлены сотрудники из вложенных подразделений. Если указать одновременно с полем «Сотрудники», в документ будут добавлены оба списка сотрудников. Указывается, если передается информация по нескольким подразделениям и сотрудникам.

Заполните один из параметров: «Код», «Название» или «ВнешнийИдентификатор»

 

Код

строка

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

Название

строка

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

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

строка

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

СтарыеЗначения**

объект

старые название и регистрационный номер организации. Обязательно для регламента «Переименование»

 

Название**

строка

название организации из поля «Было» в документе ЕФС. Обязательно для регламента «Переименование»

РегистрационныйНомер**

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

регистрационный номер из поля «Было» в документе ЕФС. Обязательно для регламента «Переименование»

НовыеЗначения**

объект

новые название и регистрационный номер организации. Обязательно для регламента «Переименование»

 

Название**

строка

название организации из поля «Стало» в документе ЕФС. Обязательно для регламента «Переименование»

РегистрационныйНомер**

строка

регистрационный номер из поля «Стало» в документе ЕФС. Обязательно для регламента «Переименование»

ДополнительныеСведения

строка

произвольная текстовая строка. Заполняется при создании документа с мероприятием «Установление (присвоение)». Например, можно указать причину создания мероприятий

ВидРаботы

строка

вид работы в документе с регламентом ЕФС

ОКЗ

объект

должность по общероссийскому классификатору занятий. Обязательно наличие хотя бы одного из двух полей объекта — «Название» или «Код». Поиск осуществляется по обоим полям. Если ничего не найдено, вернется ошибка. Заполняется при создании документа с мероприятием «Установление (присвоение)»

 

Название

строка

название должности по ОКЗ. Заполняется при создании документа с мероприятием «Установление (присвоение)»

Код

строка

код должности по ОКЗ. Заполняется при создании документа с мероприятием «Установление (присвоение)»

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

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

список документов-оснований. Заполняется при создании документа с мероприятием ЕФС

 

Название

строка

название документа

Номер

строка

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

Дата

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

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

Комментарий

Cоздать документ с мероприятиями ЕФС можно одним из способов:

  • в параметре «Регламент» выберите один из предустановленных регламентов — «Переименование», «Установление (присвоение)» или «Запрет занимать должность»;
  • укажите тип мероприятия ЕФС для одного из существующих регламентов прочего кадрового, затем выберите этот регламент в параметре «Регламент».

Примеры

Создать прочий кадровый

Прочитать документ. Возвращает данные для количества сотрудников до 200

Создать документ с мероприятием ЕФС «Запрет занимать должность»

Создать документ с мероприятием ЕФС «Установление (присвоение)»

Создать документ с мероприятием ЕФС «Переименование»

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