Электронный документооборот

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

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

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

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

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

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

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

Результат

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

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

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

Комментарий

  1. Поле «Состояние» входного фильтра может содержать «Название» из «Состояния документа», а также специфичные для метода «СБИС.СписокДокументов» значения. Они имеют код состояния документа, соответствующий справочнику кодов состояния.
    • «Неотправленные» — только для исходящих. Код 0, 1, 19, 20.
    • «Недоставленные» — только для исходящих. Код 2, 3.
    • «Не получен ответ» — только для исходящих. Код 2, 3.
    • «Внутренняя обработка» — только для исходящих. Код 10.
    • «Требующие ответа» — только для входящих. Код 10.
    • «Черновики» — код 0, 1.
    • «Утвержденные» — код 7.
    • «Отклоненные» — код 9.
    • «С ошибками» — код 6.
    • «Удалено контрагентом» — код 20.
    • «Незакрепленные».
    • «Аннулированые» — код 19, 20, 22.
    • «Удаленные».
  2. Eсли в фильтре не указан параметр «Направление», то значение, которое отмечено как «только для входящих/исходящих», будет назначено автоматически. Если направление указано и оно не совпадает с разрешенным направлением указанного состояния — вернется ошибка.
  3. В результат выполнения команды попадают документы в состоянии «черновик».
  4. По умолчанию (без указания в фильтре состояния «Удаленные») в список не попадают удаленные документы.
  5. Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала».

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

{
   "jsonrpc": "2.0",
   "method": "СБИС.СписокДокументов",
   "params": {
      "Фильтр": {
         "ДатаС": "04.07.2014",
         "Тип": "ДокОтгрИсх",
         "НашаОрганизация": {
            "СвЮЛ": {
               "ИНН": "1111654353",
               "КПП": "111101001",
               "Название": "Тестовый Отправитель"
            }
         }
      }
   },
   "id": 0
}
Скачать пример

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

{
   "jsonrpc": "2.0",
   "result": {
      "Документ": [
         {
            "Вложение": [
               {
                  "ВерсияФормата": "5.01",
                  "Дата": "16.04.2015",
                  "Идентификатор": "34fb6b9a-c902-41a9-89cf-ebc9ef0796c3",
                  "Название": "Накладная № 56089268 от 16.04.15 на сумму 59 979.40р., в т.ч.НДС 9 149.40 р.",
                  "Направление": "Исходящий",
                  "Номер": "56089268",
                  "Подтип": "1175004",
                  "Редакция": {
                     "ДатаВремя": "16.04.2015 09.49.52",
                     "Номер": "1"
                  },
                  "Сумма": "59979.40",
                  "Тип": "ЭДОНакл"
               }
            ],
            "Дата": "16.04.2015",
            "ДатаВремяСоздания": "16.04.2015 09.49.51",
            "Идентификатор": "fc597a23-f59c-45b8-9c6e-00e98fbaac76",
            "Контрагент": {
               "СвЮЛ": {
                  "ИНН": "1111681325",
                  "КПП": "111101001",
                  "КодСтраны": "643",
                  "Название": "Тестовый Получатель"
               }
            },
            "Название": "Реализация № 56089268 от 16.04.2015",
            "Направление": "Исходящий",
            "НашаОрганизация": {
               "СвЮЛ": {
                  "ИНН": "1111654353",
                  "КПП": "111101001",
                  "КодСтраны": "643",
                  "Название": "Тестовый Отправитель"
               }
            },
            "Номер": "56089268",
            "Ответственный": {
               "Идентификатор": "",
               "Имя": "Иван",
               "Отчество": "Иванович",
               "Фамилия": "Иванов"
            },
            "Примечание": "Здесь обычно указывают примечание",
            "Регламент": {
               "Идентификатор": "8861254e-4354-11e1-9d64-005056a63fed",
               "Название": "Реализация"
            },
            "Редакция": [
               {
                  "Актуален": "Нет",
                  "ДатаВремя": "16.04.2015 09.49.51",
                  "Идентификатор": "c84c4c5c-e404-11e4-9a9c-005056b7595f",
                  "ПримечаниеИС": "РеализацияТоваровУслуг:d258e102-56a0-45c8-8108-c83a6dc610db "
               }
            ],
            "Состояние": {
               "Код": "7",
               "Название": "Выполнение завершено успешно",
               "Описание": "",
               "Примечание": ""
            },
            "СсылкаДляКонтрагент": "https://online.sbis.ru/reg/showdoc.html?params=eyJHVUlEIjoiOTM3Nm",
            "СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=9376c06c-8c90-4e5a",
            "СсылкаНаPDF": "https://online.sbis.ru/service/?method=%D0%A1%D0%B5%D10protocol=3&id=0",
            "СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%D%&protocol=3&id=0",
            "Сумма": "",
            "Тип": "ДокОтгрИсх",
            "Удален": "Нет"
         }
      ],
      "Навигация": {
         "ЕстьЕще": "Нет",
         "РазмерСтраницы": "25",
         "Страница": "0"
      }
   },
   "id": 0
}
Скачать пример