Перейти к основному содержимому

Entity

Данные сущности, входящей в сообщение или в дополнение к сообщению.

message Entity {
required EntityType EntityType = 1;
required string EntityId = 2;
optional string AuthorUserId = 33;
optional string ParentEntityId = 3;
optional Content Content = 4;
required AttachmentType AttachmentType = 5;
optional string FileName = 6;
optional bool NeedRecipientSignature = 7 [default = false];
optional string SignerBoxId = 8;
optional string NotDeliveredEventId = 10;
optional Document DocumentInfo = 11;
optional sfixed64 RawCreationDate = 12 [default = 0];
optional ResolutionInfo ResolutionInfo = 13;
optional string SignerDepartmentId = 14;
optional ResolutionRequestInfo ResolutionRequestInfo = 15;
optional ResolutionRequestDenialInfo ResolutionRequestDenialInfo = 16;
optional bool NeedReceipt = 17 [default = false];
optional string PacketId = 18;
optional bool IsApprovementSignature = 19 [default = false];
optional bool IsEncryptedContent = 20 [default = false];
optional string AttachmentVersion = 21;
optional ResolutionRouteAssignmentInfo ResolutionRouteAssignmentInfo = 22;
optional ResolutionRouteRemovalInfo ResolutionRouteRemovalInfo = 23;
optional CancellationInfo CancellationInfo = 24;
repeated string Labels = 25;
optional string Version = 26;
optional TemplateTransformationInfo TemplateTransformationInfo = 27;
optional TemplateRefusalInfo TemplateRefusalInfo = 28;
optional OuterDocflows.OuterDocflowInfo OuterDocflow = 29;
optional RevocationRequestInfo RevocationRequestInfo = 30;
optional string ContentTypeId = 31;
optional PowerOfAttorneyInfo PowerOfAttorneyInfo = 32;
optional MoveDocumentInfo MoveDocumentInfo = 34;
optional Docflow.PowerOfAttorneyAttachmentStatus PowerOfAttorneyAttachmentStatus = 35;
optional UniversalMessageInfo UniversalMessageInfo = 36;
optional TemplateTransformationChangeInfo TemplateTransformationChangeInfo = 37;
}

enum EntityType {
Attachment = 1;
Signature = 2;
}

enum AttachmentType {
UnknownAttachmentType = -1;
Nonformalized = 0;
Invoice = 1;
InvoiceReceipt = 2;
InvoiceConfirmation = 3;
InvoiceCorrectionRequest = 4;
AttachmentComment = 5;
DeliveryFailureNotification = 6;
SignatureRequestRejection = 8;
SignatureVerificationReport = 10;
TrustConnectionRequest = 11;
Torg12 = 12;
InvoiceRevision = 13;
InvoiceCorrection = 14;
InvoiceCorrectionRevision = 15;
AcceptanceCertificate = 16;
StructuredData = 17;
ProformaInvoice = 18;
XmlTorg12 = 19;
XmlAcceptanceCertificate = 20;
XmlTorg12BuyerTitle = 21;
XmlAcceptanceCertificateBuyerTitle = 22;
Resolution = 23;
ResolutionRequest = 24;
ResolutionRequestDenial = 25;
PriceList = 26;
Receipt = 27;
XmlSignatureRejection = 28;
RevocationRequest = 29;
PriceListAgreement = 30;
CertificateRegistry = 34;
ReconciliationAct = 35;
Contract = 36;
Torg13 = 37;
ServiceDetails = 38;
RoamingNotification = 39;
SupplementaryAgreement = 40;
UniversalTransferDocument = 41;
UniversalTransferDocumentBuyerTitle = 42;
UniversalTransferDocumentRevision = 45;
UniversalCorrectionDocument = 49;
UniversalCorrectionDocumentRevision = 50;
UniversalCorrectionDocumentBuyerTitle = 51;
CustomData = 64;
MoveDocument = 65;
ResolutionRouteAssignmentAttachment = 66;
ResolutionRouteRemovalAttachment = 67;
Title = 68;
Cancellation = 69;
Edition = 71;
DeletionRestoration = 72;
TemplateTransformation = 73;
TemplateRefusal = 74;
OuterDocflow = 75;
RoamingConfirmation = 76;
PowerOfAttorney = 77;
PowerOfAttorneyStatus = 78;
UniversalMessage = 79;
TtGisFixationCancellationRequest = 87;
TemplateTransformationChange = 90;
}
  • EntityType — тип сущности, принимает значение из перечисления EntityType:
  • EntityId — идентификатор сущности.
  • ParentEntityId — идентификатор родительской сущности. Например, для сущности с типом Signature это будет идентификатор соответствующей сущности с типом Attachment.
  • Content — содержимое сущности, представленное структурой Content. Если у сущности не предусмотрено содержимое, то в поле Content вернется значение null. В остальных случаях в поле Content.Data будут содержаться данные:
    • для сущности с типом Signature — электронная подпись в формате CMS SignedData в DER-кодировке;
    • для сущности с типом Attachment — массив байтов с данными, которые интерпретируются в зависимости от типа вложения AttachmentType: подробнее в таблице ниже.

