СБИС.ПОДГОТОВИТЬДЕЙСТВИЕ

СБИС.ПодготовитьДействие

Команда СБИС.ПодготовитьДействие подготавливает документ к выполнению перехода на следующий этап документооборота: в формализованных документах заполняет идентификаторы участников документооборота и теги <Отправитель>, <Получатель>, <Подписант>, формирует правильное (по формату) имя файла, если требуется, генерирует извещения о получении и ответные документы.

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

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

  • "Документ": объект:
  • "Этап"*: объект:
    • "Название"*: строка, обязательна при обработке служебного этапа
    • "Идентификатор"*: строка, обязательна для всех этапов. Может быть пустым для действия "Отправить" этапа "Отправка"
    • "Действие"*: объект
      • "Название"*: строка, список допустимых значений
      • "Комментарий"*: строка, обязательна не для всех действий
      • "Сертификат": объект
        • "ФИО"*: строка
        • "Должность"*: строка
        • "ИНН"*: строка
        • "Название": строка
        • "Отпечаток": строка

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

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

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

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

Внимание!

В результатах вызова метода СБИС.ПодготовитьДействие поле с криптографическим хешем (Вложение.Файл.Хеш) возвращается только для тех вложений, которые изменены и требуют подписания.

Комментарий

При адресации по идентификатору документа и использовании команд, отличных от подготовки к отправке документа, необходимо передать значение поля:

  • "Документ.Этап.Идентификатор", полученное в результате вызова функции, например, СБИС.ЗаписатьДокумент.
  • либо "Документ.Этап.Название". Данный способ ненадёжен, так как допускает подготовку к неверному этапу (в случае отправки новой редакции документа и при попытке подготовки этапа по предыдущей).

Вызов функции СБИС.ПодготовитьДействие ведёт к генерации (перегенерации) служебных документов и/или ответных титулов. Вложения, изменённые или сгенерированные в результате вызова СБИС.ЗаписатьДокумент, имеют атрибут Документ.Вложение.Модифицирован="Да". Прочие методы модификацию не производят и возвращают Модифицирован="Нет".

Если на вход функции СБИС.ПодготовитьДействие не передавались реквизиты подписанта и при этом есть один/несколько доступных сертификатов, то сертификат будет выбран автоматически. Под реквизиты выбранного сертификата будут сгенерированы служебные вложения и/или внесены изменения в первичные документы. Реквизиты сертификата будут возвращены в Документ.Этап.Сертификат, которые необходимо передать в команде СБИС.ВыполнитьДействие.

Если у подписанта фамилия, имя и/или отчество состоит из нескольких раздельных слов, следует «соединить» их с помощью символа «_» (нижнее подчеркивание) и передать в поле "Сертификат.ФИО". При дальнейшем использовании символы подчеркивания будут заменены на пробелы.

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

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

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

{
	"jsonrpc": "2.0",
	"method": "СБИС.ПодготовитьДействие",
	"params": {
		"Документ": {
			"Идентификатор": "d8e74588-f9e9-4a50-a4f8-82753abc6eb2",
			"Этап": {
				"Действие": {
					"Название": "Отправить",
					"Сертификат": {
						"Должность": "для тестовых запросов",
						"ИНН": "1111654353",
						"Название": "Тестовый Отправитель",
						"ФИО": "Иванов Иван Иванович"
					}
				},
				"Название": "Отправка"
			}
		}
	},
	"id": 0
}

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

Пример ответа (успех)

