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

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

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

Команда СБИС.СписокДокументов возвращает список документов указанного типа («Реализация», «Корреспонденция» и т.д.). Список сортируется по дате документа и включает только информацию о вложениях последней редакции. Информация возвращается страницами, за форматирование отвечает параметр «Навигация».

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

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

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

    • "Навигация": объект:
      • "РазмерСтраницы": строка, количество записей, которые будут возвращены. Представлено целым числом. Возможные значения: от 1 до 500, по умолчанию — 20
      • "Страница": строка, номер страницы запрашиваемой выборки. Представлено целым числом, нумерация начинается с 0

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

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

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

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

Комментарий

Поле «Состояние» входного фильтра может содержать как перечисляемые значения из «Состояния документа», так и специфичные для метода «СБИС.СписокДокументов» значения:

  • «Неотправленные» (только для исходящих);
  • «Недоставленные» (только для исходящих);
  • «Не получен ответ» (только для исходящих);
  • «Утвержденные»;
  • «Отклоненные»;
  • «С ошибками»;
  • «Требующие ответа» (только для входящих);
  • «Незакрепленные»;
  • «Удаленные».

Значение, которое отмечено «только для входящих/исходящих» будет назначено автоматически, если в фильтре не указан параметр «Направление». Если же направление указано, и оно не совпадает с разрешенным направлением указанного состояния, будет возвращена ошибка.

В результаты запроса попадают документы в состоянии «черновик».

По умолчанию (без указания в фильтре состояния «Удаленные») в список не попадают удаленные документы.

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

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

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

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

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