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

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

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

Каким должен быть размер вложений?

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

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

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

"Документ": объект:
- "Идентификатор": строка, используется для адресации документа. При создании редакции существующего документа укажите идентификатор документа. При создании документа идентификатор сгенерируется автоматически
- "Редакция": объект:
  - "Идентификатор": строка, используется для адресации редакции документа
  - "ПримечаниеИС": строка
- "Номер": строка, содержит номер документа. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
- "Дата": строка в формате «ДД.ММ.ГГГГ». Используется при сортировке и фильтрации по типам в реестрах документов в личном кабинете Saby. Если параметр не указан, значение извлекается из первого формализованного документа или генерируется автоматически в соответствии с настройкой реестра документов
- "Сумма": строка, содержит сумму документа. Если параметр не указан, значение извлекается из первого формализованного документа
- "Срок": строка в формате «ДД.ММ.ГГГГ», дата документа. Присутствует в некоторых типах документов
- "Примечание": строка, комментарий к документу
- "Тип": строка, тип документа
- "Подтип": строка, подтип типа документа
- "Регламент": объект:
  - "Идентификатор": строка
  - "Название": строка
- "НашаОрганизация"**: объект, сведения о нашей компании. Параметр обязателен для документов, в которых указывают организацию, если ее невозможно определить по приложенным файлам *.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
    - "Фамилия": строка
    - "Имя": строка
    - "Отчество": строка
    - "СНИЛС": строка
    - "ЧастноеЛицо": строка. Возможные значения: «Да», «Нет». Передайте значение «Да», если покупатель физическое лицо. Если этого не сделать, Saby укажет в качестве контрагента индивидуального предпринимателя
- "Подразделение": объект:
  - "Название": строка, название подразделения
  - "Идентификатор": строка, код подразделения
  - "Структура": строка. Возможные значения: «Активная», «Юридическая», «Управленческая», «Совмещенная». Если указано «Совмещенная», поиск производится сначала по юридической, затем по управленческой структуре. Если значение не указано, используется управленческая структура
- "Ответственный": объект:
  - "Фамилия": строка
  - "Имя": строка
  - "Отчество": строка
  - "Идентификатор": строка, идентификатор во внешней системе
- "Автор": объект:
  - "Фамилия": строка
  - "Имя": строка
  - "Отчество": строка
  - "Идентификатор": строка, идентификатор во внешней системе
- "НачалоПериода": дата в формате «ДД.ММ.ГГГГ», начало периода действия акта. Указывается, если «Тип» = «АктСверкиДок»
- "КонецПериода": дата в формате «ДД.ММ.ГГГГ», окончание периода действия акта. Указывается, если «Тип» = «АктСверкиДок»
- "Вложение": массив объектов (вложений документа):
  - "Идентификатор": идентификатор UUID в виде строки, используется для адресации вложения
  - "Тип": строка, название типа формализованного вложения. Поле не заполняется — тип будет определен Saby автоматически
  - "Подтип": строка, название подтипа формализованного вложения
  - "ВерсияФормата": строка, определяется по содержимому формализованного вложения
  - "ПодверсияФормата": строка, определяется по содержимому формализованного вложения
  - "Название": строка, название вложения. Если названия нет, генерируется по реквизитам из тела формализованного вложения. Для неформализованного вложения может быть пустым
  - "Служебный": строка. Значение «Да» — признак служебного вложения, «Нет» — первичного вложения
  - "Дата": строка в формате «ДД.ММ.ГГГГ». Извлекается из тела формализованного вложения, дата загрузки для неформализованного вложения
  - "Номер": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
  - "Сумма": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
  - "Зашифрован": строка, «Да»/«Нет»
  - "ТипШифрования": строка, «Пользовательское»/«Локальное»/«Отсутствует». Принимает значение по умолчанию «Локальное», если в параметре «Зашифрован» передано «Да»
  - "Файл": объект:
    - "Имя": строка, имя файла
    - "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
    - "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
  - "Подпись": массив объектов:
    - "Файл": объект:
      - "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
      - "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
    - "Сертификат": объект
      - "Доверенность": массив объектов
        "ИдентификаторМЧД": строка, 36-разрядный GUID из имени файла
        "СистемаХраненияМЧД": строка
        "ДействительнаС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия доверенности
        "ДействительнаПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия доверенности
        "ВнутрНомер": строка
        "ИННДоверителя": строка
        "ИННПредставителя": строка
