Отпуск - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
 
(не показано 6 промежуточных версий этого же участника)
Строка 1: Строка 1:
===Объект===
+
{{Документ!_-_API3_Объект}}
Тип: Документ
+
* <span style="color:#E70000">ЧастноеЛицо</span> - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
 
+
* ВидОтпуска* - объект [[ВидОтпуска_-_API3_Объект|ВидОтпуска]]
'''Структура:'''
+
* ВидОтпускаКолДоговор - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]]
* ИдИС  - идентификатор документа в ИС (строка)
+
* ОтзываемыйОтпуск - объект [[Отпуск_-_API3_Объект|Отпуск]], отпуск из которого отзывают
* Номер * - номер документа (строка)
+
* ПричинаОтзыва - объект [[ПричинаОтзываИзОтпуска_-_API3_Объект|ПричинаОтзываИзОтпуска]]
* Дата * - дата документа (строка в формате "ДД.ММ.ГГГГ")
+
* ДокументОснованиеОтзыва - объект [[Больничный_-_API3_Объект|Больничный]], ссылка на больничный в случае отзыва по больничному
* НашаОрганизация * - объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
+
* ИнаяПричинаОтзыва - текст с указанием причины в случае если причина отзыва - иная.
* '''''<span style="color:#ff0000">deprecated</span>''''' Сотрудник - объект [[Сотрудник_-_API3_Объект|Сотрудник]] (устаревший вариант, пока поддерживаем, но скоро откажемся)
+
* Руководитель - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
* ЧастноеЛицо * - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
+
* ДолжностьРуководителя - объект [[Должность_-_API3_Объект|Должность]]
* ВидОтпуска * - объект [[ВидОтпуска_-_API3_Объект|ВидОтпуска]]
+
* ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
* РабочаяГруппа * - объект [[СтруктураПредприятия_-_API3_Объект|СтруктураПредприятия]]
+
* ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
* Название * - название
 
* ДатаНач - дата начала периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
 
* ДатаКнц - дата окончания периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
 
 
* ДатаРасчета - месяц расчета в котором регистрируется документ (строка в формате "ДД.ММ.ГГГГ", последний день месяца)
 
* ДатаРасчета - месяц расчета в котором регистрируется документ (строка в формате "ДД.ММ.ГГГГ", последний день месяца)
 
* ВсегоДней - продолжительность отпуска
 
* ВсегоДней - продолжительность отпуска
 
* СреднийЗаработок - сумма среднего заработка по календарным дням
 
* СреднийЗаработок - сумма среднего заработка по календарным дням
 
* Сумма - начисленная сумма отпускных по документу
 
* Сумма - начисленная сумма отпускных по документу
* Комментарий
+
* СпособРасчета - признак, использовать основной и дополнительный (1), только основной отпуск (2) или только дополнительный (3). Работает ТОЛЬКО для отпусков "учетных"
* Регламент
+
* ОстаткиНаДату - дата, которую будут установлены остатки
* ДолжностиСотрудника - массив, каждый элемент - должность сотрудника. Содержит расшифровку по периодам отпусков в разрезе рабочих периодов. Работает ТОЛЬКО для отпусков "без учета"
+
* ДолжностиСотрудника* - массив, каждый элемент - должность сотрудника. Содержит расшифровку по периодам отпусков в разрезе рабочих периодов. Работает ТОЛЬКО для отпусков "без учета"
** Сотрудник * - объект [[Сотрудник_-_API3_Объект|Сотрудник]]
+
** Сотрудник* - объект [[Сотрудник_-_API3_Объект|Сотрудник]]
** ДатаНач - дата начала периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
+
** ДатаНач* - дата начала периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
** ДатаКнц - дата окончания периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
+
** ДатаКнц* - дата окончания периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
** РабочийПериод - массив, каждый элемент - отдельный рабочий период
+
** <span style="color:#E70000">Оплачиваемый</span> - булевский флаг, оплачивать ли отпуск по данной должности
*** ДатаНач - дата начала основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
+
** РабочийПериод - массив, каждый элемент - отдельный рабочий период (для отпусков)
*** ДатаКнц - дата окончания основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
+
*** ДатаНач* - дата начала основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
 +