Содержимое Content.Data в зависимости от AttachmentType

AttachmentTypeContent.Data
  • AcceptanceCertificat
  • Contract
  • Nonformalized
  • PriceList
  • ProformaInvoice
  • ReconciliationAct
  • ServiceDetails
  • StructuredData
  • SupplementaryAgreement
  • Torg12
  • Torg13
  • TrustConnectionRequest
Двоичное содержимое исходного файла
  • AttachmentComment
  • Cancellation
  • CustomData
  • DeliveryFailureNotification
  • Resolution
  • ResolutionRequest
  • ResolutionRequestDenial
  • ResolutionRouteAssignmentAttachment
  • ResolutionRouteRemovalAttachment
  • RoamingNotification
  • SignatureRequestRejection
  • TemplateRefusal
Строка в кодировке UTF-8
  • Title
  • UniversalCorrectionDocument
  • UniversalCorrectionDocumentBuyerTitle
  • UniversalCorrectionDocumentRevision
  • UniversalTransferDocument
  • UniversalTransferDocumentBuyerTitle
  • UniversalTransferDocumentRevision
XML-файл титула
  • XmlAcceptanceCertificate
  • XmlAcceptanceCertificateBuyerTitle
  • XmlTorg12
  • XmlTorg12BuyerTitle
XML-файлы накладных и актов в формате, утвержденном ФНС России
  • Invoice
  • InvoiceConfirmation
  • InvoiceCorrection
  • InvoiceCorrectionRequest
  • InvoiceCorrectionRevision
  • InvoiceReceipt
  • InvoiceRevision
XML-файлы документов, которыми продавец и покупатель обмениваются
в ходе выставления/получения электронных счетов-фактур согласно порядку, утвержденному Минфином России
  • RoamingConfirmation
XML-файл подтверждения даты отправки с информацией и подписью отправителя в формате,
утвержденном ФНС России
  • CertificateRegistry
  • Edition
  • Receipt
  • RevocationRequest
  • XmlSignatureRejection
  • UniversalMessage
XML-файл в соответствующем формате
  • OuterDocflow
Содержимое внешнего документооборота в произвольном формате
  • PriceListAgreement
Cодержимое ценового листа в форматах HTML, XML, XLSX
  • SignatureVerificationReport
Структура SignatureVerificationResult, сериализованная в протобуфер
  • DeletionRestoration
  • MoveDocument
  • PowerOfAttorney
  • PowerOfAttorneyStatus
  • TemplateTransformation
