Интеграция с информационной системой

СБИС.СписокИзменений

СБИС.СписокИзменений

Команда СБИС.СписокИзменений возвращает список документов, по которым произошли события документооборота за указанный период времени.

В качестве параметров фильтра указывается период времени, типа документа, реквизиты «нашей организации», идентификатора последнего обработанного события (из прежнего запроса) и другие.

Результат запроса представляет массив объектов, за форматирование которых отвечает параметр "Навигация".

Адрес для выполнения запроса: https://online.sbis.ru/service/?srv=1

Параметры строки запроса

  • "Фильтр": объект:
    • "ИдентификаторСобытия": строка
    • "ДатаВремяС": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "ДатаВремяПо": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "Тип": строка, тип документа
    • "НашаОрганизация": объект:
      • "СвЮЛ": объект
        • "ИНН": строка
        • "КПП": строка
        • "КодФилиала": строка
      • "СвФЛ": объект:
        • "ИНН": строка
    • "ПолныйСертификатЭП": строка "Да"/"Нет"

    • "Навигация": объект:
      • "РазмерСтраницы": строка, задаёт число записей, которые будут возвращены.

Результат запроса

  • "Документ": массив объектов:
    • "Идентификатор": строка
    • "Дата": строка в формате "ДД.ММ.ГГГГ"
    • "Номер": строка
    • "Сумма": строка
    • "Название": строка
    • "Примечание": строка
    • "ДатаВремяСоздания": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "Удален": строка "Да"/"Нет"
    • "Тип": строка (см. справочник)
    • "Направление": строка (см. справочник)
    • "Состояние": объект:
      • "Код": строка (см. справочник "Состояния документа")
      • "Название": строка
      • "Примечание": строка (комментарий при отклонении, текст ошибки и др.)
    • "Редакция": объект, информация о редакции документа:
      • "Идентификатор": строка
      • "ПримечаниеИС": строка, произвольное примечание информационной системы
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время создания редакции
    • "НашаОрганизация": объект:
      • "СвЮЛ": объект
        • "ИНН": строка
        • "КПП": строка
        • "КодФилиала": строка
        • "Название": строка
      • "СвФЛ": объект:
        • "ИНН": строка
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
    • "Контрагент": объект:
      • "СвЮЛ": объект:
        • "ИНН": строка
        • "КПП": строка
        • "Название": строка
      • "СвФЛ": объект:
        • "ИНН": строка
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
    • "Ответственный": объект:
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "Идентификатор": строка
  • "Событие": объект:
    • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "Название": строка
    • "Идентификатор": строка
    • "ПолныйСертификатЭП": строка "Да"/"Нет"
    • "Комментарий": строка
    • "Вложение": массив объектов:
      • "Название": строка
      • "Служебный": строка "Да"/"Нет"
      • "Идентификатор": строка
      • "Дата": строка в формате "ДД.ММ.ГГГГ"
      • "Номер": строка
      • "Сумма": строка
      • "Направление": строка
      • "Тип": строка
      • "Подтип": строка
      • "ВерсияФормата": строка
      • "Редакция": объект:
        • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
        • "Номер": строка, номер редакции (нумерация с 1)
      • "Файл": объект:
        • "Имя": строка
        • "Ссылка": строка
      • "Подпись": массив объектов:
        • "Сертификат": объект, реквизиты владельца сертификата ЭП. Объект возвращается не во всех вызовах.
          • "ФИО": строка, подписант.
          • "Должность": строка.
          • "ИНН": строка.
          • "Название": строка, название организации.
  • "Навигация": объект:
    • "РазмерСтраницы": строка (число целое, указывает размер запрошенной выборки).
    • "ЕстьЕще": строка "Да"/"Нет.

Порядок работы с командой

  1. Получить список событий за интересующий период и/или для "нашей организации", передав сохранённый идентификатор последнего обработанного события;
  2. Если список пуст, приостановить запросы на 1...5 минут, в противном случае — обработать полученный список;
  3. Сохранить идентификатор и дату/время последнего обработанного события;
  4. Повторить с шага 1.

Правила работы со списком событий

  • При первом запросе идентификатор события указывать не обязательно.
  • В случае отсутствия фильтра «Наша организация» в результате запроса возвращаются события для всех организаций кабинета.
  • При отсутствии параметра:
    • "ДатаВремяС" дата и время берётся с самого первого зарегистрированного в системе события.
    • "ДатаВремяПо" берётся текущая дата и время запроса на сервере.
  • Входящий документ следует определять и фиксировать в своей информационной системе при получении события с названием "Получение".
  • В случае, когда событие с переданным идентификатором отсутствует (например, из-за удаления документа), будет возвращена ошибка входных параметров (код 00000000-0000-0000-0000-1FA000010000) - необходимо повторить запрос с указанием сохранённой даты/времени последнего обработанного события.

Комментарий

  • Для унификации форматов данных каждое изменение (событие) возвращается "внутри" объекта «Документ» (Документ.Событие), к которому относится.
  • Изменение в документообороте может сопровождаться появлением вложений и/или подписей под вложениями. Новые вложения, связанные с событием документооборота, передаются как «Документ.Событие.Вложение», новые подписи — «Документ.Событие.Вложение.Подпись».
  • Если в результате изменения к вложению документа добавлена только подпись, то поле «Файл.Ссылка» у «Документ.Вложение.Файл.Ссылка» будет пустым. Скачивание подписи выполняется по «Документ.Событие.Вложение.Подпись.Файл.Ссылка».
  • Для переданного во входных параметрах значения поля «ИдентификаторСобытия» определяется дата/время события (берётся в качестве параметра фильтрации "ДатаВремяС"). При наличии "ДатаВремяС" выбирается наиболее "старое".

  • Документы-черновики, которые не участвовали в документообороте, в вывод метода не попадают.
  • Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала».
  • Запрещается пользоваться командой «СБИС.ПрочитатьДокумент» для получения расширенной информации о документе или событии, так как вся необходимая информация передаётся в результате вызова объекта «Документ».
  • Для ускорения работы списочных методов (2-10 раз) в запросе в фильтре необходимо передавать дополнительный (необязательный) параметр "ПолныйСертификатЭП" со значением "Нет".
  • Если отправитель и получатель документа работают в одном аккаунте, то при использовании поля Фильтр.ИдентификаторСобытия в запрос обязательно необходимо передавать Фильтр.НашаОрганизация, полученного из предыдущего запроса. В противном случае, возможен пропуск событий или зацикливание при получении списка событий.

Настройки прав доступа

Для выполнение команды СБИС.СписокИзменений у пользователя внешнего API-интерфейса в кабинете СБИС должны быть права на работу с документами (уровень доступа «Просмотр», «Полный» или «Администрирование»).

Пример запроса с указанием фильтра

Пример запроса с указанием фильтра

Пример ответа