Документооборот с контрагентами

СБИС.ВыполнитьДействие

СБИС.ВыполнитьДействие

Команда «СБИС.ВыполнитьДействие» выполняет указанный переход с выбранного этапа документооборота. Если переход предполагает подписание документов, а ключ находится на носителе, команда предварительно загружает подписи к вложениям.

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

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

  • "Документ": объект:
    • "Идентификатор"*: строка
    • Редакция": объект:
      • "Идентификатор"*: строка
    • "Этап"*: объект:
      • "Исполнитель": объект:
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
        • "Идентификатор": строка, табельный номер (идентификатор)
      • "Подразделение": объект:
        • "Название": строка, название подразделения
        • "Идентификатор": строка, код подразделения
      • "Название"**: строка, необязательна для некоторых этапов
      • "Идентификатор"**: строка, необязательна для некоторых этапов "Отправка"
      • "Действие"*: массив из одного объекта:
        • "Название"*: строка
        • "Комментарий"**: строка, обязательна, если требуется указать комментарий
        • "Сертификат": объект. При серверном или отложенном подписании указывает на требуемый сертификат:
          • "Отпечаток": строка, используется как фильтр для поиска сертификата
          • "Ключ": объект
          • ...
        • "СледующийЭтап": массив объектов, задает исполнителей для следующих этапов:
          • "Идентификатор": строка, идентификатор этапа
          • "Название": строка, название этапа
          • "Исполнитель": массив объектов, задает исполнителей — конкретных сотрудников или подразделения:
            • "Сотрудник": объект:
              • "Идентификатор": строка, идентификатор сотрудника
              • "Фамилия": строка
              • "Имя": строка
              • "Отчество": строка
            • "Подразделение": объект:
              • "Идентификатор": строка, идентификатор подразделения
              • "Название": строка, название подразделения
      • "Вложение": массив объектов:
        • "Идентификатор": строка
        • "Файл": объект:
          • "Имя": строка
          • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные».
          • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка».
        • "Подпись": массив объектов:
          • "Файл": объект
            • "Имя": строка
            • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные».
            • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка».

Результат

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

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

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

* — при использовании для подписания отложенного сертификата нужно передать запрос в поле «Сертификат.Ключ.Тип» и указать тип сертификата: «Отложенный» или «ОтложенныйСПодтверждением».

Комментарий

Выполнение команды «СБИС.ВыполнитьДействие» при подписании подразумевает:

  • предварительный вызов «СБИС.ПодготовитьДействие»;
  • обязательную передачу информации о сертификате для подписания ЭП (объект «Этап.Действие.Сертификат»).

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

В запросе команды должно быть заполнено поле «Документ.Идентификатор» или «Документ.Редакция.Идентификатор». При заполненном «Документ.Идентификатор» обрабатывается этап и действия последней редакции. Если заполнено поле «Документ.Редакция.Идентификатор», то обрабатывается этап и действия конкретной редакции.

В команде мы рекомендуем передавать идентификатор этапа и идентификатор редакции.

Не используйте адресацию по названию этапов. При использовании такой адресации к этапу может быть подготовлена:

  • неверная редакция документа — при адресации по идентификатору документа на момент вызова метода может появиться новая редакция документа;
  • одноименный этап — если одноименные этапы были переназначены текущему или другому пользователю.

Если для подписания документа используется ЭП на носителе, исключите отправку прочих входящих в формат полей, за исключением поля «Подпись».

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

  • при отправке новой редакции документа;
  • попытке подготовки этапа по предыдущей редакции.

В команде можно передавать новые неслужебные вложения. Для этого добавьте их к массиву «Этап.Вложение». При локальном подписании одновременно можно приложить электронные подписи.

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

