Электронный документооборот

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

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

Команда «СБИС.ПодготовитьДействие» подготавливает документ к переходу на следующий этап документооборота.

В формализованных документах команда заполняет идентификаторы участников документооборота и теги <Отправитель>, <Получатель>, <Подписант>, формирует правильное (по формату) имя файла.

Если требуется, команда формирует извещения о получении и ответные документы.

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

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

Результат

Команда возвращает массив объектов со структурой:

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

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

* — параметр для определения реквизитов при подписании, генерации и модификации документов.

Синий — только для чтения.

Внимание!

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

Комментарий

  1. Алгоритм расчета криптографического хеша для подписываемых файлов определяется по данным сертификата, который зарегистрирован в личном кабинете. Чтобы определить сертификат передайте поле «Отпечаток» в «Документ.Этап.Действие.Сертификат». Если «Отпечаток» отсутствует, криптографический хеш рассчитывается по ГОСТ Р 34.10-2001.
  2. При использовании команды передавайте в запросе идентификатор этапа и идентификатор редакции.
  3. Не используйте адресацию по названию этапов, этот способ не надежен. Он допускает подготовку к этапу неверной редакции — при адресации по идентификатору документа на момент вызова метода может появиться новая редакция документа. Также может возникнуть одноименный этап, если аналогичные этапы были переназначены текущему или другому пользователю.
  4. Вызов команды «СБИС.ПодготовитьДействие» ведет к генерации (перегенерации) служебных документов и ответных титулов. В результате измененные или сгенерированные вложения будут иметь атрибут «Документ.Вложение.Модифицирован» = «Да». Прочие методы модификацию не производят и возвращают «Модифицирован» = «Нет».
  5. Cертификат будет выбран автоматически, если:
    • на вход метода «СБИС.ПодготовитьДействие» не передавались реквизиты подписанта;
    • есть один или несколько доступных серверных неквалифицированных сертификатов;
    • регламент документооборота позволяет использовать подписание неквалифицированными ключами.
  6. Под реквизиты выбранного сертификата будут сгенерированы служебные вложения и внесены изменения в первичные документы. Реквизиты, которые нужно передать в команде «СБИС.ВыполнитьДействие», вернутся в массив «Документ.Этап.Сертификат».
  7. Если у подписанта фамилия, имя или отчество состоит из нескольких раздельных слов, соедините их с помощью символа «_» (нижнее подчеркивание) и передать в поле «Сертификат.ФИО». При дальнейшем использовании символы подчеркивания будут заменены на пробелы.
  8. Поля «Документ.Идентификатор» или «Документ.Редакция.Идентификатор» обязательно должны быть заполнены. При заполнении «Документ.Идентификатор» обрабатывается этап и действия последней редакции. Если заполнено поле «Документ.Редакция.Идентификатор», обарабатывается этап и действия конкретной редакции.

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

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

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

{
   "jsonrpc": "2.0",
   "result": {
      "Идентификатор": "d8e74588-f9e9-4a50-a4f8-82753abc6eb2",
      "Контрагент": {
         "СвЮЛ": {
            "ИНН": "1111681325",
            "КПП": "111101001",
            "КодСтраны": "643",
            "Название": "Тестовый Получатель"
         }
      },
      "Направление": "Исходящий",
      "НашаОрганизация": {
         "СвЮЛ": {
            "ИНН": "1111654353",
            "КПП": "111101001",
            "КодСтраны": "643",
            "Название": "Тестовый Отправитель"
         }
      },
      "Ответственный": {
         "Идентификатор": "",
         "Имя": "Иван",
         "Отчество": "Иванович",
         "Фамилия": "Иванов"
      },
      "Расширение": {},
      "Редакция": [
         {
            "Актуален": "Нет",
            "ДатаВремя": "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%8Cparams=eyLQmNC00J4iOiIzMiIsItCY0LzRj9Ce0LHHQuNGP0JLQvdC10YjQvdC10LPQvtCU0L7QutGD0LzQtdC90YLQsCIsItCf0YDQtdC00YHRgtCw0Ijoi0J%2FRgNC%2B0YHQvNC%2B0YLRgCzQn9C10YfQsNGC0YwiLCLQn9Cw0YDQsNC80biI6ItCd0L7RgNC80LDQu9C40LfQvtCy0LDRgtGMIiwidCI6%0AItCb0L7Qs9C40YfQtdGB0Li0KHQv9C10YbQuNCw0LvQuNC30LDRhtC40Y%2FQodC%2F0L7RgdC%2B0LHQsCIsInQiV0sImQiOlt0cnVlLHsicyI6W3sibiI6ItCY0LTQtdC90YLQuNGE0LjQutCw0YLQvtGA0KHQv9C1030 LDRhtC40LgiLCJ0Ijoi0KHRgtGA0L7QutCwIn1dLCJkIjpbIjExMTE2NTQzNTMsMTExMTAx %CY0LzRj9Cc0LXRgtC%2B0LTQsCI6ItCS0L3QtdGI0L3QuNC50JTQvtC60YPQvNC10L3Rgi7Qnj9Cg0LDRgdC%2F0LXRh9Cw0YLQutC4Iiwi0J%2FQsNGA0LDQvNC10YLRgNGL0JzQtdGC0L4iOiLQmNC00J4iLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1In0seyJuIjoi0JjQvdC9Iiwi2B0LrQsCJ9%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%92PDFparams=eyLQmNC00J4iOiIzMiIsItCY0LzRj9A0YHQuNGP0JLQvdC10YjQvdC10LPQvtCU0L7QutGD0LzQtdC90YLQsCIsItCf0YDQtdC00YHRgtNC1Ijoi0J%2FQtdGH0LDRgtGMLNCf0YDQvtGB0LzQvtGC0YAiLCLQn9Cw0YDQsNC80LXRgtGLzRj9Cc0LXRgtC%2B0LTQsCI6ItCS0L3QtdGI0L3QuNC50JTQ%0AvtC60YPQvNC10L3Rgj9Cg0LDRgdC%2F0LXRh9Cw0YLQutC4Iiwi0J%2FQsNGA0LDQvNC10YLRgNGL0JzQtdGC04iOiLQmNC00J4iLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1In0seyJuIjoi0JjQvdC9Iiwi2B0LrQsCJ9XSwiZCI6WzMyLG51bGxdfX0%3D&protocol=3&id=0",
                  "Сумма": "1026996.48",
                  "Тип": "СчФктр",
                  "Удален": "Нет",
                  "УдаленКонтрагентом": "Нет",
                  "Файл": {
                     "Имя": "ON_SFAKT_1111681325111101001_1111654353111101001_20150417_62 d0-404d-a984-f78eed336d3a.xml ",
                     "Ссылка": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%D18%D0%BD%D0%B5%D0%B3%D0%BE%D0%94%D0%BE%D0BE%D1%85%D1%80%D0%B0%D0%BD%D0%B8%D1%82%D1BBparams=eyLQmNC00J4iOjMyfQ%3D%3D&protocol=3&id=0"
                  }
               }
            ],
            "Действие": [
               {
                  "Комментарий": "",
                  "Название": "Отправить",
                  "ТребуетКомментария": "Нет",
                  "ТребуетПодписания": "Да",
                  "ТребуетРасшифровки": "Нет"
               }
            ],
            "Идентификатор": "",
            "Название": "Отправка",
            "Служебный": "Нет"
         }
      ]
   },
   "id": 0
}
Скачать пример