Присоединяйтесь!

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

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

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

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

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

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

      При отсутствии "ТолькоОтчетность": "Да", запрос возвращает только ЭДО, события отчетности не возвращаются.

    • "ТолькоЭДО": строка «Да»/«Нет»:

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

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

Результат

Результат запроса — массив объектов. За форматирование объектов массива отвечает параметр «Навигация».

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

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

  1. При первом запросе идентификатор события указывать не обязательно, достаточно передать «ДатаВремяС».
  2. Чтобы получить следующую страницу выборки, передайте в запрос «ИдентификаторСобытия» — идентификатор последнего события предыдущей страницы.
  3. Обработайте полученный список. Если он пуст, приостановите запросы на 1-5 минут.
  4. Если вернулась ошибка «Неверный фильтр. Не найдено событие с идентификатором» с кодом «00000000-0000-0000-0000-1FA000010000», значит переданное событие связаный документ удалены. Повторите запрос и укажите дату и время последнего обработанного события.
  5. Сохраните идентификатор, дату и время последнего обработанного события.

Повторяйте эти шаги, для всех страниц результата.

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

Если фильтр «НашаОрганизация» не указан, в ответе вернутся события для всех организаций личного кабинета.

Если в запросе не указан параметр:

  • «ДатаВремяС» — началом периода считается минус один месяц от момента начала выполнения запроса;
  • «ДатаВремяПо» — окончанием периода считается дата и время, когда запрос поступил на сервер минус одна минута.

Входящий документ нужно определять и фиксировать в вашей системе, если в ответе получено событие «Получение».

Если внешний документооборот ведется между организациями в одном аккаунте, необходимо во все запросы передавать поле «НашаОрганизация». Иначе произойдет зацикливание или пропуск событий.

Комментарий

  1. Каждое изменение (событие) возвращается внутри объекта «Документ» («Документ.Событие»), к которому относится.
  2. При изменении документа могут появится новые вложения или подписи к ним. Новые вложения, связанные с событием документооборота, передаются как «Документ.Событие.Вложение». Новые подписи — как «Документ.Событие.Вложение.Подпись».
  3. Если при изменении документа к вложению добавлена только подпись, то поле «Файл.Ссылка» у «Документ.Вложение.Файл.Ссылка» будет пустым. Чтобы скачать подпись, используйте адрес из поля «Документ.Событие.Вложение.Подпись.Файл.Ссылка».
  4. В поле «Документ.Вложение.Файл.Ссылка» возвращается ссылка на вложение, связанное с этим событием. Например, для события «Утверждение» вернется ссылка на служебное вложение «Уведомление о приеме электронного документа».
  5. Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке «HTTP 403 Forbidden».
  6. Чтобы отслеживать состояние обработки документа с маркированным товаром в ГИС МТ, в запросе передайте в параметре «ДопПоля» значение «Расширение».
  7. Для значения параметра «ИдентификаторСобытия» определяется дата и время события. Если указан параметр «ДатаВремяС», из двух значений выбирается то, которое ближе к настоящему моменту.
  8. В результат не попадают документы-черновики, которые не участвовали в документообороте.
  9. Не используйте команду «СБИС.ПрочитатьДокумент» для получения расширенной информации о документе или событии. Вся необходимая информация передается в результате вызова объекта «Документ».
  10. Чтобы ускорить работу списочных методов в несколько раз, в запросе фильтра используйте параметр «ПолныйСертификатЭП»=«Нет».
  11. Если отправитель и получатель документа работают в одном аккаунте, то при использовании поля «Фильтр.ИдентификаторСобытия» в запрос обязательно передайте «Фильтр.НашаОрганизация». Его можно взять из предыдущего запроса. Иначе можно пропустить событие или получить зацикливание при получении списка событий.

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

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

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

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.