DocumentTypeDescriptionV2

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

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

message DocumentTypeDescriptionV2 {
    required string Name = 1;
    required string Title = 2;
    repeated int32 SupportedDocflows = 3;
    required bool RequiresFnsRegistration = 4;
    repeated DocumentFunctionV2 Functions = 9;
}

• Name — строковый идентификатор типа документа.

• Title — заголовок типа документа, например, «Счет-фактура».

• SupportedDocflows — поддерживаемые типы документооборота. Каждый элемент списка может принимать одно из значений:

  • 0 — внешний документооборот;

  • 1 — внутренний документооборот.

• RequiresFnsRegistration — признак того, что для работы требуется заявление участника ЭДО.

• Functions — список функций документа. Каждая функция представлена структурой DocumentFunctionV2.

DocumentFunctionV2

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

message DocumentFunctionV2 {
    required string Name = 1;
    repeated DocumentVersionV2 Versions = 2;
}

• Name — строковой идентификатор функции. Уникальный в рамках типа документа.

• Versions — cписок версий документа. Каждая версия представлена структурой DocumentVersionV2.

DocumentVersionV2

Данные версии документа.

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

• Version — версия документа.

• SupportsContentPatching— признак того, что тип поддерживает подготовку к подписанию документа.

• SupportsEncrypting — признак того, что тип поддерживает отправку зашифрованных документов.

• SupportsPredefinedRecipientTitle— признак того, что тип поддерживает отправку предопределенного титула получателя.

• SupportsAmendmentRequest— признак того, что тип поддерживает отправку запроса на уточнение.

• Titles — список титулов документов. Каждый титул представлен структурой DocumentTitleV2.

• IsActual — признак того, что версия документа актуальна.

• workflows — список видов документооборота для текущего типа. Каждый вид представлен структурой DocumentWorkflow.

DocumentTitleV2

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

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

• Index — числовой идентификатор титула. Указывает, в каком порядке контрагенты загружают титулы. Всегда начинается с 0.

• IsFormal — признак того, что титул является формализованным.

• XsdUrl— URL-путь метода, возвращающего файл XSD-схемы титула.

• UserDataXsdUrl — URL-путь метода, возвращающего XSD-схему UserDataXsd для генерации титула с помощью метода GenerateTitleXml. Если отсутствует, то генерация титула под этим индексом не реализована.

• SignerInfo — информация о подписанте титула, представленная структурой SignerInfoV2.

• MetadataItems — метаданные документа, представленные структурой DocumentMetadataItemV2.

• EncryptedMetadataItems — метаданные зашифрованного документа, представленные структурой DocumentMetadataItemV2.

SignerInfoV2

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

message SignerInfoV2 {
    required int32 SignerType = 1;
    required int32 ExtendedDocumentTitleType = 2 [default = -1];
    optional string SignerUserDataXsdUrl = 3;
}

• SignerType — тип заполнения данных подписанта титула. Принимает одно из следующих значений:

  • 0 — подписант отсутствует, формируется только файл открепленной подписи. Используется для неформализованных документов.

  • 1 — заполнение данных подписанта в упрощенном формате. Формат устарел и больше не используется. Применялся для документов в форматах приказов №93 и 172 и своих типов документов не на базе формата приказа №155.

  • 2 — заполнение данных подписанта в расширенном формате. Используется для документов в форматах приказов №551, 552 и 736.

  • 3 — заполнение данных подписанта в универсальном формате. Используется, если заполнено поле SignerUserDataXsdUrl.

• ExtendedDocumentTitleType — тип титула документа, для которого нужно заполнить дополнительные данные подписанта. Принимает одно из следующих значений:

  • -1 — указывается для типов подписанта 0, 1 или 3,

  • 0 — данные для титула продавца УПД,

  • 1 — данные для титула покупателя УПД,

  • 2 — данные для титула продавца УКД,

  • 3 — данные для титула покупателя УКД,

  • 4 — данные для титула продавца формата приказа №551,

  • 5 — данные для титула покупателя формата приказа №551,

  • 6 — данные для титула исполнителя формата приказа №552,

  • 7 — данные для титула для титула заказчика формата приказа №552,

  • 8 — данные для титула покупателя УПД формата приказа №970 приложения 2 (устарел),

  • 9 — данные для титула покупателя Торг-2 формата приказа №423,

  • 10 — данные для титула продавца Торг-2 формата приказа №423,

  • 11 — данные для титула покупателя УКД формата приказа №736,

  • 12 — данные для титула продавца УПД формата приказа №970,

  • 13 — данные для титула покупателя УПД формата приказа №970,

  • 14 — данные для титула счета на оплату или счета-оферты формата приказа №29.

• SignerUserDataXsdUrl — URL-путь метода, возвращающего файл XSD-схемы упрощенного XML подписанта.

DocumentMetadataItemV2

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

message DocumentMetadataItemV2 {
    required string Id = 1;
    required int32 Type = 2;
    required bool IsRequired = 3;
    required int32 Source = 4;
}

• Id — идентификатор метаданных.

• Type — тип значения метаданных. Принимает одно из следующих значений:

  • 0 — строка,

  • 1 — целое число,

  • 2 — число с десятичной точкой,

  • 3 — дата в формате ДД.ММ.ГГГГ,

  • 4 — время в формате чч:мм.

• IsRequired — признак того, что заполнение метаданных обязательно.

• Source — источник метаданных. Принимает одно из следующих значений:

  • 0 — метаданные содержатся в теле документа;

  • 1 — метаданные передаются в метод API отдельными полями.

---

См. также

Структура используется:

• в теле ответа метода GetDocumentTypes (V2)