Электронный документооборот

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

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

В командах API ЭДО используется объект «Документ». Он определяет параметры любого исходящего или входящего документа в СБИС.

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

Условные обозначения параметров:

  • Синие — возвращаются с сервера СБИС, поля доступны только для чтения.
  • Красные — передаются на сервер как аргумент функции, поля доступны только для записи.
  • Прочие — параметры, которые можно передать на сервер и получить в ответе.

Параметры

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

Комментарий

«Документ» содержит значительный объем информации и возвращается только сервером. Для отправки можно использовать только обязательную часть объекта. Обязательные параметры для запроса и возвращаемые параметры указаны в каждой команде API.

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

Не сохраняйте в вашей ИС идентификаторы участников документооборота или какие-либо ссылки, кроме «Документ.СсылкаДляКонтрагент». Оператор связи может изменять ссылки и идентификаторы, не уведомляя пользователей.

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

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