Титул
Титул — файл документа, содержащий информацию, предназначенную для передачи от одной стороны документооборота другой. Титул является одной из сущностей в сообщении.
В формализованных документах титул представлен отдельным XML-файлом, соответствующим установленной XSD-схеме. XSD-схемы титулов последней версии форматов можно получить с помощью метода GetDocumentTypes (V3). Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.
В неформализованных документах титулом является сам файл документа. Такой титул не имеет установленного формата.
Количество титулов
Неформализованный документ состоит из одного титула, а формализованный может включать в себя один или два титула. Количество титулов зависит от типа, версии и функции документа. Узнать количество титулов в документе можно из ответа метода GetDocumentTypes (V3).
Если версия документа подразумевает наличие одного титула, то титул заполняет и подписывает отправитель документа. В этом случае титул содержит все данные документа. Примеры: счет-фактура, счет на оплату. Такие документы называются однотитульными.
Если версия документа подразумевает наличие нескольких титулов, то каждый участник документооборота заполняет, подписывает и отправляет свой титул. Примеры: товарная накладная, УПД с функцией ДОП, заказ-заявка. Такие документы называют многотитульными.
Ожидаемый титул
Ожидаемый титул — титул, который еще не получен, но который по виду документооборота нужно и возможно отправить. У ожидаемого титула известны индекс TitleIndex и будущий автор, но самого титула и подписи под ним в документе нет.
Ожидаемые титулы возвращаются вместе с полученными, чтобы заранее было видно, какие титулы предстоит отправить. Например, в случае с ЭТрН: если отправитель сформировал первый титул, в списке титулов уже есть ожидаемый титул перевозчика — до того, как перевозчик его отправит.
Титул по запросу (OptionalTitle) ожидаемым не считается: он появляется в списке титулов, только когда участник решит его отправить.
Ожидаемые титулы возвращаются в полях:
Titlesструктуры DocflowV5 — у ожидаемого титула заполненыTitleIndex,AuthorиAuthorSigning, аVersionиTitleне заполняются;TitleDocflowsструктуры Document — у ожидаемого титула заполненыTitleIndex,AuthorиAuthorSignatureStatus, аTitleEntityId,TitleAttachmentFilename,TitleDisplayFilenameиParticipantDocflowsне заполняются.
Содержание титула
В широком смысле титул содержит в себе сведения о документе и об участниках документооборота, но титулы разных типов отличаются друг от друга. Например, титул продавца УПД содержит реквизиты продавца и покупателя, информацию о товарах и сведения об отпуске груза, а титул покупателя УПД содержит только сведения о получении груза.
См. также
Представление в API:
- Document — данные документа
Инструкции:
- Многотитульные документы
- Получение информации о типе документа
- Генерация формализованного документа
- Парсинг формализованного документа
Методы для работы с титулом:
- DetectDocumentTitles — определяет возможные типы указанного документа
- GenerateTitleXml — генерирует файл титула формализованного документа
- ParseTitleXml — парсит файл титула формализованного документа