{
   "jsonrpc": "2.0",
   "method": "СБИС.ВыполнитьДействие",
   "params": {
      "Документ": {
         "Идентификатор": "d8e74588-f9e9-4a50-a4f8-82753abc6eb2",
         "Этап": {
            "Вложение": [
               {
                  "Идентификатор": "8b8d54e2-44ae-4de3-8433-f4a7c86c2c5d",
                  "Подпись": [
                     {
                        "Файл": {
                           "ДвоичныеДанные": "MIIHbgYJKoZIhvcNAQcCoIIHXzCCB1sCAQExDDAKBgYqhQMCAgkFADALBgkqhkiG9w0BBwGgggZEMIIGQDCCBe+gAwIBAgIKf2pSAwABAAAFljAIBgYqhQMCAgMwFzEVMBMGA1UEAxMMQ0EtU0JJUy1URVNUMB4XDTE1MDQxMzA3NTcwMFoXDTE2MDcxMzA4MDcwMFowggHCMRgwFgYFKoUDZAESDTMyNjMyNTI2NjI3MzYxFjAUBgUqhQNkAxILNzQzODg4MzE3NTIxGjAYBggqhQMDgQMBARIMMDAxMTExNjU0MzUzMRswGQYJKoZIhvcNAQkBFgxzdkB0ZW5zb3IucnUxMTAvBgNVBAoeKAQiBDUEQQRCBD4EMgRLBDkAIAQeBEIEPwRABDAEMgQ4BEIENQQ7BEwxCjAIBgNVBAsTATAxMzAxBgNVBAweKgQ0BDsETwAgBEIENQRBBEIEPgQyBEsERQAgBDcEMAQ/BEAEPgRBBD4EMjExMC8GA1UEAx4oBCIENQRBBEIEPgQyBEsEOQAgBB4EQgQ/BEAEMAQyBDgEQgQ1BDsETDEVMBMGA1UEBB4MBBgEMgQwBD0EPgQyMSMwIQYDVQQqHhoEGAQyBDAEPQAgBBgEMgQwBD0EPgQyBDgERzELMAkGA1UEBhMCUlUxGTAXBgNVBAceEAQiBDUEQQRCBD4EMgRLBDkxLzAtBgNVBAgeJgAwADQAIAQgBDUEQQQ/BEMEMQQ7BDgEOgQwACAEEAQ7BEIEMAQ5MRkwFwYDVQQJHhAEIgQ1BEEEQgQ+BDIESwQ5MGMwHAYGKoUDAgITMBIGByqFAwICJAAGByqFAwICHgEDQwAEQDxU0UFOlrffytNIomM7XcMiXDHfAvp8RZL/hZlrm701+9pGarmotcj1eUJMW61aYtitkY5d6H33PJJmyZMhODOjggNsMIIDaDAZBgkqhkiG9w0BCQ8EDDAKMAgGBiqFAwICFTAOBgNVHQ8BAf8EBAMCBPAwcAYDVR0lBGkwZwYHKoUDAgIiGQYHKoUDAgIiGgYHKoUDAgIiBgYIKoUDAzoCAQIGCCqFAwM6AgEEBgcqhQMFAygBBgcqhQMFAzABBgUqhQMGBwYJKwYBBAGB6V8VBggrBgEFBQcDAgYIKwYBBQUHAwQwHQYDVR0gBBYwFDAIBgYqhQNkcQEwCAYGKoUDZHECMB0GA1UdDgQWBBR6EFTEl4PNe/+/X5K7/C6uIIMNdjBOBgNVHSMERzBFgBQNU+u+2MQtt4/N055u4m2A0sqg4qEbpBkwFzEVMBMGA1UEAxMMQ0EtU0JJUy1URVNUghBN8xO6wj2Irk7ginDhEuoMMEMGA1UdHwQ8MDowOKA2oDSGMmh0dHA6Ly9jYS1zYmlzLXRlc3QvY2VydGVucm9sbC9DQS1TQklTLVRFU1QoMSkuY3JsMFsGCCsGAQUFBwEBBE8wTTBLBggrBgEFBQcwAoY/aHR0cDovL2NhLXNiaXMtdGVzdC9jZXJ0ZW5yb2xsL2NhLXNiaXMtdGVzdF9DQS1TQklTLVRFU1QoMSkuY3J0MCsGA1UdEAQkMCKADzIwMTUwNDEzMDc1NzAwWoEPMjAxNjA3MTMwNzU3MDBaMDYGBSqFA2RvBC0MKyLQmtGA0LjQv9GC0L7Qn9GA0L4gQ1NQIiAo0LLQtdGA0YHQuNGPIDMuNikwggEyBgUqhQNkcASCAScwggEjDCsi0JrRgNC40L/RgtC+0J/RgNC+IENTUCIgKNCy0LXRgNGB0LjRjyAzLjYpDFMi0KPQtNC+0YHRgtC+0LLQtdGA0Y/RjtGJ0LjQuSDRhtC10L3RgtGAICLQmtGA0LjQv9GC0L7Qn9GA0L4g0KPQpiIg0LLQtdGA0YHQuNC4IDEuNQxOQ9C10YDRgtC40YTQuNC60LDRgiDRgdC+0L7RgtCy0LXRgtGB0YLQstC40Y8g4oSWINCh0KQvMTIxLTIyNzIg0L7RgiAxMi4xMi4yMDEzDE/QodC10YDRgtC40YTQuNC60LDRgiDRgdC+0L7RgtCy0LXRgtGB0YLQstC40Y8g4oSWINCh0KQvMTI4LTIzNTIg0L7RgiAxNS4wNC4yMDE0MAgGBiqFAwICAwNBAHg/Kg+i5Hhd+VdsMqnmGo8MUqk8hf93uhqWCPXimJKGXRjbGOG+E83lI/uaoqCKWZV5mt53VB46Cee3jrdH+ekxgfIwge8CAQEwJTAXMRUwEwYDVQQDEwxDQS1TQklTLVRFU1QCCn9qUgMAAQAABZYwCgYGKoUDAgIJBQCgaTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0xNTA0MTcxMzIwMDFaMC8GCSqGSIb3DQEJBDEiBCD97AUToH3Rz16lf8o9JtaLDVX23o/EiD50xm7VG90m+zAKBgYqhQMCAhMFAARA/2jq5rpFjUmQ6TqjJWIDjMFcXAycKSXjm+yXYSSc2Nr4D7XiZDcLofOM71GK017cJHErJob/W426udvjbFY25g==",
                           "Имя": "ON_SFAKT_1111681325111101001_1111654353111101001_20150417_0703ba7c-62d0-404d-a984-f78eed336d3a.xml.sgn"
                        }
                     }
                  ]
               }
            ],
            "Действие": [
               {
                  "Комментарий": "",
                  "Название": "Отправить",
                  "Сертификат": {
                     "Отпечаток": "6E3D6E662D33BF520312CAC4935912B039A5F5E2"
                  }
               }
            ],
            "Название": "Отправка"
         }
      }
   },
   "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",
            "Контрагент": {
               "СвЮЛ": {
                  "ИНН": "1111681325",
                  "КПП": "111101001",
                  "КодСтраны": "643",
                  "Название": "Тестовый Получатель"
               }
            },
            "Название": "Реализация № 56089268 от 16.04.2015",
            "Направление": "Исходящий",
            "НашаОрганизация": {
               "СвЮЛ": {
                  "ИНН": "1111654353",
                  "КПП": "111101001",
                  "КодСтраны": "643",
                  "Название": "Тестовый Отправитель"
               }
            },
            "Номер": "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=eyJHVUlEIjoiOTM3NmkZDg5MTBmIiwi0JjQndCdIjoiMTExMTY4MTMyNSIsItCa0J%2FQnyI6IjExMTEwMTAwMSJ9",
            "СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=9376c06c-8c90-4e5a",
            "СсылкаНаPDF": "https://online.sbis.ru/service/?method=%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1D1%85%D1%80%D0%BE%D0%BD%D0%BD%D0%B0%D1%8F%D0%9F%D0%B5%D1%87%D0%B0%D1%82%D1%8Cparams=eyLQlNC%2B0LrRg9C80LXQvdGC0YsiOnsicyI6W3sibiI6ItCY0LTQniIsInQiOiLQp9C40YHQu9C%2BINGG0LXQu9C%2B0LUifSx7Im4iOiLQoNCw0LfQtNC10LsiLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1In1dLCJkIjpbWzcsbnVsbF1dfSwi0JjQvNGP0J7QsdGK0LXQutGC0LAiOiLQn9C10YfQsNGC0YzQlNC%2B0LrRg9C80LXQvdGC0L7QsiIsItCY0LzRj9Cc0LXRgtC%2B0LTQ%0AsCI6ItCh0L%2FQuNGB0L7QutCU0LvRj9Cc0LDRgdGB0L7QstC%2B0LnQn9C10YfQsNGC0LgiLCLQmNC80Y%2FQpNCw0LnQu9CwIjoiIiwi0JDQstGC0L7Qv9C10YfQsNGC0YwiOnRydWV9&protocol=3&id=0",
            "СсылкаНаАрхив": "https://online.sbis.ru/service/?method=%D0%92%D0%B5%D1%80%D1%81%D0%B8%8%D0%BD%D0%B5%D0%B3%D0%BE%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0.%D0%A1%D0%BE%D1%85%D1%80%D0%B0%D0%BD%D0%B8%D1%82%D1%8C%D0%9D%D0%B0%D0%94%D0%B8%D1%81%D0%BAparams=eyLQmNC00J4iOjd9&protocol=3&id=0",
            "Сумма": "",
            "Тип": "ДокОтгрИсх",
            "Удален": "Нет"
         }
      ],
      "Навигация": {
         "ЕстьЕще": "Нет",
         "РазмерСтраницы": "25",
         "Страница": "0"
      }
   },
   "id": 0
}
Скачать пример

