Модель данных API-интерфейса

Модель данных API-интерфейса

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

Вся информация, которой пользователи обмениваются через API-интерфейс СБИС, передается объектами «Документ». Такой объект содержит все данные о документе: тип, дату, номер, сумму, сведения о состоянии и др. Также в него входят вложения и их подписи.

Вложением может быть любой файл: счет-фактура в формате .xml, jpg-изображение, текстовый документ .docx и т. д.

На заметку!

Размер исходящего JSON-запроса не должен превышать 100 Мб.

Помимо пользовательских файлов к документу могут прикрепляться служебные вложения, например подтверждение даты получения оператором или извещение о получении. Эти вложения генерирует оператор связи, информационная система или СБИС.

Идентификация документа, вложения, участников

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

Для участия в документообороте пользователю достаточно указать только ИНН и КПП, свои и получателя. В объекте «Документ» эти сведения передаются в параметрах:

На стороне получателя реквизиты в полях меняются местами: в поле «Документ.Контрагент» будут указаны сведения о вашей организации, а в «Документ.НашаОрганизация» — данные о контрагенте.

Состояние и этапы документооборота

Чтобы система могла отслеживать состояние документа, в объекте «Документ» предусмотрены:

Событие происходит при выполнении действия с этапом. Например, если руководитель утвердит документ на этапе «Согласование», сформируется событие «Уведомление о приеме». Запись об этом появится в параметре «Документ.Событие».

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