СБИС.СПИСОКИЗМЕНЕНИЙ

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

В качестве параметров фильтра указывается период времени, типа документа, реквизиты «нашей организации», идентификатора последнего обработанного события (из прежнего запроса) и другие.

Результат запроса представляет массив объектов, за форматирование которых отвечает параметр "Навигация".

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

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

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

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

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

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

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

  1. Получить список событий за интересующий период и/или для "нашей организации", передав сохранённый идентификатор последнего обработанного события;
  2. Если список пуст, приостановить запросы на 1…5 минут, в противном случае — обработать полученный список;
  3. Сохранить идентификатор и дату/время последнего обработанного события;
  4. Повторить с шага 1.

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

  • При первом запросе идентификатор события указывать не обязательно.
  • В случае отсутствия фильтра «Наша организация» в результате запроса возвращаются события для всех организаций кабинета.
  • При отсутствии параметра:
    • "ДатаВремяС" дата и время берётся с самого первого зарегистрированного в системе события.
    • "ДатаВремяПо" берётся текущая дата и время запроса на сервере.
  • Входящий документ следует определять и фиксировать в своей информационной системе при получении события с названием "Получение".
  • В случае, когда событие с переданным идентификатором отсутствует (например, из-за удаления документа), будет возвращена ошибка входных параметров (код 00000000-0000-0000-0000-1FA000010000) - необходимо повторить запрос с указанием сохранённой даты/времени последнего обработанного события.

Комментарий

  • Для унификации форматов данных каждое изменение (событие) возвращается "внутри" объекта «Документ» (Документ.Событие), к которому относится.
  • Изменение в документообороте может сопровождаться появлением вложений и/или подписей под вложениями. Новые вложения, связанные с событием документооборота, передаются как «Документ.Событие.Вложение», новые подписи – «Документ.Событие.Вложение.Подпись».
  • Если в результате изменения к вложению документа добавлена только подпись, то поле «Файл.Ссылка» у «Документ.Вложение.Файл.Ссылка» будет пустым. Скачивание подписи выполняется по «Документ.Событие.Вложение.Подпись.Файл.Ссылка».
  • Для переданного во входных параметрах значения поля «ИдентификаторСобытия» определяется дата/время события (берётся в качестве параметра фильтрации "ДатаВремяС"). При наличии "ДатаВремяС" выбирается наиболее "старое".

  • Документы-черновики, которые не участвовали в документообороте, в вывод метода не попадают.
  • Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала». 
  • Запрещается пользоваться командой «СБИС.ПрочитатьДокумент» для получения расширенной информации о документе или событии, так как  вся необходимая информация передаётся в результате вызова объекта «Документ».
  • Для ускорения работы списочных методов (2-10 раз) в запросе в фильтре необходимо передавать дополнительный (необязательный) параметр "ПолныйСертификатЭП" со значением "Нет".
  • Если отправитель и получатель документа работают в одном аккаунте, то при использовании поля Фильтр.ИдентификаторСобытия в запрос обязательно необходимо передавать Фильтр.НашаОрганизация, полученного из предыдущего запроса. В противном случае, возможен пропуск событий или зацикливание при получении списка событий.

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

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

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

{
  "jsonrpc" : "2.0",
  "method" : "СБИС.СписокИзменений",
  "params" :
  {
    "Фильтр" :
    {
      "ИдентификаторСобытия" : "589f1354-8081-4dfe-9427-e68ba66dc5c6",
      "НашаОрганизация" :
      {
        "СвЮЛ" :
        {
          "ИНН" : "1111654353",
          "КПП" : "111101001"
        }
      },
      "ПолныйСертификатЭП" : "Нет"
    }
  },
  "id" : 0
}

Скачать пример

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

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

Скачать пример

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

