Отпуск - API3 Объект — различия между версиями
(не показано 13 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
− | Документ | + | {{Документ!_-_API3_Объект}} |
− | + | * <span style="color:#E70000">ЧастноеЛицо</span> - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]] | |
− | = | + | * ВидОтпуска* - объект [[ВидОтпуска_-_API3_Объект|ВидОтпуска]] |
− | * | + | * ВидОтпускаКолДоговор - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]] |
− | * | + | * ОтзываемыйОтпуск - объект [[Отпуск_-_API3_Объект|Отпуск]], отпуск из которого отзывают |
− | * | + | * ПричинаОтзыва - объект [[ПричинаОтзываИзОтпуска_-_API3_Объект|ПричинаОтзываИзОтпуска]] |
− | * | + | * ДокументОснованиеОтзыва - объект [[Больничный_-_API3_Объект|Больничный]], ссылка на больничный в случае отзыва по больничному |
− | * | + | * ИнаяПричинаОтзыва - текст с указанием причины в случае если причина отзыва - иная. |
− | * | + | * Руководитель - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]] |
− | * | + | * ДолжностьРуководителя - объект [[Должность_-_API3_Объект|Должность]] |
− | * ДатаНач - дата начала | + | * ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ") |
− | * ДатаКнц - дата окончания | + | * ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ") |
− | * | + | * ДатаРасчета - месяц расчета в котором регистрируется документ (строка в формате "ДД.ММ.ГГГГ", последний день месяца) |
− | + | * ВсегоДней - продолжительность отпуска | |
− | * | ||
* СреднийЗаработок - сумма среднего заработка по календарным дням | * СреднийЗаработок - сумма среднего заработка по календарным дням | ||
* Сумма - начисленная сумма отпускных по документу | * Сумма - начисленная сумма отпускных по документу | ||
− | * | + | * СпособРасчета - признак, использовать основной и дополнительный (1), только основной отпуск (2) или только дополнительный (3). Работает ТОЛЬКО для отпусков "учетных" |
+ | * ОстаткиНаДату - дата, которую будут установлены остатки | ||
+ | * ДолжностиСотрудника* - массив, каждый элемент - должность сотрудника. Содержит расшифровку по периодам отпусков в разрезе рабочих периодов. Работает ТОЛЬКО для отпусков "без учета" | ||
+ | ** Сотрудник* - объект [[Сотрудник_-_API3_Объект|Сотрудник]] | ||
+ | ** ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ") | ||
+ | ** ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ") | ||
+ | ** <span style="color:#E70000">Оплачиваемый</span> - булевский флаг, оплачивать ли отпуск по данной должности | ||
+ | ** РабочийПериод - массив, каждый элемент - отдельный рабочий период (для отпусков) | ||
+ | *** ДатаНач* - дата начала основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ") | ||
+ | *** ДатаКнц* - дата окончания основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ") | ||
+ | *** РабочийГодС - дата начала рабочего периода за который предоставляется отпуск | ||
+ | *** РабочийГодПо - дата окончания рабочего периода за который предоставляется отпуск | ||
+ | *** ДопОтпуск - массив, каждый элемент - период доп.отпуска | ||
+ | **** ДатаНач* - дата начала доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ") | ||
+ | **** ДатаКнц* - дата окончания доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ") | ||
+ | **** Причина* - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]] | ||
+ | **** Продолжительность | ||
+ | ***** Кол_во* - количество дней | ||
+ | ***** ОКЕИ - '359' | ||
+ | ** Остатки - массив (для корректировок отпусков, в шапке ВидОтпуска=7) | ||
+ | *** ВидКорректируемогоОтпуска - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]], если не передан - корректируем основной ежегодный | ||
+ | *** РабочийГодС* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ") | ||
+ | *** РабочийГодПо* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ") | ||
+ | *** ОстатокДней* | ||
+ | *** ПоложеноДней | ||
+ | |||
+ | '''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону''' | ||
+ | |||
'''Пример:''' | '''Пример:''' | ||
<source lang="json"> | <source lang="json"> | ||
{ | { | ||
− | + | 'Дата': '01.06.2021', | |
− | + | 'ДатаРасчета': '30.06.2021', | |
− | + | 'ДатаНач': '19.06.2021', | |
− | + | 'ДатаКнц': '23.06.2021', | |
− | + | 'ВсегоДней': '5', | |
− | + | 'Номер': '20210601-full-upd', | |
− | + | 'Название': 'Отпуск копия №20210601-full-upd от 01.06.2021', | |
− | + | 'Регламент': 'Отпуск копия', | |
− | + | 'СреднийЗаработок': '1200.00', | |
− | + | 'Сумма': '7800.00', | |
− | + | 'Комментарий': 'комментарий документа', | |
− | + | 'Руководитель': {'ИдСБИС': '317'}, | |
− | + | 'ДолжностьРуководителя': {'ИдСБИС': '5'}, | |
− | + | 'Ответственный': {'ИдСБИС': '249'}, | |
− | + | 'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}], | |
− | + | 'НашаОрганизация': {'ИдСБИС': '234'}, | |
− | + | 'ВидОтпуска': {'ИдСБИС': '0'}, | |
− | + | 'ДолжностиСотрудника': [ | |
− | + | { | |
− | + | 'Сотрудник': {'ИдСБИС': '47'}, | |
− | + | 'РабочийПериод': [ | |
− | + | { | |
− | + | 'ДатаНач': '19.06.2021', | |
− | + | 'ДатаКнц': '23.06.2021', | |
− | + | 'РабочийГодС': '01.08.2015', | |
− | + | 'РабочийГодПо': '31.07.2016', | |
− | + | 'ДопОтпуск': [ | |
− | + | { | |
− | + | 'Причина': {'ИдСБИС': '1'}, | |
− | + | 'ДатаНач': '19.06.2021', | |
− | + | 'ДатаКнц': '23.06.2021', | |
+ | 'Продолжительность': {'Кол_во': '5'} | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ]} | ||
+ | ] | ||
} | } | ||
</source> | </source> | ||
Строка 60: | Строка 92: | ||
** Ключ1_2 - дата документа | ** Ключ1_2 - дата документа | ||
** Ключ1_3 - идентификатор организации | ** Ключ1_3 - идентификатор организации | ||
+ | ** Кчлю1_4 - идентификатор частного лица | ||
* Ключ2 - не используется | * Ключ2 - не используется | ||
* Ключ3 - не используется | * Ключ3 - не используется | ||
Строка 68: | Строка 101: | ||
* ЧастноеЛицо | * ЧастноеЛицо | ||
* ВидОтпуска | * ВидОтпуска | ||
+ | * СтруктураПредприятия | ||
+ | * ВидОтпускаДополнительный | ||
+ | * ПричинаОтзываИзОтпуска | ||
+ | * Больничный | ||
+ | * Должность | ||
+ | * ПриказНаУвольнение | ||
===Используемые методы БЛ=== | ===Используемые методы БЛ=== | ||
+ | * Отпуск.WriteFrom1C | ||
+ | * Отпуск.Записать | ||
* Отпуск.Прочитать | * Отпуск.Прочитать | ||
[[Категория:SBIS API3 Объект]] | [[Категория:SBIS API3 Объект]] |
Текущая версия на 14:36, 15 апреля 2024
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Автор — объект ЧастноеЛицо
- Вложение — массив с данными файлов, прилагаемых к документу
- Идентификатор — идентификатор файла в хранилище СБИС Диск
- Тип - строка, название типа формализованного вложения
- Подтип - строка, название подтипа формализованного вложения
- ВерсияФормата - строка, версия формата
- ПодверсияФормата - строка, подверсия формата
- Файл
- Имя
- Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
- ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
- ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
- ИдИС — идентификатор документа в ИС, строка
- ИдСБИС — идентификатор документа в СБИС, строка
- ИмяСБИС — имя api3 объекта
- Комментарий — строка
- Название — представление объекта
- НашаОрганизация* — объект НашаОрганизация
- Номер* — номер документа, строка
- Основание — список объектов документы основания (массив)
- ВидСвязи — вид связи с документом-основания
- Документ — объект документа-основания
- Сумма — сумма связи
- Ответственный — объект ЧастноеЛицо
- Параметры — массив именованных параметров ключ / значение
- Значение — значение параметра, строка
- Название — название параметра, строка
- Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
- Пометки — пометки по документу
- Проведён — Признак проведения документа, булево
- Удалён — Признак перемещения документа в удаленные, булево
- Важный — отметка Флажок на документе СБИС, булево
- Плюс — отметка Плюс на документе СБИС, булево
- Срочно — отметка Красный круг на документе СБИС, булево
- НеТребуется — отметка Зеленый круг на документе СБИС, булево
- Просмотрен — отметка Синий круг на документе СБИС, булево
- Значительный — отметка Желтый круг на документе СБИС, булево
- ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
- Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
- Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
- Регламент — название регламента, строка
- Состояние — код состояния документа
- СчетУчетаКонтрагент — объект ПоказательУчета
- СчетУчетаАванс — объект ПоказательУчета
- ЧастноеЛицо - объект ЧастноеЛицо
- ВидОтпуска* - объект ВидОтпуска
- ВидОтпускаКолДоговор - объект ВидОтпускаДополнительный
- ОтзываемыйОтпуск - объект Отпуск, отпуск из которого отзывают
- ПричинаОтзыва - объект ПричинаОтзываИзОтпуска
- ДокументОснованиеОтзыва - объект Больничный, ссылка на больничный в случае отзыва по больничному
- ИнаяПричинаОтзыва - текст с указанием причины в случае если причина отзыва - иная.
- Руководитель - объект ЧастноеЛицо
- ДолжностьРуководителя - объект Должность
- ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
- ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
- ДатаРасчета - месяц расчета в котором регистрируется документ (строка в формате "ДД.ММ.ГГГГ", последний день месяца)
- ВсегоДней - продолжительность отпуска
- СреднийЗаработок - сумма среднего заработка по календарным дням
- Сумма - начисленная сумма отпускных по документу
- СпособРасчета - признак, использовать основной и дополнительный (1), только основной отпуск (2) или только дополнительный (3). Работает ТОЛЬКО для отпусков "учетных"
- ОстаткиНаДату - дата, которую будут установлены остатки
- ДолжностиСотрудника* - массив, каждый элемент - должность сотрудника. Содержит расшифровку по периодам отпусков в разрезе рабочих периодов. Работает ТОЛЬКО для отпусков "без учета"
- Сотрудник* - объект Сотрудник
- ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
- ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
- Оплачиваемый - булевский флаг, оплачивать ли отпуск по данной должности
- РабочийПериод - массив, каждый элемент - отдельный рабочий период (для отпусков)
- ДатаНач* - дата начала основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
- ДатаКнц* - дата окончания основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
- РабочийГодС - дата начала рабочего периода за который предоставляется отпуск
- РабочийГодПо - дата окончания рабочего периода за который предоставляется отпуск
- ДопОтпуск - массив, каждый элемент - период доп.отпуска
- ДатаНач* - дата начала доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
- ДатаКнц* - дата окончания доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
- Причина* - объект ВидОтпускаДополнительный
- Продолжительность
- Кол_во* - количество дней
- ОКЕИ - '359'
- Остатки - массив (для корректировок отпусков, в шапке ВидОтпуска=7)
- ВидКорректируемогоОтпуска - объект ВидОтпускаДополнительный, если не передан - корректируем основной ежегодный
- РабочийГодС* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ")
- РабочийГодПо* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ")
- ОстатокДней*
- ПоложеноДней
Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону
Пример:
{
'Дата': '01.06.2021',
'ДатаРасчета': '30.06.2021',
'ДатаНач': '19.06.2021',
'ДатаКнц': '23.06.2021',
'ВсегоДней': '5',
'Номер': '20210601-full-upd',
'Название': 'Отпуск копия №20210601-full-upd от 01.06.2021',
'Регламент': 'Отпуск копия',
'СреднийЗаработок': '1200.00',
'Сумма': '7800.00',
'Комментарий': 'комментарий документа',
'Руководитель': {'ИдСБИС': '317'},
'ДолжностьРуководителя': {'ИдСБИС': '5'},
'Ответственный': {'ИдСБИС': '249'},
'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}],
'НашаОрганизация': {'ИдСБИС': '234'},
'ВидОтпуска': {'ИдСБИС': '0'},
'ДолжностиСотрудника': [
{
'Сотрудник': {'ИдСБИС': '47'},
'РабочийПериод': [
{
'ДатаНач': '19.06.2021',
'ДатаКнц': '23.06.2021',
'РабочийГодС': '01.08.2015',
'РабочийГодПо': '31.07.2016',
'ДопОтпуск': [
{
'Причина': {'ИдСБИС': '1'},
'ДатаНач': '19.06.2021',
'ДатаКнц': '23.06.2021',
'Продолжительность': {'Кол_во': '5'}
}
]
}
]}
]
}
Естественные ключи
- Ключ1 - номер документа + дата документа + организация (вес = 3)
- Ключ1_1 - номер документа
- Ключ1_2 - дата документа
- Ключ1_3 - идентификатор организации
- Кчлю1_4 - идентификатор частного лица
- Ключ2 - не используется
- Ключ3 - не используется
Зависит от объектов
- НашаОрганизация
- Сотрудник
- ЧастноеЛицо
- ВидОтпуска
- СтруктураПредприятия
- ВидОтпускаДополнительный
- ПричинаОтзываИзОтпуска
- Больничный
- Должность
- ПриказНаУвольнение
Используемые методы БЛ
- Отпуск.WriteFrom1C
- Отпуск.Записать
- Отпуск.Прочитать