*** ДатаКнц* - дата окончания основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
 
*** РабочийГодС - дата начала рабочего периода за который предоставляется отпуск
 
*** РабочийГодС - дата начала рабочего периода за который предоставляется отпуск
 
*** РабочийГодПо - дата окончания рабочего периода за который предоставляется отпуск
 
*** РабочийГодПо - дата окончания рабочего периода за который предоставляется отпуск
 
*** ДопОтпуск - массив, каждый элемент - период доп.отпуска
 
*** ДопОтпуск - массив, каждый элемент - период доп.отпуска
**** ДатаНач - дата начала доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
+
**** ДатаНач* - дата начала доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
**** ДатаКнц - дата окончания доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
+
**** ДатаКнц* - дата окончания доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
**** Причина - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]]
+
**** Причина* - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]]
 
**** Продолжительность
 
**** Продолжительность
***** Кол_во - количество дней
+
***** Кол_во* - количество дней
 
***** ОКЕИ - '359'
 
***** ОКЕИ - '359'
* ОтзываемыйОтпуск - объект [[Отпуск_-_API3_Объект|Отпуск]], отпуск из которого отзывают
+
** Остатки - массив (для корректировок отпусков, в шапке ВидОтпуска=7)
* ПричинаОтзыва - объект [[ПричинаОтзываИзОтпуска_-_API3_Объект|ПричинаОтзываИзОтпуска]]
+
*** ВидКорректируемогоОтпуска - объект [[ВидОтпускаДополнительный_-_API3_Объект|ВидОтпускаДополнительный]], если не передан - корректируем основной ежегодный
* ДокументОснованиеОтзыва - объект [[Больничный_-_API3_Объект|Больничный]], ссылка на больничный в случае отзыва по больничному
+
*** РабочийГодС* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ")
* ИнаяПричинаОтзыва - текст с указанием причины в случае если причина отзыва - иная.
+
*** РабочийГодПо* - дата начала рабочего периода за который предоставляются дни корректировки (строка в формате "ДД.ММ.ГГГГ")
 +
*** ОстатокДней*
 +
*** ПоложеноДней
  
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
Строка 47: Строка 47:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
  "ИдИС": "ИдИС",
+
'Дата': '01.06.2021',
  "Номер": "update1update1",
+
'ДатаРасчета': '30.06.2021',
  "Дата": "20.11.2020",
+
'ДатаНач': '19.06.2021',
  "ДатаРасчета": "31.12.2020",
+
'ДатаКнц': '23.06.2021',
  "Название": "Отпуск №update1update1 от 20.11.2020",
+
'ВсегоДней': '5',
  "ДатаНач": "05.01.2021",
+
'Номер': '20210601-full-upd',
  "ДатаКнц": "13.01.2021",
+
'Название': 'Отпуск копия №20210601-full-upd от 01.06.2021',
  "Комментарий": "обновили",
+
'Регламент': 'Отпуск копия',
  "ВсегоДней": "9",
+
'СреднийЗаработок': '1200.00',
  "Сумма": "4500.00",
+
'Сумма': '7800.00',
  "СреднийЗаработок": "500.0",
+
'Комментарий': 'комментарий документа',
  "Регламент": "для unittest",
+
'Руководитель': {'ИдСБИС': '317'},
  "НашаОрганизация": {
+
'ДолжностьРуководителя': {'ИдСБИС': '5'},
    "ИдСБИС": "167"
+
'Ответственный': {'ИдСБИС': '249'},
  },
+
'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}],
  "ЧастноеЛицо": {
+
'НашаОрганизация': {'ИдСБИС': '234'},
    "ИдСБИС": "879"
+
'ВидОтпуска': {'ИдСБИС': '0'},
  },
