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

СБИС.СписокДокументовПоСобытиям

СБИС.СписокДокументовПоСобытиям

Команда СБИС.СписокДокументовПоСобытиям возвращает список документов реестра «Входящие», «Исходящие» или «Ответы от контрагентов».

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

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

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

По умолчанию размер страницы для объекта «Навигация» равен 25.

* — обязательные параметры

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

Синие — поля, доступные только для чтения (т.е. в возвращаемых значениях).

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

Типы реестра

"ТипРеестра" — перечисляемое, возможные значения следующие:

  • "Входящие";
  • "Отправленные";
  • "Ответы контрагента".

Состояние

Возможные значения фильтра "Состояние" зависят от типа реестра:

  • "Входящие":
    • "Требующие ответа";
    • "Утвержденные";
    • "Отклоненные";
    • "С ошибками";
    • "Незакрепленные";
    • "Удаленные";
    • "Удалено контрагентом".
  • "Отправленные", "Ответы контрагента":
  • "Внутренняя обработка";
  • "Недоставленные";
  • "Не получен ответ";
  • "Утвержденные";
  • "Отклоненные";
  • "С ошибками";
  • "Незакрепленные";
  • "Удаленные";
  • "Удалено контрагентом";
  • "Черновики".

В реестры не включаются комплекты документов, на которых установлен флаг «Удален» (кроме фильтра «Удаленные»).

Внимание!

Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала».

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

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

​Пример запроса

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

Пример запроса с типами вложений «накладная» и «договор»