DocumentTypeDescription

Предупреждение

Структура устарела. Вместо нее используется структура DocumentTypeDescriptionV2.

На этой странице, помимо DocumentTypeDescription, описаны следующие структуры:

Описание типа документа.

message DocumentTypeDescription {
    required string Name = 1;
    required string Title = 2;
    repeated DocumentDocflow SupportedDocflows = 3;
    required bool RequiresFnsRegistration = 4;
    repeated DocumentFunction Functions = 9;
}

enum DocumentDocflow {
    External = 0;
    Internal = 1;
}

Name — строковый идентификатор типа документа.
Title — заголовок типа документа, например, «Счет-фактура».
SupportedDocflows — поддерживаемые типы документооборота. Каждый элемент списка принимает значение из перечисления DocumentDocflow:
- External — внешний документооборот;
- Internal — внутренний документооборот.
RequiresFnsRegistration — признак того, что для работы требуется заявление участника ЭДО.
Functions — список функций документа. Каждая функция представлена структурой DocumentFunction.

DocumentFunction 

Функция документа.

message DocumentFunction {
    required string Name = 1;
    repeated DocumentVersion Versions = 2;
}

Name — строковой идентификатор функции. Уникальный в рамках типа документа.
Versions — cписок версий документа. Каждая версия представлена структурой DocumentVersion.

DocumentVersion 

Версия документа.

message DocumentVersion {
    required string Version = 1;
    required bool SupportsContentPatching = 2;
    required bool SupportsEncrypting = 3;
    required bool SupportsPredefinedRecipientTitle = 7;
    required bool SupportsAmendmentRequest = 8;
    repeated DocumentTitle Titles = 4;
    required bool IsActual = 5;
    repeated DocumentWorkflow workflows = 6;
}

Version — идентификатор версии. Уникальный в рамках функции документа.
SupportsContentPatching— признак того, что тип поддерживает подготовку к подписанию документа.
SupportsEncrypting — признак того, что тип поддерживает отправку зашифрованных документов.
SupportsPredefinedRecipientTitle— признак того, что тип поддерживает отправку предопределенного титула получателя.
SupportsAmendmentRequest— признак того, что тип поддерживает отправку запрос на уточнение.
Titles — список титулов документов. Каждый титул представлен структурой DocumentTitle.
IsActual — признак того, что версия документа актуальна.
workflows — список видов документооборота для текущего типа. Каждый вид представлен структурой DocumentWorkflow.

DocumentTitle 

Данные титула документа.

message DocumentTitle {
    required int32 Index = 7;
    required bool IsFormal = 1;
    optional string XsdUrl = 2;
    optional string UserDataXsdUrl = 5;
    required SignerInfo SignerInfo = 6;
    repeated DocumentMetadataItem MetadataItems = 3;
    repeated DocumentMetadataItem EncryptedMetadataItems = 4;
}

Index — числовой идентификатор титула. Указывает, в каком порядке контрагенты загружают титулы. Всегда начинается с 0.
IsFormal — признак того, что титул является формализованным.
XsdUrl— URL-путь метода, возвращающего файл XSD-схемы титула.
UserDataXsdUrl — URL-путь метода, возвращающего XSD-схему UserDataXsd для генерации титула с помощью метода GenerateTitleXml. Если отсутствует, то генерация титула под этим индексом не реализована.
SignerInfo — информация о подписанте титула, представленная структурой SignerInfo.
MetadataItems — метаданные документа, представленные структурой DocumentMetadataItem.
EncryptedMetadataItems — метаданные зашифрованного документа, представленные структурой DocumentMetadataItem.

SignerInfo 

Данные подписанта титула.

message SignerInfo {
    required SignerType SignerType = 1;
    required DocumentTitleType ExtendedDocumentTitleType = 2 [default = Absent];
}

enum SignerType {
    None = 0;
    Signer = 1;
    ExtendedSigner = 2;
}

SignerType — тип заполнения подписанта титула. Принимает значение из перечисления SignerType:
- None — подписант отсутствует, формируется только файл открепленной подписи. Используется для неформализованных документов.
- Signer — заполнение данных подписанта в упрощенном формате. Формат устарел и больше не используется. Применялся для документов в форматах приказов №93 и 172 и своих типов документов не на базе формата приказа №155.
- ExtendedSigner — заполнение данных подписанта в расширенном формате. Используется для документов в форматах приказов №551 и 552.
ExtendedDocumentTitleType — тип титула документа, для которого нужно заполнить дополнительные данные о подписанте. Представлен структурой DocumentTitleType. Для типов подписанта None и Signer значение всегда равно Absent.

DocumentMetadataItem 

Метаданные документа.

message DocumentMetadataItem {
    required string Id = 1;
    required DocumentMetadataItemType Type = 2;
    required bool IsRequired = 3;
    required DocumentMetadataSource Source = 4;
}

enum DocumentMetadataItemType {
    String = 0;
    Integer = 1;
    Decimal = 2;
    Date = 3;
    Time = 4;
}

enum DocumentMetadataSource {
    Xml = 0;
    User = 1;
}

Id — идентификатор метаданных.
Type — тип значения метаданных. Принимает значение из перечисления DocumentMetadataItemType:
- String — строка,
- Integer — целое число,
- Decimal — число с десятичной точкой,
- Date — дата в формате ДД.ММ.ГГГГ,
- Time — время в формате чч:мм.
IsRequired — признак того, что заполнение метаданных обязательно.
Source — источник метаданных. Принимает значение из перечисления DocumentMetadataSource:
- Xml — метаданные содержатся в теле документа;
- User — метаданные передаются в метод API отдельными полями.

DocumentTypeDescription

DocumentFunction

DocumentVersion

DocumentTitle

SignerInfo

DocumentMetadataItem