- "Состояние": объект
  - "ЗапретРаздельнойОбработки": строка. Возможные значения: «Да», «Нет»
- "ДопПоля": строка, список дополнительных опций метода

Результат

Объект «Документ» с измененными полями.

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

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

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

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

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

Результат

Объект «Документ» с измененными полями.

Комментарий

Если появилась ошибка, которая не препятствует созданию документа, будет создан черновик документа и на нем зафиксирована ошибка.
Чтобы перезаписать созданный черновик при ошибках или повторных выгрузках документа, передайте параметр «Документ.Идентификатор» или «Документ.Редакция.Идентификатор».
С помощью команды «СБИС.ЗаписатьДокумент» и объектов «ДокументОснование», «ДокументСледствие» можно связать документы. Документ будет создан как связанный с указанными документами-основаниями.
При загрузке документа без указания:
- типа документа и регламента — назначается «ДокОтгрИсх» с первым действующим регламентом из списка;
- регламента — назначается первый действующий регламент из списка.
При выполнении метода «СБИС.ЗаписатьДокумент» для черновиков удаляются вложения и подписи от предыдущих редакций. Если их нужно сохранить, прочитайте нужную редакцию и с помощью «СБИС.ЗаписатьДокумент» сохраните ее заново.
При определении документа по идентификатору в поле «Документ.Идентификатор»:
- для исходящих документов изменяется информация последней редакции (если она не отправлена) или создается новая редакция;
- для входящих документов можно изменить только «Документ.Идентификатор», «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
Если документ определяется по идентификатору редакции в поле «Документ.Редакция.Идентификатор», то:
- последнюю редакцию определяет сам документ;
- для предыдущих редакций можно изменить только «Документ.Редакция.Идентификатор» и «Документ.Редакция.ПримечаниеИС».
Способы определения абонентского ящика (АЯ) для адресации документа:
- По реквизитам контрагента.
  1. Контрагент определяется по реквизитам и добавляется в документ.
  2. АЯ определяется при отправке документа по реквизитам контрагента.
- По реквизитам контрагента и абонентскому ящику.
  1. Контрагент определяется по реквизитам и добавляется в документ.
  2. АЯ из запроса сохраняется на документе.
  3. При отправке проверяется совпадение ИНН владельца АЯ с ИНН контрагента. Если ИНН не совпадают, возвращается ошибка.
- По идентификатору абонентского ящика.
  1. Контрагент определяется по АЯ и добавляется в документ.
  2. АЯ сохраняется на документе.
  3. При отправке используется сохраненный АЯ.
Раздельная обработка файлов документа:
- запрещена по умолчанию при отправке документа нескольким получателям;
- может быть запрещена отправителем документа. Для этого передайте «Состояние.ЗапретРаздельнойОбработки» = «Да».
Поле «СсылкаДляКонтрагент» в ответе запроса возвращается заполненным, только если документ был запущен в документооборот.
Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке «HTTP 403 Forbidden».
Передавайте реквизиты формализованного вложения «Тип», «Подтип», «Версия», «ПодВерсия» и «Название» на сервер все вместе. Убедитесь, что поля реквизитов заполнены правильно. Если передать только часть реквизитов или реквизиты с неверными значениями, то Saby не сможет отобразить документ и создать его в формате *.pdf.
Если сотрудник подписывает документ по доверенности, передайте блок «Доверенность». Набор полей зависит от того, где зарегистрирована доверенность:
- в Saby — передайте только "ИдентификаторМЧД";
- в Saby нет информации о МЧД — дополнительно передайте "СистемаХраненияМЧД", "ИННДоверителя" и "ДействительнаС";
- бумажная доверенность (блок есть, но "ИдентификаторМЧД" отсутствует) — обязательно передайте "ВнутрНомер", "ИННДоверителя" и "ДействительнаС".
Реквизиты доверенности подписанта возвращаются в ответе метода. В блоке "Документ.Этап.Действие.Сертификат" — список сертификатов для подписания. Для сертификатов с доверенностью будет заполнен блок "Документ.Этап.Действие.Сертификат.Доверенность". Эти данные используйте при вызове других методов.
Чтобы получить сертификаты на носителях, укажите параметр "ДопПоля": "ЭтапВернутьВсеСертификаты". Данные о доверенности для конкретного сертификата также можно взять из вашей информационной системы.

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

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