Метод «СБИС.СписокИзменений» возвращает список документов, по которым произошли события документооборота. Если при запуске документооборота произошла ошибка, по документу не сформируются завершенные события. В список входят документы за период из запроса.
Параметры запроса
Адрес запроса: https://online.saby.ru/service/?srv=1
- "Фильтр"*: объект:
- "ИдентификаторСобытия": строка. Идентификатор события, после которого получаем данные. Если участники внешнего документооборота по каким-либо документам находятся в вашем аккаунте, необходимо дополнительно указывать «ИдентификаторДокумента»
- "ИдентификаторДокумента": строка. Идентификатор документа, событие которого передается в параметре «ИдентификаторСобытия»
- "ИдентификаторРедакции": строка. Идентификатор редакции, событие которой передается в параметре «ИдентификаторСобытия»
- "ДатаВремяС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС». Если параметр не указан, началом периода считается минус один месяц от момента начала выполнения запроса
- "ДатаВремяПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС». Если параметр не указан, окончанием периода считается дата и время, когда запрос поступил на сервер минус одна минута
- "Тип": строка, тип документа
- "Регламент": объект:
- "Название": строка, название регламента
- "Идентификатор": строка, идентификатор регламента
- "Подтип": строка, подтип типа документа
- "НашаОрганизация": объект. Если параметр не указан, в ответе вернутся события для всех организаций личного кабинета:
- "СвЮЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "КПП": строка
- "КодФилиала": строка
- "СвФЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "КодФилиала": строка, необязательный
- "СвЮЛ": объект:
- "ДопПоля": строка, может принимать значения:
- «ДополнительныеПоля» — указывается, чтобы получить информацию из дополнительных полей документа;
- «СписокПоДокументу» — указывается, если нужно получить данные по одному документу. Определяется по одному из значений: «ИдентификаторДокумента» или «ИдентификаторРедакции».
Передавайте значения одной строкой через запятую, без пробелов
- "Навигация": объект:
"РазмерСтраницы": строка, задает число записей, которые будут возвращены (допустимые значения — от 1 до 50)
Результат
Результат запроса — массив объектов. За форматирование объектов массива отвечает параметр «Навигация».
- "Документ": массив объектов:
- "Идентификатор": строка
- "Дата": строка в формате «ДД.ММ.ГГГГ»
- "Номер": строка
- "Сумма": строка
- "Название": строка
- "Примечание": строка
- "ДатаВремяСоздания": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
- "Удален": строка «Да»/«Нет»
- "Тип": строка, тип документа
- "Подтип": строка, подтип типа документа
- "Расширение": объект, содержит информацию из дополнительных полей документа:
- "ЗактрытОтИзменений"
- "ОтметкаПлюсом"
- "Направление": строка, допустимое направление документа
- "Состояние": объект:
- "Код": строка, код состояния документа
- "Название": строка
- "Примечание": строка. Комментарий при отклонении, текст ошибки и др.
- "Редакция": массив объектов из одной записи. Содержит информацию о редакции документа:
- "Идентификатор": строка
- "ПримечаниеИС": строка, произвольное примечание информационной системы
- "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время создания редакции
- "НашаОрганизация": объект:
- "СвЮЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "КПП": строка
- "КодФилиала": строка
- "Название": строка
- "СвФЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "Фамилия": строка
- "Имя": строка
- "Отчество": строка
- "СвЮЛ": объект:
- "Контрагент": объект:
- "СвЮЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "КПП": строка
- "Название": строка
- "СвФЛ": объект:
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "Фамилия": строка
- "Имя": строка
- "Отчество": строка
- "СвЮЛ": объект:
- "Ответственный": объект:
- "Фамилия": строка
- "Имя": строка
- "Отчество": строка
- "Идентификатор": строка
- "Событие": объект:
- "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
- "Название": строка, название из списка допустимых событий
- "Идентификатор": строка
- "Комментарий": строка
- "Вложение": массив объектов:
- "Название": строка
- "Служебный": строка «Да»/«Нет»
- "Идентификатор": строка
- "Дата": строка в формате «ДД.ММ.ГГГГ»
- "Номер": строка
- "Сумма": строка
- "Направление": строка, допустимое направление вложения — «Входящий» или «Исходящий»
- "Тип": строка, тип вложения документа
- "Подтип": строка, подтип типа вложения
- "ВерсияФормата": строка
- "Редакция": объект:
- "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
- "Номер": строка, номер редакции, нумерация с 1
- "Файл": объект:
- "Имя": строка
- "Ссылка": строка
- "Подпись": массив объектов:
- "Сертификат": объект, реквизиты владельца сертификата ЭП. Объект возвращается не во всех вызовах:
- "ФИО": строка, подписант
- "Должность": строка
- "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
- "Название": строка, название организации
- "Доверенность": объект, информация о доверенности:
- "ВнутрНомер": строка, порядковый номер доверенности
- "ДействительнаС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия доверенности
- "ДействительнаПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия доверенности
- "ИННДоверителя": строка
- "ИдентификаторВПакете": строка
- "ИдентификаторМЧД": строка, 36-разрядный GUID из имени файла
- "СистемаХраненияМЧД": строка, URL, где зарегистрирована МЧД
- "Статус": строка, статус МЧД. Возможные значения: «НеИзвестен», «Действует», «Истекла», «Отозвана», «Недействительна»
- "Сертификат": объект, реквизиты владельца сертификата ЭП. Объект возвращается не во всех вызовах:
- "Навигация": объект:
- "РазмерСтраницы": строка, целочисленное значение. Указывает размер запрошенной выборки
- "ЕстьЕще": строка «Да»/«Нет»
Порядок работы с командой
- При первом запросе идентификатор события указывать не обязательно, достаточно передать «ДатаВремяС».
- Чтобы получить следующую страницу выборки, в параметре «ИдентификаторСобытия» передайте идентификатор последнего события предыдущей страницы. Если участники внешнего документооборота по вашим документам находятся в одном и том же аккаунте, укажите «ИдентификаторДокумента».
- Обработайте полученный список. Если он пуст, приостановите запросы на 1-5 минут.
- Если вернулась ошибка «Неверный фильтр. Не найдено событие с идентификатором» с кодом «00000000-0000-0000-0000-1FA000010000», значит, переданное событие и связанный документ удалены. Повторите запрос и укажите дату и время последнего обработанного события.
- Сохраните идентификатор, дату и время, идентификатор документа последнего обработанного события.
Повторяйте эти шаги для всех страниц результата.
Комментарий
- Каждое изменение (событие) возвращается внутри объекта «Документ» («Документ.Событие»), к которому относится.
- Входящий документ нужно определять и фиксировать во внешней системе, если в ответе получено событие «Получение».
- При изменении документа могут появиться новые вложения или подписи к ним. Новые вложения, связанные с событием документооборота, передаются как «Документ.Событие.Вложение». Новые подписи — как «Документ.Событие.Вложение.Подпись».
- Если при изменении документа к вложению добавлена только подпись, то поле «Файл.Ссылка» у «Документ.Вложение.Файл.Ссылка» будет пустым. Чтобы скачать подпись, используйте адрес из поля «Документ.Событие.Вложение.Подпись.Файл.Ссылка».
- В поле «Документ.Вложение.Файл.Ссылка» возвращается ссылка на вложение, связанное с этим событием. Например, для события «Утверждение» вернется ссылка на служебное вложение «Уведомление о приеме электронного документа».
- Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке «HTTP 403 Forbidden».
- Чтобы отслеживать состояние обработки документа с маркированным товаром в ГИС МТ, в запросе передайте в параметре «ДопПоля» значение «Расширение». В результате вернется объект «СостояниеМарк» с полями «КодОперации», «Операция», «КодСостоянияОперации» и «СостояниеОперации». Возможные значения
- Для значения параметра «ИдентификаторСобытия» определяется дата и время события. Если указан параметр «ДатаВремяС», из двух значений выбирается то, которое ближе к настоящему моменту.
- В результат не попадают документы-черновики, которые не участвовали в документообороте.
- Не используйте команду «СБИС.ПрочитатьДокумент» для получения расширенной информации о документе или событии. Вся необходимая информация передается в результате вызова объекта «Документ».
- Чтобы ускорить работу списочных методов в несколько раз, в запросе фильтра используйте параметр «ПолныйСертификатЭП»=«Нет».
- Если отправитель и получатель документа работают в одном аккаунте, то при использовании поля «Фильтр.ИдентификаторСобытия» в запрос обязательно передайте «Фильтр.НашаОрганизация». Его можно взять из предыдущего запроса. Иначе можно пропустить событие или получить зацикливание при получении списка событий.
Примеры
Список изменений с фильтром по идентификатору события
Список изменений с фильтром по дате
Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.