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

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

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

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

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

Создать редакцию
Создать редакцию
Обновить реквизиты и вложения
Обновить реквизиты и вложения

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

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

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

  • "Документ": объект:
    • "Идентификатор": строка, используется для адресации документа. При создании редакции существующего документа укажите идентификатор документа. При создании документа сгенерируется автоматически.
    • "Редакция": объект:
      • "Идентификатор": строка, используется для адресации редакции документа
      • "ПримечаниеИС": строка
    • "Номер": строка, содержит номер документа. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
    • "Дата": строка в формате «ДД.ММ.ГГГГ». Используется при сортировке и фильтрации по типам в реестрах документов на online.sbis.ru. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
    • "Сумма": строка, содержит сумму документа. Если параметр не указан, значение извлекается из первого формализованного документа
    • "Срок": строка в формате «ДД.ММ.ГГГГ», дата документа. Присутствует в некоторых типах документов
    • "Примечание": строка, комментарий к документу
    • "Тип": строка, тип документа
    • "Подтип": строка, подтип типа документа
    • "Регламент": объект:
      • "Идентификатор": строка
      • "Название": строка
    • "НашаОрганизация"**: объект, сведения о нашей компании. Параметр обязателен для документов, в которых указывают организацию, если организацию невозможно определить по приложенным файлам *.xml
      • "GLN": строка, Global Location Number. Если указан, то будет использоваться для поиска организации
      • "СвЮЛ": объект:
        • "ИНН": строка, 10 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
        • "КПП": строка, 9 символов
        • "КодФилиала": строка
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 numeric
        • "Название": строка, название организации
      • "СвФЛ": объект:
        • "ИНН": строка, 12 символов
        • "КодФилиала": строка
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 numeric
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
    • "Контрагент": объект:
      • "Идентификатор": строка, идентификатор участника документооборота — непосредственного получателя документа, либо трехбуквенный префикс оператора электронного документооборота
      • "GLN": строка, Global Location Number;
      • "СвЮЛ": объект:
        • "ИНН": строка, 10 символов. Для иностранных организаций номер определяется требованиями законодательства их стран
        • "КПП": строка, 9 символов
        • "КодФилиала", строка
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 numeric
        • "Название": строка, название организации
      • "СвФЛ": объект:
        • "ИНН": строка, 12 символов
        • "КодФилиала": строка
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 numeric
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
        • "СНИЛС": строка
        • "ЧастноеЛицо": строка. Возможные значения: «Да», «Нет». Передайте значение «Да», если покупатель физическое лицо. Если этого не сделать, СБИС укажет в качестве контрагента индивидуального предпринимателя
    • "Подразделение": объект:
      • "Название": строка, название подразделения
      • "Идентификатор": строка, код подразделения
      • "Структура": строка. Возможные значения: «Активная», «Юридическая», «Управленческая», «Совмещенная». Если указано «Совмещенная», поиск производится сначала по юридической, затем по управленческой структуре. Если значение не указано, используется управленческая структура
    • "Ответственный": объект:
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "Идентификатор": строка, идентификатор во внешней системе
    • "Автор": объект:
      • "Фамилия": строка
      • "Имя": строка
      • "Отчество": строка
      • "Идентификатор": строка, идентификатор во внешней системе
    • "Вложение": массив объектов (вложений документа):
      • "Идентификатор": идентификатор UUID в виде строки, используется для адресации вложения
      • "Тип": строка, название типа формализованного вложения
      • "Подтип": строка, название подтипа формализованного вложения
      • "ВерсияФормата": строка, определяется по содержимому формализованного вложения
      • "ПодверсияФормата": строка, определяется по содержимому формализованного вложения
      • "Название": строка, название вложения. Если названия нет, генерируется по реквизитам из тела формализованного вложения. Для неформализованного вложения может быть пустым
      • "Удален": строка «Да»/«Нет», флаг удаления вложения
      • "Служебный": строка. Значение «Да» — признак служебного вложения, «Нет» — первичного вложения
      • "Дата": строка в формате «ДД.ММ.ГГГГ». Извлекается из тела формализованного вложения, дата загрузки для неформализованного вложения
      • "Номер": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
      • "Сумма": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
      • "Зашифрован": строка, «Да»/«Нет»
      • "ТипШифрования": строка, «Пользовательское»/«Локальное»/«Отсутствует». Принимает значение по умолчанию «Локальное», если в параметре «Зашифрован» передано «Да»
      • "Файл": объект:
        • "Имя": строка, имя файла
        • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
        • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
      • "Подпись": массив объектов:
        • "Файл": объект:
          • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
          • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
        • "Сертификат": объект
          • "Доверенность": массив объектов
            • "ИдентификаторМЧД": строка, 36-разрядный GUID из имени файла
            • "СистемаХраненияМЧД": строка
            • "ДействительнаС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия доверенности
            • "ДействительнаПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия доверенности
            • "ВнутрНомер": строка
            • "ИННДоверителя": строка
    • "ДопПоля": строка, список дополнительных опций метода

Результат

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

Чтобы отредактировать вложения документа, передайте идентификатор вложения и новые сведения о нем (список файлов и подписей).

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

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

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

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

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

Результат

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

Комментарий

  1. Если появилась ошибка, которая не препятствует созданию документа, будет создан черновик документа и на нем зафиксирована ошибка.
  2. Чтобы перезаписать созданный черновик при ошибках или повторных выгрузках документа, передайте параметр «Документ.Идентификатор» или «Документ.Редакция.Идентификатор».
  3. С помощью команды «СБИС.ЗаписатьДокумент» и объектов «ДокументОснование», «ДокументСледствие» можно связать документы. Документ будет создан как связанный с указанными документами-основаниями.
  4. При загрузке документа без указания:
    • типа документа и регламента — назначается «ДокОтгрИсх» с первым действующим регламентом из списка;
    • регламента — назначается первый действующий регламент из списка.
  5. При выполнении метода «СБИС.ЗаписатьДокумент» для черновиков удаляются вложения и подписи от предыдущих редакций. Если их нужно сохранить, прочитайте нужную редакцию и с помощью «СБИС.ЗаписатьДокумент» сохраните ее заново.
  6. При определении документа по идентификатору в поле «Документ.Идентификатор»:
    • для исходящих документов изменяется информация последней редакции (если она не отправлена) или создается новая редакция;
    • для входящих документов можно изменить только «Документ.Идентификатор», «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
  7. Если документ определяется по идентификатору редакции в поле «Документ.Редакция.Идентификатор», то:
    • последнюю редакцию определяет сам документ;
    • для предыдущих редакций можно изменить только «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
  8. Чтобы отправить документ по идентификатору, указанному в поле «Документ.Контрагент.Идентификатор», убедитесь, что ИНН владельца идентификатора совпадает с ИНН получателя документа. Если ИНН отличаются, будет сгенерирована фатальная ошибка входных параметров.

    Чтобы изменить идентификатор, перезапишите черновик документа.

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

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

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

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

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

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

Обновить ожидаемый документ

Во «Вложение» передайте:

  • «Тип»: «ДокументОж»;
  • «Название» — название ожидаемого документа из карточки регламента;
  • «Файл.ДвоичныеДанные» или «Файл.Ссылка»

Обновить реквизиты документа

Пример ответа

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