{
	"jsonrpc": "2.0",
	"result": {
		"Идентификатор": "d8e74588-f9e9-4a50-a4f8-82753abc6eb2",
		"Контрагент": {
			"Email": "",
			"СвЮЛ": {
				"ИНН": "1111681325",
				"КПП": "111101001",
				"Название": "Тестовый Получатель"
			},
			"Телефон": ""
		},
		"Направление": "Исходящий",
		"НашаОрганизация": {
			"СвЮЛ": {
				"ИНН": "1111654353",
				"КПП": "111101001",
				"Название": "Тестовый Отправитель"
			}
		},
		"Ответственный": {
			"Идентификатор": "",
			"Имя": "Иван",
			"Отчество": "Иванович",
			"Фамилия": "Иванов"
		},
		"Расширение": {},
		"Редакция": [{
			"Актуален": "Нет",
			"ДатаВремя": "17.04.2015 13.19.57",
			"Идентификатор": "4c144cf6-e4eb-11e4-be23-005056b7595f",
			"ПримечаниеИС": "РеализацияТоваровУслуг:8bf669c4-042e-4854-b21b-673e8067e83e"
		}],
		"Этап": [{
			"Вложение": [{
				"ВерсияФормата": "5.02",
				"Дата": "17.04.2015",
				"Идентификатор": "8b8d54e2-44ae-4de3-8433-f4a7c86c2c5d",
				"Модифицирован": "Да",
				"Название": "Фактура № 829766305 от 17.04.15 на сумму 1 026 996.48р., без НДС",
				"Направление": "Исходящий",
				"Номер": "829766305",
				"Подтип": "1115101",
				"Редакция": {
					"ДатаВремя": "17.04.2015 13.19.57",
					"Номер": "1"
				},
				"Служебный": "Нет",
				"СсылкаНаHTML": "https://online.sbis.ru/service/?method=%D0%A4%D0%AD%D0%94.
				B7%D0%B8%D1%82%D1%8C¶ms=eyLQmNC00J4iOiIzMiIsItCY0LzRj9Ce0LH
				HQuNGP0JLQvdC10YjQvdC10LPQvtCU0L7QutGD0LzQtdC90YLQsCIsItCf0YDQtdC00YHRgtCw0
				Ijoi0J%2FRgNC%2B0YHQvNC%2B0YLRgCzQn9C10YfQsNGC0YwiLCLQn9Cw0YDQsNC80
				biI6ItCd0L7RgNC80LDQu9C40LfQvtCy0LDRgtGMIiwidCI6%0AItCb0L7Qs9C40YfQtdGB0L
				i0KHQv9C10YbQuNCw0LvQuNC30LDRhtC40Y%2FQodC%2F0L7RgdC%2B0LHQsCIsInQi
				V0sImQiOlt0cnVlLHsicyI6W3sibiI6ItCY0LTQtdC90YLQuNGE0LjQutCw0YLQvtGA0KHQv9C10
				30 LDRhtC40LgiLCJ0Ijoi0KHRgtGA0L7QutCwIn1dLCJkIjpbIjExMTE2NTQzNTMsMTExMTAx %
				CY0LzRj9Cc0LXRgtC%2B0LTQsCI6ItCS0L3QtdGI0L3QuNC50JTQvtC60YPQvNC10L3Rgi7Qn
				j9Cg0LDRgdC%2F0LXRh9Cw0YLQutC4Iiwi0J%2FQsNGA0LDQvNC10YLRgNGL0JzQtdGC0L
				4iOiLQmNC00J4iLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1In0seyJuIjoi0JjQvdC9Iiwi
				2B0LrQsCJ9%0AXSwiZCI6WzMyLG51bGxdfX0%3D&protocol=3&id=0",
				"СсылкаНаPDF":"https://online.sbis.ru/service/?method=%D0%A4%D0%AD%D0%94.
				B8%D1%82%D1%8C%D0%92PDF¶ms=eyLQmNC00J4iOiIzMiIsItCY0LzRj9
				A0YHQuNGP0JLQvdC10YjQvdC10LPQvtCU0L7QutGD0LzQtdC90YLQsCIsItCf0YDQtdC00YHRgt
				NC1Ijoi0J%2FQtdGH0LDRgtGMLNCf0YDQvtGB0LzQvtGC0YAiLCLQn9Cw0YDQsNC80LXRgtG
				LzRj9Cc0LXRgtC%2B0LTQsCI6ItCS0L3QtdGI0L3QuNC50JTQ%0AvtC60YPQvNC10L3Rg
				j9Cg0LDRgdC%2F0LXRh9Cw0YLQutC4Iiwi0J%2FQsNGA0LDQvNC10YLRgNGL0JzQtdGC0
				4iOiLQmNC00J4iLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1In0seyJuIjoi0JjQvdC9Iiwi
				2B0LrQsCJ9XSwiZCI6WzMyLG51bGxdfX0%3D&protocol=3&id=0",
				"Сумма":"1026996.48",
				"Тип": "СчФктр",
				"Удален": "Нет",
				"УдаленКонтрагентом": "Нет",
				"Файл": {
					"Имя": "ON_SFAKT_1111681325111101001_1111654353111101001_20150417_
					62 d0 - 404 d - a984 - f78eed336d3a.xml ",
					"Ссылка":"https://online.sbis.ru/service/?method=%D0%92%D0%B5%D1
					8%D0%BD%D0%B5%D0%B3%D0%BE%D0%94%D0%BE%D0
					BE%D1%85%D1%80%D0%B0%D0%BD%D0%B8%D1%82%D1
					BB¶ms=eyLQmNC00J4iOjMyfQ%3D%3D&protocol=3&id=0"
				}
			}],
			"Действие": [{
				"Комментарий": "",
				"Название": "Отправить",
				"ТребуетКомментария": "Нет",
				"ТребуетПодписания": "Да",
				"ТребуетРасшифровки": "Нет"
			}],
			"Идентификатор": "",
			"Название": "Отправка",
			"Служебный": "Нет"
		}]
	},
	"id": 0
}

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

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