Пример запроса с отложенным сертификатом без подтверждения

{
   "jsonrpc": "2.0",
   "method": "СБИС.ВыполнитьДействие",
   "params": {
      "Документ": {
         "Идентификатор": "ad819092-e057-11e9-aa29-902b341c8ff2",
         "Этап": {
            "Действие": {
               "Название": "Отправить",
               "Сертификат": {
                  "Ключ": {
                     "Тип": "Отложенный"
                  },
                  "Отпечаток": "9B29E5A1BEE72AC2EFBAE8B7581AEF57F3B621C9"
               }
            },
            "Название": "Отправка"
         }
      }
   },
   "id": 2
}
Скачать пример

Пример запроса с отложенным сертификатом с подтверждением

{
   "jsonrpc": "2.0",
   "method": "СБИС.ВыполнитьДействие",
   "params": {
      "Документ": {
         "Идентификатор": "e53fcb1f-e117-41eb-8857-5d7e11c172a6",
         "Этап": {
            "Действие": {
               "Название": "Отправить",
               "Сертификат": {
                  "Ключ": {
                     "Тип": "ОтложенныйСПодтверждением"
                  },
                  "Отпечаток": "9B29E5A1BEE72AC2EFBAE8B7581AEF57F3B621C9"
               }
            },
            "Название": "Отправка"
         }
      }
   },
   "id": 2
}
Скачать пример

