ОБЪЕКТ «ДОКУМЕНТ» (API)

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

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

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

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

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

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

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

  • "Идентификатор": строка, используется для адресации документа.
  • "Дата": строка в формате "ДД.ММ.ГГГГ", используется при сортировке и фильтрации в реестрах документов на портале online.sbis.ru.
  • "Номер": строка, номер документа, произвольное значение.
  • "Сумма": строка, сумма документа (задаётся как сумма из первого формализованного первичного вложения).
  • "Название": строка, название документа.
  • "Примечание": строка, комментарий к документу, произвольное значение, может использоваться при фильтрации.
  • "ДатаВремяСоздания": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата/время создания документа на сервере.
  • "Удален": строка "Да"/"Нет", флаг пометки документа на удаление.
  • "Тип": строка, указывает общий тип документа.
  • "Направление": строка (см. список допустимых направлений документов).
  • "СсылкаДляНашаОрганизация": строка, содержит ссылку, переход по которой приведёт к отображению карточки документа в личном кабинете нашей организации (для входа в личный кабинет может потребоваться аутентификация).
  • "СсылкаДляКонтрагент": строка, содержит ссылку, переход по которой приведёт к отображению карточки документа в личном кабинете контрагента (для входа в личный кабинет может потребоваться электронная подпись).
  • "СсылкаНаАрхив": строка, содержит ссылку на архив последней редакции документа (вложений и ЭП).
  • "СсылкаНаPDF": строка, содержит ссылку на pdf документ, где вложением является формализованный документ с "впечатанными" данными ЭП. Пустое значение означает невозможность получения представления формализованного документа в PDF.
  • "Состояние": объект, состояние документа.
  •  "Редакция": массив объектов, информация о редакции документа.
    • "Идентификатор": строка, используется для адресации редакции документа.
    • "Актуален": строка "Да"/"Нет", "Нет" возвращается, если есть более новая редакция.
    • "ПримечаниеИС": строка, произвольное примечание информационной системы.
    • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время создания редакции.
  • "Регламент": объект, информация о регламенте документооборота.
    • "Идентификатор": строка.
    • "Название": строка.
  • "ДокументОснование": массив объектов.
    •  "Документ": объект.
      • "Идентификатор": строка.
      • "Дата": строка в формате "ДД.ММ.ГГГГ".
      • "Номер": строка.
      • "Тип": строка.
    • "ВидСвязи": строка.
    • "Сумма": строка.
  • "ДокументСледствие": массив объектов.
  • "НашаОрганизация": объект, описывает нашу организацию по документу:
    • "СвЮЛ": объект:
      • "ИНН": строка, 10 символов.
      • "КПП": строка, 9 символов.
      • "КодФилиала", строка.
      • "Название": строка, название организации.
    •  "СвФЛ": объект:
      • "ИНН": строка, 12 символов.
      • "Фамилия": строка.
      • "Имя": строка.
      • "Отчество": строка.
  • "Контрагент": объект, описывает контрагента по документу:
    • "СвЮЛ": объект:
      • "ИНН": строка, 10 символов.
      • "КПП": строка, 9 символов.
      • "КодФилиала", строка.
      • "Название": строка, название организации.
    • "СвФЛ": объект.
      • "ИНН": строка, 12 символов.
      • "Фамилия": строка.
      • "Имя": строка.
      • "Отчество": строка.
    • "Подразделение": объект (только на запись, не возвращается).
      • "Идентификатор": строка, код подразделения на стороне контрагента.
    • "Телефон": строка.
    • "Email": строка.
  • "Исполнитель" объект:
    • "Фамилия": строка.
    • "Имя": строка.
    • "Отчество": строка.
    • "Идентификатор": строка, табельный номер (идентификатор).
  • "Подразделение": объект:
    • "Название": строка, название подразделения.
    • "Идентификатор": строка, код подразделения.
  • "Ответственный": объект:
    • "Фамилия": строка.
    • "Имя": строка.
    • "Отчество": строка.
    • "Идентификатор": строка, табельный номер (идентификатор).
  • "Автор": объект:
    • "Фамилия": строка
    • "Имя": строка
    • "Отчество": строка
    • "Идентификатор": строка, табельный номер (идентификатор)
  • "Вложение": массив объектов (вложений документа):
    • "Идентификатор": строка, используется для адресации вложения.
    • "Тип": строка, название типа формализованного вложения.
    • "Подтип": строка, название подтипа формализованного вложения.
    • "ВерсияФормата": строка, определяется по содержимому формализованного вложения.
    • "ПодверсияФормата": строка, определяется по содержимому формализованного вложения.
    • "Название": строка, название вложения. В случае отсутствия генерируется по реквизитам из тела формализованного вложения, может быть пустым для неформализованного вложения.
    • "Удален": строка "Да"/"Нет", флаг удаления вложения.
    • "УдаленКонтрагентом": строка "Да"/"Нет", флаг удаления вложения получателем (для внешнего документооборота).
    • "Модифицирован": строка "Да"/"Нет", признак внесения изменений в тело вложения. Служит для определения необходимости обновления в информационной системе (взводится, как правило, после модификации в результате подготовки к этапу документооборота, когда меняется, например, подписант или проставляется идентификатор участника документооборота).
    • "Служебный": строка, значение "Да" - признак служебного вложения, "Нет" – первичного вложения.
    • "Дата": строка в формате "ДД.ММ.ГГГГ", извлекается из тела формализованного вложения, дата загрузки для неформализованного вложения.
    • "Номер": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения.
    • "Сумма": строка, извлекается из тела формализованного вложения, пустое для неформализованного вложения.
    • "Направление": строка, указывает направление конкретного вложения (т.е. это может быть "входящее" вложение "исходящего" документа, например, "подтверждение даты получения" от оператора).
    • "СсылкаНаHTML": строка, ссылка для скачивания данных HTML представления (допустимо только для формализованных вложений). Пустое значение означает невозможность возврата представления.
    • "СсылкаНаPDF": строка, ссылка для скачивания данных PDF представления (допустимо только для формализованных вложений). Пустое значение означает невозможность возврата представления.
    • "Редакция": объект:
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время создания редакции вложения.
      • "Номер": строка, номер редакции по порядку (исходная версия имеет номер "1"), нумерация непрерывная (если одно и тоже вложение записывалось в разных редакциях, у них будут разные номера).
    • "Файл": объект:
      • "Имя": строка, имя файла.
      • "Ссылка": строка, ссылка для скачивания бинарных данных HTTP GET запросом.
      • "ДвоичныеДанные": строка в кодировке Bаse64, используется для отправки содержимого бинарных данных на сервер. Размер не более 33 Мб.
      • "Хеш": строка в Base64, криптографический хеш загруженных бинарных данных. 
    • "Подпись": массив объектов:
      • "Сертификат": объект, реквизиты владельца сертификата ЭП. Объект возвращается не во всех вызовах.
        • "ФИО": строка, подписант.
        • "Должность": строка.
        • "ИНН": строка.
        • "Название": строка, название организации.
        • "Отпечаток": строка, отпечаток.
        • "СерийныйНомер": строка, серийный номер.
        • "Издатель": строка, издатель сертификата.
        • "Квалифицированный": строка "Да"/"Нет".
        • "ДействителенС": дата и время.
        • "ДействителенПо": дата и время/
      • "Файл": объект:
        • "Имя": строка, совпадает с именем файла документа, к которому относится, дополненная строкой ".sgn" для первой подписи, "2.sgn" второй и других.
        • "Ссылка": строка, ссылка для скачивания бинарных данных HTTP GET запросом.
        • "ДвоичныеДанные": строка в кодировке Base64 , используется для отправки содержимого бинарных данных на сервер.
    • "Событие": массив объектов:
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС", дата и время окончания события.
      • "Название": строка.
      • "Идентификатор": строка, уникальный идентификатор события.
      • "Комментарий": строка, комментарий, оставленный пользователем или системой.
      • "Вложение": массив объектов, описание совпадает с "Документ.Вложение", содержит вложения, ассоциированные с событием:
    • "Этап": массив объектов:
      • "Название": строка, список типов документов.
      • "Идентификатор": строка, уникальный идентификатор, следует сохранить и передавать на сервер при подготовке и выполнения действия над документом/
      • "Служебный": строка "Да"/"Нет"/
      • "Вложение": массив объектов, описание совпадает с разделом "Документ.Вложение", содержит вложения, которые необходимо подписать для выполнения этапа/
      • "Действие": массив объектов
        • "Название": строка, список допустимых значений.
        • "ТребуетПодписания": строка "Да"/"Нет", "Да" означает требование регламента осуществить подписание вложений перед завершением этапа (указать информацию о подписанте подготовке этапа).
        • "ТребуетКомментария": строка "Да"/"Нет", "Да" означает требование регламента указать комментарий при подготовке к завершению этапа.
        • "Сертификат": массив объектов.
          • "ФИО": строка.
          • "Должность": строка.
          • "ИНН": строка.
          • "Название": строка.
          • "Отпечаток": строка.
          • "СерийныйНомер": строка, серийный номер.
          • "Издатель": строка, издатель сертификата.
          • "Квалифицированный": строка "Да"/"Нет".
          • "ДействителенС": дата и время.
          • "ДействителенПо": дата и время.
          • "Ключ": объект.

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

    На заметку!

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

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

Реквизиты формализованного документа "Дата", "Номер", "Тип", "Подтип", "Версия", "ПодВерсия" и "Название" должны передаваться все вместе, с правильными значениями или не должны передаваться вовсе. В противном случае, переданные реквизиты будут записаны в систему и сделают невозможным либо некорректным отображение документов и генерацию pdf.

1
0
Оставьте свой отзыв:
ОТПРАВИТЬ