Присоединяйтесь!

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

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

Команда «СБИС.ЗаписатьДокумент» создает редакцию документа, а также обновляет реквизиты или вложения.

Во входящих документах не доступны для изменения реквизиты «нашей организации» и контрагента.

Действует ограничение на размер передаваемых данных. HTTP-запрос вместе с заголовками должен быть не больше 100 МБ. Записываемое вложение не должно превышать 73 МБ. При кодировании двоичных данных в Base64 размер вложения увеличивается на 25%.

Если нужно записать несколько вложений, каждое из которых менее 73 МБ, а общий размер превышает 100 МБ — используйте метод «СБИС.ЗаписатьВложение». Чтобы записать файлы, превышающие размеры ограничений, предварительно загрузите их на СБИС Диск.

В параметрах команды «СБИС.ЗаписатьДокумент» передайте идентификатор документа и обновленные данные, которые нужно записать в документ.

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

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

  • "Документ": объект:
    • "Идентификатор"*: строка, используется для адресации документа
    • "Редакция":
      • "Идентификатор"*: строка
      • "ПримечаниеИС": строка
    • "Номер": строка, содержит номер документа. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
    • "Дата": строка в формате «ДД.ММ.ГГГГ». Используется при сортировке и фильтрации по типам в реестрах документов на online.sbis.ru. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
    • "Сумма": строка, содержит сумму документа. Если параметр не указан, значение извлекается из первого формализованного документа
    • "Срок": строка в формате «ДД.ММ.ГГГГ», дата документа. Присутствует в некоторых типах документов
    • "Примечание": строка, комментарий к документу
    • "Тип": строка, тип документа
    • "Подтип": строка, подтип типа документа
    • "Регламент": объект:
      • "Идентификатор": строка
      • "Название": строка
    • "НашаОрганизация": объект, сведения о нашей компании. Для поиска организации используется GLN (более ресурсоемкий способ) или совокупность параметров «ИНН + КПП + КодФилиала»/«ИНН» (менее ресурсоемкий)
    • "Контрагент":
    • "Подразделение": объект:
      • "Название": строка, название подразделения
      • "Идентификатор": строка, код подразделения
    • "Ответственный": объект:
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "Идентификатор": строка, идентификатор во внешней системе
    • "Автор": объект:
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "Идентификатор": строка, идентификатор во внешней системе
    • "Вложение": массив объектов (вложений документа):
      • "Идентификатор": строка, используется для адресации вложения
      • "Тип": строка, название типа формализованного вложения
      • "Подтип": строка, название подтипа формализованного вложения
      • "ВерсияФормата": строка, определяется по содержимому формализованного вложения
      • "ПодверсияФормата": строка, определяется по содержимому формализованного вложения
      • "Название": строка, название вложения. Если названия нет, генерируется по реквизитам из тела формализованного вложения. Для неформализованного вложения может быть пустым
      • "Удален": строка «Да»/«Нет», флаг удаления вложения
      • "Служебный": строка. Значение «Да» — признак служебного вложения, «Нет» — первичного вложения
      • "Дата": строка в формате «ДД.ММ.ГГГГ». Извлекается из тела формализованного вложения, дата загрузки для неформализованного вложения
      • "Номер": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
      • "Сумма": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
      • "Зашифрован": строка, «Да»/«Нет»
      • "ТипШифрования": строка, «Пользовательское»/«Локальное»/«Отсутствует». Принимает значение по умолчанию «Локальное», если в параметре «Зашифрован» передано «Да»
      • "Файл": объект:
        • "Имя": строка, имя файла
        • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
        • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
      • "Подпись": массив объектов:
        • "Файл": объект:
          • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
          • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»

Результат

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

Чтобы отредактировать вложения документа, передайте идентификатор вложения и новые сведения о нем (список файлов и подписей). Например, если в объекте «Документ» передан флаг «Удален» = «Да», то вложение помечается как удаленное и не может быть отправлено.

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

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

  • "Адресация": объект, вложенный для объекта «Документ». Позволяет внести изменения в документ без создания редакции. Предназначен для указания документа, в котором будут обновляться реквизиты и вложения
    • "Идентификатор"*: строка, идентификатор адресуемого документа
    • "Редакция": объект:
      • "Идентификатор"*: строка, идентификатор адресуемой редакции документа
  • "Документ": объект, содержит изменяемые данные

Результат

  • "Документ": объект с изменениями

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

Комментарий

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

    При загрузке документа без указания:

    • типа документа и регламента — назначается «ДокОтгрИсх» с первым действующим регламентом из списка;
    • регламента — назначается первый действующий регламент из списка.
  3. При выполнении метода «СБИС.ЗаписатьДокумент» для черновиков удаляются вложения и подписи от предыдущих редакций. Если их нужно сохранить, прочитайте нужную редакцию и с помощью «СБИС.ЗаписатьДокумент» сохраните ее заново.
  4. При определении документа по идентификатору в поле «Документ.Идентификатор»:
    • для исходящих документов изменяется информация последней редакции (если она не отправлена) или создается новая редакция;
    • для входящих документов можно изменить только «Документ.Идентификатор», «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
  5. Если документ определяется по идентификатору редакции в поле «Документ.Редакция.Идентификатор», то:
    • последнюю редакцию определяет сам документ;
    • для предыдущих редакций можно изменить только «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
  6. Раздельная обработка файлов документа:
    • запрещена по умолчанию при отправке документа нескольким получателям;
    • может быть запрещена отправителем документа, для этого надо передать значение «ОбработатьФайлыСовместно» в поле «ДопПоля». Кроме случаев, когда документ отправлен в роуминг.
  7. Поле «СсылкаДляКонтрагент» в ответе запроса возвращается заполненным, только если документ был запущен в документооборот.
  8. Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке «HTTP 403 Forbidden».
  9. Передавайте реквизиты формализованного вложения «Тип», «Подтип», «Версия», «ПодВерсия» и «Название» на сервер все вместе. Убедитесь, что поля реквизитов заполнены правильно. Если передать только часть реквизитов или реквизиты с неверными значениями, то СБИС не сможет отобразить документ и сформировать его в формате *.pdf.

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

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

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

Запрещена раздельная обработка вложений.

Создание редакции с несколькими получателями.

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

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.