Пример ответа с отложенным сертификатом

{
   "jsonrpc": "2.0",
   "result": {
      "Идентификатор": "ad819092-e057-11e9-aa29-902b341c8ff2",
      "Контрагент": {
         "СвЮЛ": {
            "ИНН": "1112012704",
            "КПП": "111250001",
            "КодСтраны": "643",
            "Название": "ЭДО Получатель"
         }
      },
      "Направление": "Исходящий",
      "НашаОрганизация": {
         "СвЮЛ": {
            "ИНН": "1118643576",
            "КПП": "993550001",
            "КодСтраны": "643",
            "Название": "ЭДО Отправитель"
         }
      },
      "Ответственный": {
         "Идентификатор": "",
         "Имя": "Сергей",
         "Отчество": "Сергеевич",
         "Фамилия": "Сергеев"
      },
      "Подразделение": {
         "Идентификатор": "",
         "Название": "ЭДО Отправитель"
      },
      "Редакция": [
         {
            "Актуален": "Нет",
            "ДатаВремя": "02.10.2019 21.52.04",
            "Идентификатор": "4df597bb-a4f9-49f3-8195-cfcaad458983",
            "ПримечаниеИС": ""
         }
      ],
      "Событие": [
         {
            "Вложение": [
               {
                  "Идентификатор": "524a4e16-3f86-421b-be6e-de31227d4a21",
                  "Тип": "",
                  "Подтип": "",
                  "ВерсияФормата": "",
                  "ПодверсияФормата": "",
                  "Название": "test.txt",
                  "Удален": "Нет",
                  "УдаленКонтрагентом": "Нет",
                  "Модифицирован": "Нет",
                  "Служебный": "Нет",
                  "Дата": "",
                  "Номер": "",
                  "Сумма": "",
                  "Направление": "Исходящий",
                  "СсылкаНаHTML": "",
                  "СсылкаНаPDF": "",
                  "Редакция": {
                     "ДатаВремя": "02.10.2019 21.52.04",
                     "Номер": "1"
                  },
                  "Файл": {
                     "Имя": "test.txt",
                     "Ссылка": "https://online.sbis.ru/disk/api/v1/ba93be02-63de-4d81-abeb-5ff482de284a_c919a0b2-8384-440d-addf-693be70150f6?object=simple_file_sd&uuid=57ae0059-9db8-4345-9e40-75bba9b24766&diskhmac=5ctp%2Fi%2FGowXuxVLxjFkp7i0wvGM%3D",
                     "Хеш": ""
                  }
               }
            ],
            "ДатаВремя": "02.10.2019 21.53.51",
            "Название": "Загрузка",
            "Идентификатор": "6cb44310-b603-4bdc-b1be-b0aea593394e",
            "Комментарий": ""
         }
      ],
      "Состояние": {
         "Код": "23",
         "Название": "Ожидает подписания",
         "Комментарий": ""
      },
      "СсылкаДляКонтрагент": "https://online.sbis.ru/svrd/v2/inc_pack/6cb44310-b603-4bdc-b1be-b0aea593394e",
      "СсылкаДляНашаОрганизация": "https://online.sbis.ru/opendoc.html?guid=743adcb6-a552-4b1c-a442-b41f221a08b1",
      "Тип": "ДокОтгрИсх",
      "Подтип": ""
   },
   "id": 2
}
Скачать пример