Нет содержимого
  • AttachmentType — тип вложения (пользовательского или служебного документа). Имеет смысл только для сущностей с типом EntityType = Attachment. Принимает значение из перечисления AttachmentType:

    • UnknownAttachmentType — неизвестное значение: клиент использует устаревшую версию SDK и не может интерпретировать ответ.
    • Nonformalized — неформализованный документ.
    • Invoice — счет-фактура.
    • InvoiceRevision — исправление счета-фактуры.
    • InvoiceCorrection — корректировочный счет-фактура.
    • InvoiceCorrectionRevision — исправление корректировочного счета-фактуры.
    • InvoiceReceipt — извещение о получении счета-фактуры, подтверждения оператора электронного документооборота или уведомления об уточнении счета-фактуры.
    • InvoiceConfirmation — подтверждение оператора электронного документооборота.
    • InvoiceCorrectionRequest — уведомление об уточнении.
    • AttachmentComment — комментарий к другому вложению (пользовательскому или служебному документу).
    • DeliveryFailureNotification — уведомление о невозможности доставки сообщения.
    • SignatureRequestRejection — отказ в формировании запрошенной подписи.
    • SignatureVerificationReport — протокол проверки подписи, сформированный Диадоком. Возвращается для каждой подписи под отправленными документами, если при проверке хотя бы одной из них были обнаружены ошибки.
    • TrustConnectionRequest — запрос на инициацию канала обмена документами через Диадок.
    • ProformaInvoice — счет на оплату.
    • Torg12 — товарная накладная ТОРГ-12.
    • AcceptanceCertificate — акт о выполнении работ или оказании услуг.
    • XmlTorg12 — товарная накладная ТОРГ-12 в XML-формате, титул продавца.
    • XmlTorg12BuyerTitle — товарная накладная ТОРГ-12 в XML-формате, титул покупателя.
    • XmlAcceptanceCertificate — акт о выполнении работ / оказании услуг в XML-формате, титул исполнителя.
    • XmlAcceptanceCertificateBuyerTitle — акт о выполнении работ / оказании услуг в XML-формате, титул заказчика.
    • StructuredData — произвольный файл со структурированными данными, описывающими тот или иной документ, представленный в виде печатной формы.
    • Resolution — информация о статусе согласования документа.
    • ResolutionRequest — запрос согласования документа.
    • ResolutionRequestDenial — отказ в запросе подписи документа.
    • PriceList — ценовой лист.
    • PriceListAgreement — протокол согласования цены.
    • CertificateRegistry — реестр сертификатов.
    • ReconciliationAct — акт сверки.
    • Contract — договор.
    • Torg13 — накладная ТОРГ-13.
    • ServiceDetails — детализация.
    • Receipt — извещение о получении.
    • XmlSignatureRejection — формализованный отказ в подписи.
    • RevocationRequest — предложение об аннулировании.
    • RoamingNotification — роуминговая квитанция.
    • SupplementaryAgreement — дополнительное соглашение к договору.
    • CustomData — произвольные данные к документу.
    • MoveDocument — информация о перемещении документа в подразделение.
    • ResolutionRouteAssignmentAttachment — информация о запуске документа по маршруту согласования.
    • ResolutionRouteRemovalAttachment — информация о снятии документа с маршрута согласования.
    • Title — титул документа. Возвращается для всех типов документов, кроме типов от 0 (AttachmentType = Nonformalized) до 51 (AttachmentType = UniversalCorrectionDocumentBuyerTitle). Это сделано для сохранения обратной совместимости: для первых титулов (титулов отправителя) с типами от Nonformalized до UniversalCorrectionDocumentBuyerTitle возвращается соответствующее значение, например, Invoice для счета-фактуры и т.п.
    • Cancellation — информация об отмене сущности, которая указана родительской по отношению к данной.
    • Edition — информация о редактировании содержимого документа, который указан родительским по отношению к данной сущности.
    • DeletionRestoration — восстановление удаленного документа.
    • TemplateTransformation — информация о трансформации.
    • TemplateRefusal — информация об отклонении или отзыве шаблона.
    • OuterDocflow — информация о внешнем документообороте.
    • RoamingConfirmation — подтверждение оператора, отправленное в роуминг или полученное из роуминга.
    • PowerOfAttorney — информация о машиночитаемой доверенности.
    • PowerOfAttorneyStatus — статус проверки машиночитаемой доверенности.
    • UniversalMessage — универсальное сообщение.
    • TtGisFixationCancellationRequest — документ для отмены сведений об отгрузке маркированных товаров.
    • TemplateTransformationChange — изменение, произошедшее с документами, созданными на основе шаблона.

    Неизвестные типы обрабатываются как Nonformalized.

  • FileName — исходное имя файла. Возвращается только для сущностей с типом Attachment кроме машиночитаемой доверенности.

  • NeedRecipientSignature — признак того, что под документом требуется подпись получателя. Возвращается только для сущностей с типом Attachment с типом вложения Nonformalized.

  • SignerBoxId — идентификатор ящика автора данной подписи. Возвращается только для сущностей с типом Signature.

  • NotDeliveredEventId — идентификатор сообщения или патча, который не удалось доставить (например, из-за некорректности одной или нескольких подписей в нем). Получить недоставленную часть сообщения можно с помощью метода GetEvent (V3), передав в качестве параметра eventId значение NotDeliveredEventId. Возвращается только для сущностей с типом Attachment с типом вложения DeliveryFailureNotification.

  • DocumentInfo — расширенная информация о документе, представленная структурой Document. Возвращается только для первых титулов документов.

  • RawCreationDate — время создания сущности, целое число тиков (100-наносекундных интервалов), прошедших с момента времени 00:00:00 01.01.0001.

  • ResolutionInfo — информация о согласовании, представленная структурой ResolutionInfo. Возвращается только для сущностей с типом Attachment с типом вложения Resolution.

  • SignerDepartmentId — идентификатор подразделения, в котором лежала сущность в момент подписания. Возвращается только для сущностей с типом Signature.

  • ResolutionRequestInfo — информация о запросе согласования, представленная структурой ResolutionRequestInfo. Возвращается только для сущностей с типом Attachment с типом вложения ResolutionRequest.

  • ResolutionRequestDenialInfo — информация об отказе в запросе подписи, представленная структурой ResolutionRequestDenialInfo. Возвращается только для сущностей с типом Attachment с типом вложения ResolutionRequestDenial.

  • NeedReceipt — признак того, что от получателя требуется сформировать извещение о получении документа. Возвращается только для сущностей с типом Attachment.

  • IsApprovementSignature — признак того, что подпись является согласующей. Возвращается только для сущностей с типом Signature.

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

  • AttachmentVersion — Поле устарело, используйте значение поля Version. Информация о версии XSD-схемы, в соответствии с которой сформирована данная сущность.

  • ResolutionRouteAssignmentInfo — информация о запуске документа по маршруту согласования, представленная структурой ResolutionRouteAssignmentInfo. Возвращается только для сущностей с типом Attachment с типом вложения ResolutionRouteAssignment.

  • ResolutionRouteRemovalInfo — информация о снятии документа с маршрута согласования, представленная структурой ResolutionRouteRemovalInfo. Возвращается только для сущностей с типом Attachment с типом вложения ResolutionRouteRemoval.

  • CancellationInfo — информация об отмене сущности, представленная структурой CancellationInfo. Отмененной является сущность, которая указана родительской по отношению к данной. Например, это может быть идентификатор запроса на согласование. Возвращается только для сущностей с типом Attachment с типом вложения Cancellation.

  • Labels — список меток.

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

  • TemplateTransformationInfo — информация о документе, созданном на основе шаблона, представленная структурой TemplateTransformationInfo. Возвращается только для сущностей с типом Attachment с типом вложения TemplateTransformation.

  • TemplateRefusalInfo — информация об отклонении или отзыве шаблона, представленная структурой TemplateRefusalInfo. Возвращается только для сущностей с типом Attachment с типом вложения TemplateRefusal.

  • OuterDocflow — информация о внешнем документообороте, например, о статусе обработки документа с маркированными товарами в ГИС МТ «Честный ЗНАК». Представлена структурой OuterDocflowInfo. Возвращается только для сущностей с типом Attachment с типом вложения OuterDocflow.

  • RevocationRequestInfo — информация о соглашении об аннулировании, представленная структурой RevocationRequestInfo. Возвращается только для сущностей с типом Attachment с типом вложения RevocationRequest.

  • ContentTypeId — идентификатор типа содержимого документа, единый для документов с одинаковой структурой и одинаковыми правилами обработки. То есть каждый тип документа, титул и служебный документ имеет свой идентификатор. Например, УПД формата приказа №970 с функцией СЧФДОП будет иметь идентификатор для первого титула utd970_schfdop_orig_t1_05_03_01, для второго титула — utd970_schfdop_t2_05_03_01, а для отказа в подписи в формате уведомления об уточнении — signature_rejection_02.

  • PowerOfAttorneyInfo — информация о машиночитаемой доверенности и статусе ее проверки, представленная структурой PowerOfAttorneyInfo. Возвращается только для сущностей с типом Attachment с типами вложения PowerOfAttorney и PowerOfAttorneyStatus. Статус проверки машиночитаемой доверенности PowerOfAttorneyValidationStatus возвращается только для сущностей с типом Attachment с типом вложения PowerOfAttorneyStatus. Для машиночитаемой доверенности в поле ParentEntityId возвращается:

    • для вложения с типом PowerOfAttorney — идентификатор подписи,
    • для вложения с типом PowerOfAttorneyStatus — идентификатор МЧД.
  • AuthorUserId — идентификатор пользователя-автора сущности. Возвращается только для сущностей с типом Signature и Attachment со следующими типами вложений:

    • Resolution
    • ResolutionRequest
    • ResolutionRequestDenial
    • ResolutionRouteAssignmentAttachment
    • ResolutionRouteRemovalAttachment
    • OuterDocflow
    • TemplateTransformation
    • TemplateRefusal
    • CustomData
    • Edition
    • MoveDocument
    • RevocationRequest
  • MoveDocumentInfo — информация о перемещении документа в другое подразделение, представленная структурой MoveDocumentInfo. Возвращается только для сущностей с типом Attachment с типом вложения MoveDocument.

  • PowerOfAttorneyAttachmentStatus — статус приложенности машиночитаемой доверенности (МЧД) к подписи, представленный структурой PowerOfAttorneyAttachmentStatus. Возвращается только для сущностей с типом Signature.

  • UniversalMessageInfo — информация об универсальном сообщении, представленная структурой UniversalMessageInfo.

  • TemplateTransformationChangeInfo — информация об изменении документа, созданного на основе шаблона, представленная структурой TemplateTransformationChangeInfo.


См. также

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

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года