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

Объект «Документ» (API)

Объект «Документ» (API)

Параметры любого исходящего или входящего документа определяются объектом «Документ».

Структура объекта «Документ»

Условные обозначения:

Синие — параметры, возвращаемые с сервера (поля, доступные только для чтения).

Красные — параметры, которые передаются на сервер как аргумент функции (поля, доступные только для записи).

Черные — параметры, которые могут быть как переданы на сервер, так и получены в ответ на команду.

  • "Идентификатор": строка, используется для адресации документа
  • "Дата": строка в формате "ДД.ММ.ГГГГ". Используется при сортировке и фильтрации по типам в реестрах документов на сайте online.sbis.ru
  • "Номер": строка, номер документа
  • "Сумма": строка, содержащая сумму документа.
  • "Срок": строка в формате "ДД.ММ.ГГГГ", дата документа. Присутствует в некоторых типах документов
  • "Сумма": строка, содержит сумму документа. Задается как сумма из первого формализованного первичного вложения
  • "Название": строка, содержит название документа
  • "Примечание": строка, содержит комментарии к документу в произвольном значении. Может использоваться при фильтрации
  • "ДатаВремяСоздания": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС". Дата и время создания документа на сервере
  • "Удален": строка "Да"/"Нет", флаг пометки документа на удаление
  • "Тип": строка, указывает общий тип документа
  • "Направление": строка (см. список допустимых направлений документов)
  • "СсылкаДляНашаОрганизация": строка, содержит ссылку. При переходе по этой ссылке отобразится карточка документа в личном кабинете нашей организации. Для входа в личный кабинет может потребоваться аутентификация
  • "СсылкаДляКонтрагент": строка, содержит ссылку. При переходе по этой ссылке отобразится карточка документа в личном кабинете контрагента. Для входа в личный кабинет может потребоваться электронная подпись
  • "СсылкаНаАрхив": строка, содержит ссылку на архив последней редакции документа (вложений и ЭП)
  • "СсылкаНаPDF": строка, содержит ссылку на PDF-документ, где вложением является формализованный документ с «впечатанными» данными ЭП. Пустое значение означает, что получить представление формализованного документа в PDF невозможно
  • "Состояние": объект, состояние документа:
  • "Редакция": массив объектов, информация о редакции документа:
    • "Идентификатор": строка, используется для адресации редакции документа
    • "Актуален": строка "Да"/"Нет". Если есть более новая редакция, возвращается "Нет"
    • "ПримечаниеИС": строка, произвольное примечание информационной системы
    • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время создания редакции
  • "Регламент": объект, информация о регламенте документооборота:
    • "Идентификатор": строка
    • "Название": строка
  • "ДокументОснование": массив объектов:
    • "Документ": объект:
      • "Идентификатор": строка
      • "Дата": строка в формате "ДД.ММ.ГГГГ"
      • "Номер": строка
      • "Тип": строка
    • "ВидСвязи": строка
    • "Сумма": строка
  • "ДокументСледствие": массив объектов
  • "НашаОрганизация": объект, описывает нашу организацию по документу:
  • "Контрагент": объект, описывает контрагента по документу:
  • "Подразделение": объект:
    • "Название": строка, название подразделения
    • "Идентификатор": строка, код подразделения
  • "Ответственный": объект:
    • "Фамилия": строка
    • "Имя": строка
    • "Отчество": строка
    • "Идентификатор": строка, идентификатор во внешней системе
  • "Автор": объект:
    • "Фамилия": строка
    • "Имя": строка
    • "Отчество": строка
    • "Идентификатор": строка, идентификатор во внешней системе
  • "Вложение": массив объектов (вложений документа):
    • "Идентификатор": строка, используется для адресации вложения
    • "Тип": строка, название типа формализованного вложения
    • "Подтип": строка, название подтипа формализованного вложения
    • "ВерсияФормата": строка, определяется по содержимому формализованного вложения
    • "ПодверсияФормата": строка, определяется по содержимому формализованного вложения
    • "Название": строка, название вложения. Если названия нет, оно генерируется по реквизитам из тела формализованного вложения. Для неформализованного вложения может быть пустым
    • "Удален": строка "Да"/"Нет", флаг удаления вложения
    • "УдаленКонтрагентом": строка "Да"/"Нет", флаг удаления вложения получателем (для внешнего документооборота)
    • "Модифицирован": строка "Да"/"Нет", признак, определяющий, что в тело вложения внесены изменения. Служит для того, чтобы определить необходимость обновления в информационной системе. Как правило, вводится после модификации в результате подготовки к этапу документооборота. Например, когда меняется подписант или проставляется идентификатор участника документооборота
    • "Служебный": строка. Значение "Да" — признак служебного вложения, "Нет" — первичного вложения
    • "Дата": строка в формате "ДД.ММ.ГГГГ", извлекается из тела формализованного вложения, дата загрузки для неформализованного вложения
    • "Номер": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
    • "Сумма": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения
    • "Направление": строка, указывает направление конкретного вложения (т.е. это может быть "входящее" вложение "исходящего" документа, например, "подтверждение даты получения" от оператора)
    • "СсылкаНаHTML": строка, ссылка для скачивания данных HTML представления (допустимо только для формализованных вложений). Если значение пустое — значит, вернуть представление невозможно
    • "СсылкаНаPDF": строка, ссылка для скачивания данных PDF представления (допустимо только для формализованных вложений). Если значение пустое — значит, вернуть представление невозможно
    • "Редакция": объект:
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время создания редакции вложения
      • "Номер": строка, номер редакции по порядку (исходная версия имеет номер "1"), нумерация непрерывная (если одно и то же вложение записывалось в разных редакциях, у них будут разные номера)
    • "Файл": объект:
      • "Имя": строка, имя файла.
      • "Ссылка": строка, ссылка для скачивания бинарных данных. Для скачивания данных используйте HTTP GET запрос
      • "ДвоичныеДанные": строка в кодировке Bаse64, используется для отправки содержимого бинарных данных на сервер. Размер не более 60 Мб
      • "Хеш": строка в Base64, криптографический хеш загруженных бинарных данных
    • "Подпись": массив объектов:
      • "Сертификат": объект, реквизиты владельца сертификата ЭП. Объект возвращается не во всех вызовах:
        • "ФИО": строка, подписант
        • "Должность": строка
        • "ИНН": строка, значение соответствует
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
        • "ОГРНИП": строка
        • "Название": строка, название организации
        • "Отпечаток": строка, отпечаток
        • "СерийныйНомер": строка, серийный номер
        • "Издатель": строка, издатель сертификата
        • "Квалифицированный": строка "Да"/"Нет"
        • "ДействителенС": дата и время
        • "ДействителенПо": дата и время
      • "Файл":объект:
        • "Имя": строка, совпадает с именем файла документа, к которому относится. Дополняется строкой «.sgn» для первой подписи, «2.sgn» для второй и последующих
        • "Ссылка": строка, ссылка для скачивания бинарных данных. Для скачивания данных используйте HTTP GET запрос
        • "ДвоичныеДанные": строка в кодировке Base64, используется для отправки содержимого бинарных данных на сервер
    • "Событие": массив объектов:
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время окончания события
      • "Название": строка
      • "Идентификатор": строка, уникальный идентификатор события
      • "Комментарий": строка, комментарий, оставленный пользователем или системой
      • "Вложение": массив объектов, описание совпадает с "Документ.Вложение", содержит вложения, ассоциированные с событием:
        • ...
    • "Этап": массив объектов:
      • "Название": строка, список типов документов
      • "Идентификатор": строка, уникальный идентификатор. Его следует сохранить и передавать на сервер при подготовке и выполнения действия над документом
      • "Служебный": строка "Да"/"Нет"
      • "Вложение": массив объектов, описание совпадает с разделом "Документ.Вложение", содержит вложения, которые необходимо подписать для выполнения этапа:
        • ...
      • "Действие": массив объектов:
        • "Название": строка, список допустимых значений
        • "ТребуетПодписания": строка "Да"/"Нет", "Да" означает, что регламент требует подписать вложения перед завершением этапа и указать информацию о подписанте при подготовке этапа
        • "ТребуетКомментария": строка "Да"/"Нет", "Да" означает требование регламента указать комментарий при подготовке к завершению этапа
        • "Сертификат": массив объектов:
          • "ФИО": строка
          • "Должность": строка
          • "ИНН": строка, значение соответствует
          • "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
          • "Название": строка
          • "Отпечаток": строка
          • "СерийныйНомер": строка, серийный номер
          • "Издатель": строка, издатель сертификата.
          • "Квалифицированный": строка "Да"/"Нет"
          • "ДействителенС": дата и время
          • "ДействителенПо": дата и время
          • "Ключ": объект:

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

    На заметку!

    Поле Документ.Идентификатор используется для адресации последней редакции документа, «Документ.Редакция.Идентификатор» — для конкретной редакции документа.

    В вашей информационной системе не следует хранить идентификаторы участников документооборота и какие-либо ссылки (кроме «Документ.СсылкаДляКонтрагент») — они могут меняться без уведомления.

Реквизиты формализованного документа «Дата», «Номер», «Тип», «Подтип», «Версия», «ПодВерсия» и «Название» должны передаваться все вместе. Важно, чтобы в реквизитах были указаны правильные значения. Иначе они не должны передаваться вовсе. Если передать только часть реквизитов или с неверными значениями, они будут записаны в систему. Это сделает невозможным отображение документов и генерацию PDF.