Отпуск - API3 Объект

Материал из razgovorov.ru
Перейти к: навигация, поиск

Объект

Тип: Документ

Легенда:

  • Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
  • Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
  • Реквизиты красного цвета поддерживаются синхронизацией только из СБИС


Структура:

  • Вложение — массив с данными файлов, прилагаемых к документу
  • Идентификатор — идентификатор файла в хранилище СБИС Диск
  • Тип - строка, название типа формализованного вложения
  • Подтип - строка, название подтипа формализованного вложения
  • ВерсияФормата - строка, версия формата
  • ПодверсияФормата - строка, подверсия формата
  • Файл
    • Имя
  • Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
  • ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
  • ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
  • ИдИС — идентификатор документа в ИС, строка
  • ИдСБИС — идентификатор документа в СБИС, строка
  • ИмяСБИС — имя api3 объекта
  • Комментарий — строка
  • Название — представление объекта
  • НашаОрганизация* — объект НашаОрганизация
  • Номер* — номер документа, строка
  • Основание — список объектов документы основания (массив)
  • ВидСвязи — вид связи с документом-основания
  • Документ — объект документа-основания
  • Сумма — сумма связи
  • Параметры — массив именованных параметров ключ / значение
  • Значение — значение параметра, строка
  • Название — название параметра, строка
  • Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
  • Пометки — пометки по документу
  • Проведён — Признак проведения документа, булево
  • Удалён — Признак перемещения документа в удаленные, булево
  • Важный — отметка Флажок на документе СБИС, булево
  • Плюс — отметка Плюс на документе СБИС, булево
  • Срочно — отметка Красный круг на документе СБИС, булево
  • НеТребуется — отметка Зеленый круг на документе СБИС, булево
  • Просмотрен — отметка Синий круг на документе СБИС, булево
  • Значительный — отметка Желтый круг на документе СБИС, булево
  • ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
  • Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
  • Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
  • Регламент — название регламента, строка
  • Состояние — код состояния документа
  • СчетУчетаКонтрагент — объект ПоказательУчета
  • СчетУчетаАванс — объект ПоказательУчета
  • ЧастноеЛицо - объект ЧастноеЛицо
  • ВидОтпуска* - объект ВидОтпуска
  • ВидОтпускаКолДоговор - объект ВидОтпускаДополнительный
  • ОтзываемыйОтпуск - объект Отпуск, отпуск из которого отзывают
  • ПричинаОтзыва - объект ПричинаОтзываИзОтпуска
  • ДокументОснованиеОтзыва - объект Больничный, ссылка на больничный в случае отзыва по больничному
  • ИнаяПричинаОтзыва - текст с указанием причины в случае если причина отзыва - иная.
  • Руководитель - объект ЧастноеЛицо
  • ДолжностьРуководителя - объект Должность
  • ДатаНач - дата начала периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
  • ДатаКнц - дата окончания периода отсутствия в рамках всех отпусков, по всем должностям(строка в формате "ДД.ММ.ГГГГ")
  • ДатаРасчета - месяц расчета в котором регистрируется документ (строка в формате "ДД.ММ.ГГГГ", последний день месяца)
  • ВсегоДней - продолжительность отпуска
  • СреднийЗаработок - сумма среднего заработка по календарным дням
  • Сумма - начисленная сумма отпускных по документу
  • СпособРасчета - признак, использовать основной и дополнительный (1), только основной отпуск (2) или только дополнительный (3)
  • ДолжностиСотрудника - массив, каждый элемент - должность сотрудника. Содержит расшифровку по периодам отпусков в разрезе рабочих периодов. Работает ТОЛЬКО для отпусков "без учета"
    • Сотрудник* - объект Сотрудник
    • ДатаНач - дата начала периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
    • ДатаКнц - дата окончания периода отсутствия в рамках всех отпусков, по текущий должности(строка в формате "ДД.ММ.ГГГГ")
    • РабочийПериод - массив, каждый элемент - отдельный рабочий период
      • ДатаНач - дата начала основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
      • ДатаКнц - дата окончания основного отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
      • РабочийГодС - дата начала рабочего периода за который предоставляется отпуск
      • РабочийГодПо - дата окончания рабочего периода за который предоставляется отпуск
      • ДопОтпуск - массив, каждый элемент - период доп.отпуска
        • ДатаНач - дата начала доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
        • ДатаКнц - дата окончания доп.отпуска в рамках текущего периода работы(строка в формате "ДД.ММ.ГГГГ")
        • Причина - объект ВидОтпускаДополнительный
        • Продолжительность
          • Кол_во - количество дней
          • ОКЕИ - '359'

Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону


Пример: 

{
  "ИдИС": "ИдИС",
  "Номер": "update1update1",
  "Дата": "20.11.2020",
  "ДатаРасчета": "31.12.2020",
  "Название": "Отпуск №update1update1 от 20.11.2020",
  "ДатаНач": "05.01.2021",
  "ДатаКнц": "13.01.2021",
  "Комментарий": "обновили",
  "ВсегоДней": "9",
  "Сумма": "4500.00",
  "СреднийЗаработок": "500.0",
  "Регламент": "для unittest",
  "НашаОрганизация": {
    "ИдСБИС": "167"
  },
  "ЧастноеЛицо": {
    "ИдСБИС": "879"
  },
  "Сотрудник": {
    "ИдСБИС": "61"
  },
  "ВидОтпуска": {
    "ИдСБИС": "8"
  },
  "РабочаяГруппа": {
    "ИдСБИС": "248"
  },
  "ДолжностиСотрудника": [
    {
      "ДатаКнц": "15.04.2019",
      "ДатаНач": "01.04.2019",
      "РабочийПериод": [
        {
          "ДатаКнц": "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",
        "ИмяИС": "Справочники.Сотрудники",
        "ИмяСБИС": "Сотрудник",
        "Ини": "СинхВыгрузка_Сотрудник"
      }
    }
  ]
}

Естественные ключи

  • Ключ1 - номер документа + дата документа + организация (вес = 3)
    • Ключ1_1 - номер документа
    • Ключ1_2 - дата документа
    • Ключ1_3 - идентификатор организации
  • Ключ2 - не используется
  • Ключ3 - не используется

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

  • НашаОрганизация
  • Сотрудник
  • ЧастноеЛицо
  • ВидОтпуска
  • СтруктураПредприятия

Используемые методы БЛ

  • Отпуск.Прочитать
Источник — «http://wiki.razgovorov.ru/index.php?title=Отпуск_-_API3_Объект&oldid=6538»