Document
Данные документа.
message Document {
optional string IndexKey = 1;
required string MessageId = 2;
required string EntityId = 3;
required sfixed64 CreationTimestampTicks = 4;
optional string CounteragentBoxId = 5;
required DocumentType DocumentType = 6;
repeated DocumentId InitialDocumentIds = 7;
repeated DocumentId SubordinateDocumentIds = 8;
optional Content Content = 9;
optional string FileName = 10;
optional string DocumentDate = 11;
optional string DocumentNumber = 12;
optional NonformalizedDocument.NonformalizedDocumentMetadata NonformalizedDocumentMetadata = 13;
optional InvoiceDocument.InvoiceMetadata InvoiceMetadata = 14;
optional BilateralDocument.TrustConnectionRequestMetadata TrustConnectionRequestMetadata = 15;
optional BilateralDocument.BasicDocumentMetadata Torg12Metadata = 16;
optional InvoiceDocument.InvoiceRevisionMetadata InvoiceRevisionMetadata = 17;
optional InvoiceDocument.InvoiceCorrectionMetadata InvoiceCorrectionMetadata = 18;
optional InvoiceDocument.InvoiceCorrectionRevisionMetadata InvoiceCorrectionRevisionMetadata = 19;
optional AcceptanceCertificateDocument.AcceptanceCertificateMetadata AcceptanceCertificateMetadata = 20;
optional UnilateralDocument.ProformaInvoiceMetadata ProformaInvoiceMetadata = 21;
optional BilateralDocument.BasicDocumentMetadata XmlTorg12Metadata = 22;
optional BilateralDocument.BasicDocumentMetadata XmlAcceptanceCertificateMetadata = 23;
optional bool IsDeleted = 24 [default = false];
optional string DepartmentId = 25;
optional bool IsTest = 26 [default = false];
optional string FromDepartmentId = 27;
optional string ToDepartmentId = 28;
optional BilateralDocument.PriceListMetadata PriceListMetadata = 29;
optional string CustomDocumentId = 30;
optional ResolutionStatus ResolutionStatus = 31;
required RevocationStatus RevocationStatus = 32;
optional sfixed64 SendTimestampTicks = 33;
optional sfixed64 DeliveryTimestampTicks = 34;
repeated ForwardDocumentEvent ForwardDocumentEvents = 35;
optional BilateralDocument.BasicDocumentMetadata PriceListAgreementMetadataOld = 36;
optional BilateralDocument.BasicDocumentMetadata CertificateRegistryMetadataOld = 37;
optional BilateralDocument.BilateralDocumentMetadata ReconciliationActMetadata = 38;
optional BilateralDocument.ContractMetadata ContractMetadata = 39;
optional BilateralDocument.BasicDocumentMetadata Torg13Metadata = 40;
optional UnilateralDocument.ServiceDetailsMetadata ServiceDetailsMetadata = 41;
required RoamingNotificationStatus RoamingNotificationStatus = 42;
optional bool HasCustomPrintForm = 43 [default = false];
repeated CustomDataItem CustomData = 44;
optional string PacketId = 45;
required DocumentDirection DocumentDirection = 46;
required sfixed64 LastModificationTimestampTicks = 47;
optional bool IsEncryptedContent = 48;
required SenderSignatureStatus SenderSignatureStatus = 49;
optional BilateralDocument.SupplementaryAgreementMetadata SupplementaryAgreementMetadata = 50;
optional bool IsRead = 51 [default = false];
optional string RoamingNotificationStatusDescription = 52;
optional bool PacketIsLocked = 53 [default = false];
optional NonformalizedDocument.NonformalizedDocumentMetadata PriceListAgreementMetadata = 54;
optional NonformalizedDocument.NonformalizedDocumentMetadata CertificateRegistryMetadata = 55;
optional UniversalTransferDocument.UniversalTransferDocumentMetadata UniversalTransferDocumentMetadata = 56;
optional UniversalTransferDocument.UniversalTransferDocumentRevisionMetadata UniversalTransferDocumentRevisionMetadata = 57;
optional UniversalTransferDocument.UniversalCorrectionDocumentMetadata UniversalCorrectionDocumentMetadata = 58;
optional UniversalTransferDocument.UniversalCorrectionDocumentRevisionMetadata UniversalCorrectionDocumentRevisionMetadata = 59;
optional string ResolutionRouteId = 60 [default = ""];
optional string AttachmentVersion = 61;
optional ProxySignatureStatus ProxySignatureStatus = 62;
required string TypeNamedId = 63;
required string Function = 64;
required int32 WorkflowId = 65;
required string Title = 66;
repeated Events.MetadataItem Metadata = 67;
required RecipientReceiptMetadata RecipientReceiptMetadata = 68;
required ConfirmationMetadata ConfirmationMetadata = 69;
required RecipientResponseStatus RecipientResponseStatus = 70;
required AmendmentRequestMetadata AmendmentRequestMetadata = 71;
optional Origin Origin = 72;
optional string EditingSettingId = 73 [default = ""];
required LockMode LockMode = 74;
required SenderReceiptMetadata SenderReceiptMetadata = 75;
required string Version = 76;
repeated LastOuterDocflow LastOuterDocflows = 77;
optional string ProxyBoxId = 78;
optional string ProxyDepartmentId = 79;
required DocflowStatusV3 DocflowStatus = 80;
optional TtGisFixationCancellationStatus TtGisFixationCancellationStatus = 81 [default = TtGisFixationCancellationStatusNone];
optional bool HasUnreadOutOfWorkflowUniversalMessages = 82 [default = true];
repeated DocumentParticipantInfo Participants = 83;
optional AmendmentRequestMetadata RecipientResponseAmendmentRequestMetadata = 84;
repeated TitleDocflowSummary TitleDocflows = 85;
}
enum RoamingNotificationStatus {
RoamingNotificationStatusNone = 1;
RoamingNotificationStatusSuccess = 2;
RoamingNotificationStatusError = 3;
}
-
IndexKey— ключ для постраничного получения списка найденных документов. Его можно передавать в качестве параметраafterIndexKeyв метод GetDocuments (V3): ключ может содержать недопустимые символы, поэтому при вызове метода должен быть закодирован в URL-формат. Возвращается в ответе метода GetDocuments (V3). -
MessageId— идентификатор сообщения, в котором содержится документ. -
EntityId— идентификатор соответствующей документу сущности типаLetterAttachmentвнутри сообщения. -
CreationTimestampTicks— время создания документа, целое число тиков (100-наносекундных интервалов), прошедших с момента времени 00:00:00 01.01.0001. -
CounteragentBoxId— идентификатор ящика контрагента. Значение зависит от направления документа относительно текущего ящика:- если документ исходящий — это идентификатор ящика получателя;
- если документ входящий — это идентификатор ящика отправителя;
- если документ находится в черновиках, поле
CounteragentBoxIdможет быть пустым.
-
InitialDocumentIds— список идентификаторов исходных документов, к которым привязывается этот документ. Каждый идентификатор представлен структурой DocumentId. -
SubordinateDocumentIds— список идентификаторов документов, которые ссылаются на этот документ. Каждый идентификатор представлен структурой DocumentId. -
Content— содержимое документа, представленное структурой Content. При получении документов списком (например, при помощи метода GetDocuments (V3)) полеContent.Dataне заполняется из соображений производительности. -
FileName— имя файла документа при загрузке в Диадок. -
IsDeleted— признак того, что документ был удален. -
DepartmentId— идентификатор подразделения, в котором находится документ. -
IsTest— признак того, что документ является тестовым и не имеет юридической силы, так как ящик одного из контрагентов тестовый. -
FromDepartmentId— идентификатор подразделения, из которого будет отправлен документ. -
ToDepartmentId— идентификатор подразделения, в которое будет отправлен документ. -
CustomDocumentId— идентификатор документа во внешней системе. -
ResolutionStatus— статус согласования документа, представленный структурой ResolutionStatus. -
RevocationStatus— статус аннулирования документа, принимает значения из перечисления RevocationStatus. -
SendTimestampTicks— время отправки документа, целое число тиков (100-наносекундных интервалов), прошедших с момента времени 00:00:00 01.01.0001. Фактически представляет собой время подписания документа отправителем и начало проверки подписи Диадоком. -
DeliveryTimestampTicks— время доставки документа получателю, целое число тиков (100-наносекундных интервалов), прошедших с момента времени 00:00:00 01.01.0001. Фактически представляет собой время появления документа на стороне получателя после всех проверок. Будет заполнено только в случае, если подписи под документом были валидны и документ был доставлен получателю. -
ForwardDocumentEvents— список событий пересылки документа третьей стороне. Каждое событие представлено структурой ForwardDocumentEvent. Документ можно переслать нескольким получателям и несколько раз одному получателю. -
RoamingNotificationStatus— статус доставки в роуминг, принимает значения из перечисленияRoamingNotificationStatus:RoamingNotificationStatusNone— документ не роуминговый или без подтверждения доставки в роуминг;RoamingNotificationStatusSuccess— документ с подтверждением успешной доставки в роуминг;RoamingNotificationStatusError— документ с ошибкой доставки в роуминг.
-
CustomData— список пользовательских данных (тегов), привязанных к документу. Каждый элемент списка представлен структурой CustomDataItem. -
PacketId— идентификатор пакета, в котором находится документ. -
DocumentDirection— направление движения документа, принимает значения из перечисления DocumentDirection. -
LastModificationTimestampTicks— время изменения документа, целое число тиков (100-наносекундных интервалов), прошедших с момента времени 00:00:00 01.01.0001. -
IsEncryptedContent— признак того, что содержимое передаваемого документа зашифровано. -
SenderSignatureStatus— статус подписи отправителя, принимает значения из перечисления SenderSignatureStatus. -
IsRead— признак того, что документ был прочитан сотрудником организации. -
RoamingNotificationStatusDescription— текстовое описание ошибки, возникшей при доставке документов в роуминг. Поле заполняется, когда статус доставки в роумингRoamingNotificationStatusпринимает значениеRoamingNotificationStatusError. -
PacketIsLocked— признак того, что пакет закрытый. -
ResolutionRouteId— идентификатор маршрута согласования, на котором находится документ. -
ProxySignatureStatus— статус промежуточной подписи, принимает значения из перечисления ProxySignatureStatus. -
TypeNamedId— строковый идентификатор типа документа. Доступные типы можно получить с помощью метода GetDocumentTypes (V3). -
Function— функция документа. -
WorkflowId— идентификатор вида документооборота. -
Title— название документа. Например, "Счет-фактура №123 от 26.02.18". -
Metadata— список метаданных документа, представленных структурой MetadataItem. -
RecipientReceiptMetadata— состояние извещения о получении документа со стороны получателя, представленное структурой RecipientReceiptMetadata. -
ConfirmationMetadata— состояние подтверждения оператором даты отправки или получения документа, представленное структурой ConfirmationMetadata. -
RecipientResponseStatus— статус ответного действия получателя — ответную подпись или подписание ответного титула. Принимает значения из перечисления RecipientResponseStatus. -
AmendmentRequestMetadata— состояние уведомления об уточнении первого титула, представленное структурой AmendmentRequestMetadata. -
Origin— сущность, из которой был создан документ, например, из черновика или шаблона. Представлена структурой Origin. -
EditingSettingId— идентификатор настройки редактирования содержимого документа, если он был создан из шаблона с редактируемыми полями. -
LockMode— режим блокировки сообщения, принимает значения из перечисления LockMode. -
SenderReceiptMetadata— состояние извещения о получении титула получателя, представленное структурой SenderReceiptMetadata. -
Version— версия документа. -
LastOuterDocflows— информация о состоянии внешнего документооборота по документу, представленная структурой LastOuterDocflow. -
ProxyBoxId— идентификатор ящика промежуточного получателя. -
ProxyDepartmentId— идентификатор подразделения промежуточного получателя. -
DocflowStatus— статус документооборота, представленный структурой DocflowStatusV3. -
TtGisFixationCancellationStatus— статус подписания документа для отмены сведений об отгрузке маркированных товаров, принимает значения из перечисления TtGisFixationCancellationStatus. -
HasUnreadOutOfWorkflowUniversalMessages— признак того, что у документа есть непрочитанные универсальные сообщения (УС), не влияющие на статус документооборота. -
Participants— список с информацией об участниках документооборота и статусе их ответных действий. Каждый элемент списка представлен структурой DocumentParticipantInfo. -
RecipientResponseAmendmentRequestMetadata— состояние уведомления об уточнении второго титула, представленное структурой AmendmentRequestMetadata. Поле заполняется вне зависимости от наличия второго титула и уточнения по нему. -
TitleDocflows— список с краткой информацией о состоянии каждого титула документа. Каждый элемент списка представлен структурой TitleDocflowSummary.В список входят в том числе ожидаемые титулы: для них не заполняются
TitleEntityId,TitleAttachmentFilename,TitleDisplayFilenameиParticipantDocflows. Для черновиков и шаблонов возвращается только один элемент — информация о титуле отправителя. Статус подписи в нем —WaitingForSenderSignature, а списокParticipantDocflowsбудет пустым.
Устаревшие поля
DocumentType— тип документа, принимает значения из перечисления DocumentType. Для новых типов значение всегда будет равноUnknownDocumentType. Теперь тип документа возвращается в полеTypeNamedId.DocumentDate— дата формирования документа в формате ДД.ММ.ГГГГ. Может отличаться от даты загрузки документа в Диадок. Теперь дата формирования возвращается в полеMetadata.DocumentNumber— номер документа. Теперь номер возвращается в полеMetadata.NonformalizedDocumentMetadata— дополнительные атрибуты неформализованных документов, представленные структурой NonformalizedDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientReceiptMetadataиRecipientResponseStatus.InvoiceMetadata— дополнительные атрибуты счетов-фактур, представленные структурой InvoiceMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientReceiptMetadata,ConfirmationMetadataиAmendmentRequestMetadata.TrustConnectionRequestMetadata— дополнительные атрибуты документов типаTrustConnectionRequest, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientResponseStatus.Torg12Metadata— дополнительные атрибуты товарных накладных ТОРГ-12, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.InvoiceRevisionMetadata— дополнительные атрибуты исправлений счетов-фактур, представленные структурой InvoiceMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientReceiptMetadata,ConfirmationMetadataиAmendmentRequestMetadata.InvoiceCorrectionMetadata— дополнительные атрибуты корректировочных счетов-фактур, представленные структурой InvoiceMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientReceiptMetadata,ConfirmationMetadataиAmendmentRequestMetadata.InvoiceCorrectionRevisionMetadata— дополнительные атрибуты исправлений корректировочных счетов-фактур, представленные структурой InvoiceMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientReceiptMetadata,ConfirmationMetadataиAmendmentRequestMetadata.AcceptanceCertificateMetadata— дополнительные атрибуты актов о выполнении работ или оказании услуг, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.ProformaInvoiceMetadata— дополнительные атрибуты счетов на оплату, представленные структурой ProformaInvoiceMetadata. Теперь атрибуты возвращаются в полеMetadata.XmlTorg12Metadata— дополнительные атрибуты товарных накладных ТОРГ-12 в XML-формате, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.XmlAcceptanceCertificateMetadata— дополнительные атрибуты актов о выполнении работ или оказании услуг в XML-формате, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.PriceListMetadata— дополнительные атрибуты ценовых листов, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.PriceListAgreementMetadataOld— устаревшие дополнительные атрибуты протоколов согласования цены, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.CertificateRegistryMetadataOld— устаревшие дополнительные атрибуты реестров сертификатов, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.ReconciliationActMetadata— дополнительные атрибуты актов сверки, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.ContractMetadata— дополнительные атрибуты договоров, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.Torg13Metadata— дополнительные атрибуты накладных ТОРГ-13, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.ServiceDetailsMetadata— дополнительные атрибуты детализаций, представленные структурой ProformaInvoiceMetadata. Теперь атрибуты возвращаются в полеMetadata.HasCustomPrintForm— признак того, что документ имеет нестандартную печатную форму. Значение всегдаfalse. Для выявления нестандартной печатной формы используйте метод DetectCustomPrintForms.SupplementaryAgreementMetadata— дополнительные атрибуты дополнительного соглашения к договору, представленные структурой BilateralDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.PriceListAgreementMetadata— дополнительные атрибуты протоколов согласования цены, представленные структурой NonformalizedDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.CertificateRegistryMetadata— дополнительные атрибуты реестров сертификатов, представленные структурой NonformalizedDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadataиRecipientResponseStatus.UniversalTransferDocumentMetadata— дополнительные атрибуты УПД, представленные структурой UniversalTransferDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientResponseStatus,ConfirmationMetadataиAmendmentRequestMetadata.UniversalTransferDocumentRevisionMetadata— дополнительные атрибуты исправлений УПД, представленные структурой UniversalTransferDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientResponseStatus,ConfirmationMetadataиAmendmentRequestMetadata.UniversalCorrectionDocumentMetadata— дополнительные атрибуты УКД, представленные структурой UniversalTransferDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientResponseStatus,ConfirmationMetadataиAmendmentRequestMetadata.UniversalCorrectionDocumentRevisionMetadata— дополнительные атрибуты исправлений УКД, представленные структурой UniversalTransferDocumentMetadata. Теперь атрибуты возвращаются в поляхMetadata,RecipientResponseStatus,ConfirmationMetadataиAmendmentRequestMetadata.AttachmentVersion— информация о версии XSD-схемы, в соответствии с которой сформирована данная сущность.
См. также
Структура используется:
- в структуре DocumentList
- в структуре Entity
- в теле ответа метода GetDocument (V3)