Интеграция с информационной системой

СБИС.ЗаписатьДокумент

СБИС.ЗаписатьДокумент

Команда СБИС.ЗаписатьДокумент позволяет:

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

Если документ не был отправлен, можно редактировать любые реквизиты документа. В случае если документ когда-либо запускался в документооборот, для него будет создана новая редакция. Причём, если документооборот не завершен, для предыдущей редакции получателю будет сформировано и отправлено «Уведомление об удалении на стороне отправителя».

Создать редакцию документа

Для редактирования документа в параметрах команды СБИС.ЗаписатьДокумент необходимо передать идентификатор этого документа и обновлённые данные, которые необходимо записать.

Внимание!

Для входящих документов существуют ограничения на редактирование участников документооборота: запрещается изменять вашу организацию и контрагента.

Для редактирования вложений документа необходимо передать идентификатор вложения и новые сведения о нем (список файлов и подписей). Например, если в объекте «Документ» передан флаг «Удален» со значением «Да», то вложение помечается как удалённое и не может быть отправлено.
Однако, если последняя редакция была запущена в документооборот, происходит аннулирование текущей редакции и создаётся новая. Если документооборот не запущен, текущая редакция перезаписывается.

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

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

  • "Документ": объект:
    • "Идентификатор"*: строка, обязательный параметр, используется для адресации документа
    • "Номер": строка, номер документа, произвольное значение.
    • "Дата": строка в формате "ДД.ММ.ГГГГ", используется при сортировке и фильтрации в реестрах документов на портале online.sbis.ru.
    • "Редакция":
      • "Идентификатор"*: строка
      • "ПримечениеИС": строка
    • ...
    • "Регламент": объект:
      • "Идентификатор": строка
      • "Название": строка

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

  • "Документ": объект

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

Комментарий

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

Внимание!

Существуют ограничения на размер передаваемых данных: o общий размер запроса не должен превышать 99 Мб; размер одного вложения не должен превышать 33 Мб; размер всех вложений документа (отправляемых за один запрос СБИС.ЗаписатьДокумент) — 73 Мб.

Обновить реквизиты или вложения в существующем документе

Команда СБИС.ЗаписатьДокумент производит обновление реквизитов или вложений уже существующего документа.

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

  • "Адресация": объект:
    • "Идентификатор"*: строка, идентификатор адресуемого документа
    • "Редакция": объект
      • "Идентификатор"*: строка, идентификатор адресуемой редакции документа
  • "Документ": объект, содержит изменяемые данные

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

  • "Документ": объект, включает изменения

Комментарий

Если документ определяется по идентификатору (Документ.Идентификатор), то:

  • для исходящих документов будет изменена информация последней редакции (если она не отправлена), или создана новая редакция;
  • для входящих документов можно изменить только "Документ.Идентификатор", "Документ.Редакция.Идентификатор" и "Документ.Редакция.ПримечаниеИС".

Если документ определяется по идентификатору редакции (Документ.Редакция.Идентификатор), то:

  • для последней редакции логика работы совпадает с предыдущим пунктом (т.к. сам документ фактически определяет последнюю редакцию);
  • для предыдущих редакции (не последних) можно изменить только "Документ.Редакция.Идентификатор" и "Документ.Редакция.ПримечаниеИС".

В ответе на запрос поле "СсылкаДляКонтрагент" возвращается заполненным, только если документ был запущен в документооборот.

Ускорить загрузку документа

При настройке шаблона нумерации документа рекомендуется установить параметр «Документ.Номер». Это позволит ускорить загрузку документа. Если требуется автоматическая генерация номера или нет возможности передать его в качестве параметра, рекомендуется на странице настроек шаблона нумерации добавить к {Номер} параметры {Месяц} или {День}.

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

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

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

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