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

Команда возвращает список документов указанного типа.

Список сортируется по дате документа и содержит информацию о вложениях последней редакции. Информация возвращается страницами.

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

Адрес запроса: https://online.sbis.ru/service/?srv=1

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

• "Фильтр": объект:
  • "ДатаС": строка в формате «ДД.ММ.ГГГГ». Дата, начиная с которой отбираются документы
  • "ДатаПо": строка в формате «ДД.ММ.ГГГГ». Дата, до которой отбираются документы
  • "Тип"*: строка, тип документа
  • "Регламент": объект:
    • "Название": строка, название регламента
    • "Идентификатор": строка, идентификатор регламента
  • "Направление": строка. Возможные значения: «Входящий», «Исходящий»
  • "Состояние": строка, код состояния документа
  • "Маска": строка, фильтр по полю «Документ.Примечание», «Документ.Номер»
  • "НашаОрганизация": объект, сведения о нашей компании:
    • "GLN": строка, Global Location Number
    • "СвЮЛ": объект:
      • "ИНН": строка, 10 символов. Для иностранных организаций определяется законодательством их стран
      • "КПП": строка, 9 символов
      • "КодФилиала": строка
      • "КодСтраны": строка, код страны в стандарте ISO 3166-1 Numeric
    • "СвФЛ": объект:
      • "ИНН": строка, 12 символов. Для иностранных организаций определяется законодательством их стран
      • "КодФилиала": строка
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
  • "Контрагент": объект или массив объектов:
    • "GLN": строка, Global Location Number
    • "СвЮЛ": объект:
      • "ИНН": строка, 10 символов. Для иностранных организаций определяется законодательством их стран
      • "КПП": строка, 9 символов
      • "КодФилиала": строка
      • "КодСтраны": строка, код страны в стандарте ISO 3166-1 Numeric
    • "СвФЛ": объект. Сведения о физическом лице
      • "ИНН": строка, 12 символов. Для иностранных организаций определяется законодательством их стран
      • "КодФилиала": строка
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "СНИЛС": строка
      • "ЧастноеЛицо": строка. Возможные значения: «Да», «Нет»
  • "Подразделение": объект:
    • "Название": строка, название подразделения
    • "Идентификатор": строка, код подразделения
    • "Структура": строка. Возможные значения: «Активная», «Юридическая», «Управленческая», «Совмещенная». Если указано «Совмещенная», поиск производится сначала по юридической, затем по управленческой структуре. Если значение не указано, используется управленческая структура
  • "Ответственный": объект:
    • "Фамилия": строка
    • "Имя": строка
    • "Отчество": строка

    • "Идентификатор": строка, табельный номер

  • "Навигация": объект, отвечает за формирование страниц:
    • "РазмерСтраницы": строка, количество записей, которые будут возвращены. Значение — целое число в диапазоне от 1 до 200, по умолчанию — 20
    • "Страница": строка, номер страницы запрашиваемой выборки. Целое число, нумерация начинается с 0
  • "ИсключитьНепроверенныеМЧД": строка. Признак, добавлять ли документы с недействительными МЧД в список. Возможные значения: «Да», «Нет». Если «Да», документ не попадет в список, если хотя бы одна из МЧД недействительна.

Результат

В результате вызова возвращаются все основные реквизиты пакета и неслужебных документов. ЭП, события, сертификаты для действий этапов не возвращаются.

Синий — только для чтения.

• "Документ": массив объектов:
  • "Идентификатор": строка
  • "Дата": строка в формате «ДД.ММ.ГГГГ»
  • "Номер": строка
  • "Сумма": строка
  • "Название": строка
  • "Примечание": строка. Комментарий при отклонении, например текст ошибки
  • "ДатаВремяСоздания": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
  • "Удален": строка «Да/Нет»
  • "Тип": строка
  • "Направление": строка
  • "СсылкаДляНашаОрганизация": строка
  • "СсылкаДляКонтрагент": строка
  • "СсылкаНаАрхив": строка
  • "Состояние": объект:
    • "Код": число, код состояния
    • "Название": строка
    • "Примечание": строка. Комментарий при отклонении, например текст ошибки
  • "Редакция": массив объектов:
    • "Идентификатор": строка
    • "ПримечаниеИС": строка
    • "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
  • "Регламент": объект:
    • "Название": строка
    • "Идентификатор": строка
  • "НашаОрганизация": объект:
    • "СвЮЛ": объект:
      • "ИНН": строка, для юридических лиц номер состоит из 10 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
      • "КПП": строка
      • "КодФилиала": строка
      • "КодСтраны": строка, код страны в стандарте ISO 3166-1 Numeric
      • "Название": строка
    • "СвФЛ": объект:
      • "ИНН": строка, для индивидуальных предпринимателей и физических лиц номер состоит из 12 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
      • "КодФилиала": строка
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
  • "Контрагент": объект:
    • "СвЮЛ": объект:
      • "ИНН": строка, для юридических лиц номер состоит из 10 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
      • "КПП": строка
      • "Название": строка
    • "СвФЛ": объект:
      • "ИНН": строка, для индивидуальных предпринимателей и физических лиц номер состоит из 12 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "СНИЛС": строка
      • "ЧастноеЛицо": строка. Возможные значения: «Да», «Нет»
  • "Подразделение": объект:
    • "Название": строка
    • "Идентификатор": строка
    • "Структура": строка. Возможные значения: «Активная», «Юридическая», «Управленческая», «Совмещенная». Если указано «Совмещенная», поиск производится сначала по юридической, затем по управленческой структуре. Если значение не указано, используется управленческая структура
  • "Ответственный": объект:
    • "Фамилия": строка
    • "Имя": строка
    • "Отчество": строка
    • "Идентификатор": строка
  • "Вложение": массив объектов:
    • "Название": строка
    • "Идентификатор": строка
    • "Дата": строка в формате «ДД.ММ.ГГГГ»
    • "Номер": строка
    • "Сумма": строка
    • "Направление": строка
    • "Тип": строка
    • "Подтип": строка
    • "ВерсияФормата": строка
    • "Редакция": объект:
      • "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
      • "Номер": строка, нумерация с 1
• "Навигация": объект:
  • "РазмерСтраницы": строка, указывает размер запрошенной выборки. Значение — целое число в диапазоне от 1 до 200, по умолчанию — 20
  • "Страница": строка, номер текущей страницы
  • "ЕстьЕще": строка «Да/Нет». «Да» означает наличие последующих записей

Комментарий

1. В список результатов попадают и документы в состоянии «черновик».
2. Удаленные документы будут в списке результата, только если в поле «Состояние» указано «20». По умолчанию они не отображаются.
3. Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке «HTTP 403 Forbidden».

Примеры

Получить список документов по типу

Получить список документов только с действительными МЧД