СБИС.СПИСОКДОКУМЕНТОВ

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

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

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

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

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

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

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

Синие — поля, доступные только для чтения (т.е. в возвращаемых значениях).

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

Комментарий

Поле «Состояние» входного фильтра может содержать как перечисляемые значения из «Состояния документа», так и специфичные для метода СБИС.СписокДокументов значения:

  • Неотправленные (только для исходящих)
  • Недоставленные (только для исходящих)
  • Не получен ответ (только для исходящих)
  • Утвержденные
  • Отклоненные
  • С ошибками
  • Требующие ответа (только для входящих)
  • Незакрепленные
  • Удаленные

Если указано значение, которое отмечено — «только для входящих/исходящих», то при отсутствии указания параметра «Направление» в фильтре, оно будет назначено автоматически. Если же направление явно указано, и оно не совпадает с разрешённым направлением указанного состояния, будет возвращена ошибка.

В результаты запроса попадают документы в состоянии «черновик».

По умолчанию (без указания в фильтре состояния «Удаленные») в список не попадают удалённые документы.

Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала». 

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

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

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

{
 "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",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
		"Название": "Реализация № 56089268 от 16.04.2015",
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
				"Название": "Тестовый Отправитель"
			}
		},
		"Номер": "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%D10 protocol = 3 & id = 0 ",
		"СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%D% & protocol = 3 & id = 0 ",
		"Сумма": "",
		"Тип": "ДокОтгрИсх",
		"Удален": "Нет"
	}],
	"Навигация": {
		"ЕстьЕще": "Нет",
		"РазмерСтраницы": "25",
		"Страница": "0"
	}
 },
 "id": 0
}

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

 

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