{
"jsonrpc": "2.0",
"result": {
	"Документ": [{
		"Дата": "16.04.2015",
		"ДатаВремяСоздания": "16.04.2015 09.30.30",
		"Идентификатор": "754e2900-233c-454d-9a03-3fc810bfe943",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
	"Название": "Реализация № 914278091 от 16.04.2015",
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
					"Название": "Тестовый Отправитель"
			}
		},
		"Номер": "914278091",
		"Ответственный": {
			"Идентификатор": "",
			"Имя": "Иван",
			"Отчество": "Иванович",
			"Фамилия": "Иванов"
		},
		"Примечание": "Здесь обычно указывают примечание",
		"Расширение": {},
		"Редакция": [{
			"Актуален": "Да",
			"ДатаВремя": "16.04.2015 09.30.30",
			"Идентификатор": "143bf430-e402-11e4-85c4-005056b7595f",
			"ПримечаниеИС": "РеализацияТоваровУслуг:53ff6826-fd50-4f4f-ae3e-16da5cdc19b8"
		}],
		"Событие": [{
			"Вложение": [{
				"ВерсияФормата": "5.02",
				"Дата": "16.04.2015",
				"Идентификатор": "934b0e91-e480-4b7d-9265-cdb4a8e6a823",
				"Модифицирован": "Нет",
				"Название": "Фактура № 914278091 от 16.04.15 на сумму 818 221.44р., без НДС",
				"Направление": "Исходящий",
				"Номер": "914278091",
				"Подпись": [{
					"Сертификат": {
						"Должность": "Директор",
						"Название": "ООО Газпром",
						"ФИО": "Иванов Иван Иванович"
					}
				}],
				"Подтип": "1115101",
				"Редакция": {
					"ДатаВремя": "16.04.2015 09.30.31",
					"Номер": "1"
				},
 
				"Служебный": "Нет",
				"СсылкаНаHTML": "https://online.sbis.ru/service/?method=%D0%A4%protocol=3&id=0",
				"Сумма": "818221.44",
				"Тип": "СчФктр",
				"Удален": "Нет",
				"УдаленКонтрагентом": "Нет",
				"Файл": {
					"Имя": "ON_SFAKT_2BE_73c9b640 - 83 b8 - 4 c9e - bc27 - c59b179f0247.xml ",
					"Ссылка": "https://online.sbis.ru/service/?method=%D0%jF9&protocol=3&id=0"
				}
			}],
			"ДатаВремя": "16.04.2015 09.31.09",
			"ДатаВремяДокумента": "",
			"Идентификатор": "21e73f07-6ac1-4666-841b-07c1ee5e2b7f",
			"Комментарий": "",
			"Название": "Отправка"
		}],
		"Состояние": {
			"Код": "22",
			"Название": "Аннулирован по соглашению",
			"Описание": "",
			"Примечание": ""
		},
		"СсылкаДляКонтрагент": "https://online.sbis.ru/reg/showdoc.html?params=ey9",
		"СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=22be9de11f0b066",
		"СсылкаНаPDF": "",
		"СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B9&protocol=3&id=0",
		"Сумма": "",
		"Тип": "ДокОтгрИсх",
		"Удален": "Нет"
	}, {
		"Дата": "16.04.2015",
		"ДатаВремяСоздания": "16.04.2015 09.30.30",
		"Идентификатор": "754e2900-233c-454d-9a03-3fc810bfe943",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
		"Название": "Реализация № 914278091 от 16.04.2015",
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
				"Название": "Тестовый Отправитель"
			}
		},
		"Номер": "914278091",
		"Ответственный": {
			"Идентификатор": "",
			"Имя": "Иван",
			"Отчество": "Иванович",
			"Фамилия": "Иванов"
		},
		"Примечание": "Здесь обычно указывают примечание",
		"Расширение": {},
		"Редакция": [{
			"Актуален": "Да",
			"ДатаВремя": "16.04.2015 09.30.30",
			"Идентификатор": "143bf430-e402-11e4-85c4-005056b7595f",
			"ПримечаниеИС": "РеализацияТоваровУслуг:53ff6826-fd50-4f4f-ae3e-16da5cdc19b8"
		}],
		"Событие": [{
			"Вложение": [{
				"ВерсияФормата": "1.01",
				"Дата": "16.04.2015",
				"Идентификатор": "add337b0-fecd-41b4-88a9-61d7ef10cf91",
				"Модифицирован": "Нет",
				"Название": "Подтверждение получения электронного документа оператором",
				"Направление": "Входящий",
				"Номер": "",
				"Подпись": [{
					"Файл": {
						"Имя": "DP_PDPOL_2BE05137033074f-820 a87d78bce.xml.p7s ",
						"Ссылка": "https://online.sbis.ru/service/?method=protocol=3&id=0"
					}
				}],
				"Подтип": "1115112",
				"Редакция": {
					"ДатаВремя": "16.04.2015 09.31.09",
					"Номер": "1"
				},
				"Служебный": "Да",
				"СсылкаНаHTML": "https://online.sbis.ru/service/?method=%D0%A4%D%&protocol=3&id=0",
				"Сумма": "",
				"Тип": "ПодтвДатПол",
				"Удален": "Нет",
				"УдаленКонтрагентом": "Нет",
				"Файл": {
					"Имя": "DP_PDPOL_2BE0513703307404e8bbd67a60db6e9b35e_26820 a87d78bce.xml ",
					"Ссылка": "https://online.sbis.ru/service/?method=%D0&protocol=3&id=0"
				}
			}],
			"ДатаВремя": "16.04.2015 09.31.09",
			"ДатаВремяДокумента": "16.04.2015 09.31.07",
			"Идентификатор": "91a6ccb5-e712-4910-adae-ef7d41a3d013",
			"Комментарий": "",
			"Название": "Подтверждение даты получения"
		}],
		"Состояние": {
			"Код": "22",
			"Название": "Аннулирован по соглашению",
			"Описание": "",
			"Примечание": ""
		},
		"СсылкаДляКонтрагент": "https://online.sbis.ru/reg/showdoc.html?params=eyJHVUlEIjoiMjJixZjBJ9",
		"СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=22be9dfee7f1-49c2-a5ee6",
		"СсылкаНаPDF": "",
		"СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D&protocol=3&id=0",
		"Сумма": "",
		"Тип": "ДокОтгрИсх",
		"Удален": "Нет"
	}, {
		"Дата": "16.04.2015",
		"ДатаВремяСоздания": "16.04.2015 09.30.59",
		"Идентификатор": "80f97a99-2112-47e0-9b21-9a739e6435de",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
		"Название": "Реализация № 702540559 от 16.04.2015",
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
				"Название": "Тестовый Отправитель"
			}
		},
		"Номер": "702540559",
		"Ответственный": {
			"Идентификатор": "",
			"Имя": "Иван",
			"Отчество": "Иванович",
			"Фамилия": "Иванов"
		},
		"Примечание": "Здесь обычно указывают примечание",
		"Расширение": {},
		"Редакция": [{
			"Актуален": "Да",
			"ДатаВремя": "16.04.2015 09.30.59",
			"Идентификатор": "263a8fac-e402-11e4-b056-005056b7595f",
			"ПримечаниеИС": "РеализацияТоваровУслуг:410575bc-740c-4750-9ea9-936bf7de578e"
		}],
		"Событие": [{
			"Вложение": [{
				"ВерсияФормата": "5.02",
				"Дата": "16.04.2015",
				"Идентификатор": "b4f6bb4d-6b0c-4740-a4c6-b7e944ea681d",
				"Модифицирован": "Нет",
				"Название": "Фактура № 702540559 от 16.04.15 на сумму 761.10р., без НДС",
				"Направление": "Исходящий",
				"Номер": "702540559",
				"Подпись": [{
					"Файл": {
						"Имя": "ON_SFAKT_2BE2fcd24b771284d7997df1-9a0fea7a9379.xml.p7s",
						"Ссылка": "https://online.sbis.ru/service/?method=protocol=3&id=0"
					}
				}],
				"Подтип": "1115101",
				"Редакция": {
					"ДатаВремя": "16.04.2015 09.31.02",
					"Номер": "1"
				},
				"Служебный": "Нет",
				"СсылкаНаHTML": "https://online.sbis.ru/service/?method=%D0%A4%&protocol=3&id=0",
				"Сумма": "761.10",
				"Тип": "СчФктр",
				"Удален": "Нет",
				"УдаленКонтрагентом": "Нет",
				"Файл": {
					"Имя": "ON_SFAKT_2BE2fcd24b771284d799379.xml",
					"Ссылка": "https://online.sbis.ru/service/?method=%D0%9&protocol=3&id=0"
				}
			}],
			"ДатаВремя": "16.04.2015 09.31.12",
			"ДатаВремяДокумента": "",
			"Идентификатор": "96ccf847-eddd-4b50-9a25-50262c4a691d",
			"Комментарий": "",
			"Название": "Отправка"
		}],
		"Состояние": {
			"Код": "7",
			"Название": "Выполнение завершено успешно",
			"Описание": "",
			"Примечание": ""
		},
		"СсылкаДляКонтрагент": "https://online.sbis.ru/reg/showdoc.html?params=eyJHVUlEIjoiYjSJ9",
		"СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=b4427127-54659c ",
		"СсылкаНаPDF": "",
		"СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%jN9&protocol=3&id=0",
		"Сумма": "",
		"Тип": "ДокОтгрИсх",
		"Удален": "Нет"
	}, {
		"Дата": "16.04.2015",
		"ДатаВремяСоздания": "16.04.2015 09.30.59",
		"Идентификатор": "80f97a99-2112-47e0-9b21-9a739e6435de",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
		"Название": "Реализация № 702540559 от 16.04.2015",
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
				"Название": "Тестовый Отправитель"
			}
		},
		"Номер": "702540559",
		"Ответственный": {
			"Идентификатор": "",
			"Имя": "Иван",
			"Отчество": "Иванович",
			"Фамилия": "Иванов"
		},
		"Примечание": "Здесь обычно указывают примечание",
		"Расширение": {},
		"Редакция": [{
			"Актуален": "Да",
			"ДатаВремя": "16.04.2015 09.30.59",
			"Идентификатор": "263a8fac-e402-11e4-b056-005056b7595f",
			"ПримечаниеИС": "РеализацияТоваровУслуг:410575bc-740c-4750-9ea9-936bf7de578e"
		}],
		"Событие": [{
			"Вложение": [{
				"ВерсияФормата": "1.01",
				"Дата": "16.04.2015",
				"Идентификатор": "badc0475-083c-4ef4-91b4-b5277f18d8a4",
				"Модифицирован": "Нет",
				"Название": "Подтверждение получения электронного документа оператором",
				"Направление": "Входящий",
				"Номер": "",
				"Подпись": [{
					"Файл": {
						"Имя": "DP_PDPOL_2BE0513703307404e8bbab2",
						"Ссылка": "https://online.sbis.ru/service/?protocol=3&id=0"
					}
				}],
				"Подтип": "1115112",
				"Редакция": {
					"ДатаВремя": "16.04.2015 09.31.13",
					"Номер": "1"
				},
				"Служебный": "Да",
				"СсылкаНаHTML": "https://online.sbis.ru/service/?method=%D&protocol=3&id=0",
				"СсылкаНаPDF": "https://online.sbis.ru/service/?method=%protocol=3&id=0",
				"Сумма": "",
				"Тип": "ПодтвДатПол",
				"Удален": "Нет",
				"УдаленКонтрагентом": "Нет",
				"Файл": {
					"Имя": "DP_PDPOL_2BE0513703307404e8bbd67a60db6e9b35e_17834 c9840e4.xml ",
					"Ссылка": "https://online.sbis.ru/service/?method=%D0&protocol=3&id=0"
				}
			}],
			"ДатаВремя": "16.04.2015 09.31.13",
			"ДатаВремяДокумента": "16.04.2015 09.31.12",
			"Идентификатор": "6a4866fa-c44d-4482-8ab2-98071bb0ace4",
			"Комментарий": "",
			"Название": "Подтверждение даты получения"
		}],
		"Состояние": {
			"Код": "7",
			"Название": "Выполнение завершено успешно",
			"Описание": "",
			"Примечание": ""
		},
		"СсылкаДляКонтрагент": "https://online.sbis.ru/reg/showdoc.html?params=eyJHVUlEIjoiYjQ0MjcxjNJ9",
		"СсылкаДляНашаОрганизация": "https://fix-online.sbis.ru/opendoc.html?guid=b4427127-e652-43b4-659c",
		"СсылкаНаPDF": "",
		"СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%D1%80&protocol=3&id=0",
		"Сумма": "",
		"Тип": "ДокОтгрИсх",
		"Удален": "Нет"
	}],
	"Навигация": {
		"ЕстьЕще": "Да",
		"РазмерСтраницы": "25"
	}
},
"id": 0
}

Скачать пример

 

1
1
Оставьте свой отзыв:
ОТПРАВИТЬ