+
'ДолжностиСотрудника': [
  "Сотрудник": {
+
{
    "ИдСБИС": "61"
+
'Сотрудник': {'ИдСБИС': '47'},
  },
+
'РабочийПериод': [
  "ВидОтпуска": {
+
{
    "ИдСБИС": "8"
+
'ДатаНач': '19.06.2021',
  },
+
'ДатаКнц': '23.06.2021',
  "РабочаяГруппа": {
+
'РабочийГодС': '01.08.2015',
    "ИдСБИС": "248"
+
'РабочийГодПо': '31.07.2016',
  },
+
'ДопОтпуск': [
  "ДолжностиСотрудника": [
+
{
    {
+
'Причина': {'ИдСБИС': '1'},
      "ДатаКнц": "15.04.2019",
+
'ДатаНач': '19.06.2021',
      "ДатаНач": "01.04.2019",
+
'ДатаКнц': '23.06.2021',
      "РабочийПериод": [
+
'Продолжительность': {'Кол_во': '5'}
        {
+
}
          "ДатаКнц": "15.04.2019",
+
]
          "ДатаНач": "01.04.2019",
+
}
          "ДопОтпуск": [
+
]}
            {
+
]
              "ДатаКнц": "13.04.2019",
 
              "ДатаНач": "11.04.2019",
 
              "Причина": {
 
                "ИдИС": "61c320cc-e1a1-4f33-bd3f-c76d1f6fde2f",
 
                "ИдСБИС": "2",
 
                "ИмяИС": "Справочники.ВидыОтпусков",
 
                "ИмяСБИС": "ВидОтпускаДополнительный",
 
                "Ини": "СинхВыгрузка_ВидОтпускаДополнительный",
 
                "Название": "Северный"
 
              },
 
              "Продолжительность": {
 
                "Кол_во": "3.00",
 
                "ОКЕИ": "359"
 
              }
 
            },
 
            {
 
              "ДатаКнц": "15.04.2019",
 
              "ДатаНач": "14.04.2019",
 
              "Причина": {
 
                "ИдИС": "4420796a-a755-11eb-aab1-f079597094ef",
 
                "ИдСБИС": "3",
 
                "ИмяИС": "Справочники.ВидыОтпусков",
 
                "ИмяСБИС": "ВидОтпускаДополнительный",
 
                "Ини": "СинхВыгрузка_ВидОтпускаДополнительный",
 
                "Название": "ежегоный дополниьельный"
 
              },
 
              "Продолжительность": {
 
                "Кол_во": "2.00",
 
                "ОКЕИ": "359"
 
              }
 
            }
 
          ],
 
          "РабочийГодПо": "21.12.2018",
 
          "РабочийГодС": "22.12.2017"
 
        }
 
      ],
 
      "Сотрудник": {
 
        "ИдИС": "1f64cd44-533e-11ec-8548-fc349713f338",
 
        "ИдСБИС": "750",
 
        "ИмяИС": "Справочники.Сотрудники",
 
        "ИмяСБИС": "Сотрудник",
 
        "Ини": "СинхВыгрузка_Сотрудник"
 
      }
 
    }
 
  ]
 
 
}
 
}
 
</source>
 
</source>
Строка 137: Строка 92:
 
** Ключ1_2 - дата документа
 
** Ключ1_2 - дата документа
 
** Ключ1_3 - идентификатор организации
 
** Ключ1_3 - идентификатор организации
 +
** Кчлю1_4 - идентификатор частного лица
 
* Ключ2 - не используется
 
* Ключ2 - не используется
 
* Ключ3 - не используется
 
* Ключ3 - не используется
Строка 146: Строка 102:
 
* ВидОтпуска
 
* ВидОтпуска
 
* СтруктураПредприятия
 
* СтруктураПредприятия
 +
* ВидОтпускаДополнительный
 +
* ПричинаОтзываИзОтпуска
 +
* Больничный
 +
* Должность
 +
* ПриказНаУвольнение
  
 
===Используемые методы БЛ===
 
===Используемые методы БЛ===
 +
* Отпуск.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
  • Отпуск.Записать
  • Отпуск.Прочитать