Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
313 lines (264 sloc) 27.8 KB

Документы

Объект Document является базовым объектом для всех типов документов. Он обладает базовым набором свойств и методов, которые также работают для всех производных типов документов. Объекты всех производных типов предназначены для:

  • получения данных о документе в системе Диадок
  • выполнением действий, подразумеваемых документооборотом по конкретному типу документа.

Свойства объекта

  • Type (строка, чтение) - тип документа
  • TypeNamedId (строка, чтение) - строковый идентификатор типа документа
  • DocumentFunction (строка, чтение) - функция документа
  • Version (строка, чтение) - информация о версии XSD схемы, в соотвествии с которой сформирован документ
  • Organization (:doc:`Organization <Organization>`, чтение) - организация, которая отправила исходящий документ, либо получила входящий документ
  • OrganizationId (строка, чтение) - идентификатор организации, которой принадлежит документ
  • Counteragent (:doc:`Counteragent <Counteragent>`, чтение) - контрагент документа
  • DocumentId (строка, чтение) - идентификатор документа
  • OneSDocumentId (строка, чтение) - идентификатор документа в 1С
  • PackageId (строка, чтение) - идентификатор пакета
  • Direction (строка, чтение) - направление документа
  • Department (:doc:`Department <Department>`, чтение) - подразделение организации, к которому привязан документ
  • FromDepartment (:doc:`Department <Department>`, чтение) - подразделение организации, из которого был отправлен документ
  • ToDepartment (:doc:`Department <Department>`, чтение) - подразделение организации, в которое был отправлен документ
  • Timestamp (дата и время, чтение) - дата и время отправки документа (в текущем часовом поясе)
  • TimestampSeconds (число, чтение) - дата и время отправки документа в секундах
  • DocumentDate (дата, чтение) - дата документа
  • DocumentNumber (строка, чтение) - номер документа
  • Title (строка, чтение) - название документа, например, "Счет-фактура №123 от 20.02.18"
  • FileName (строка, чтение) - имя файла документа, с которым он загружался в Диадок
  • PathURL (строка, чтение) - URL документа, по которому он доступен в web-интерфейсе
  • InitialDocumentIds (:doc:`коллекция <Collection>` строк, чтение) - коллекция идентификаторов документов, на который ссылается данный документ (т.е. документы, которые по отношению к данному документы являются "родительскими"
  • SubordinateDocumentIds (:doc:`коллекция <Collection>` строк, чтение) - коллекция идентификаторов документов, которые ссылаются на данный документ (т.е. документы, которые по отношению к данному документу являются "дочерними")
  • CustomDocumentId (строка, чтение) - идентификатор документа, определяемый внешней системой
  • RouteId (строка, чтение) - идентификатор маршрута согласования, на котором находится документ
  • WorkflowId (число, чтение) - идентификатор типа документооборота (WorkflowId Diadoc API)
  • Status (строка, чтение) - текущий статус документа в Диадоке. Перечень возможных значений зависит от типа документа и описан в спецификации соответствующего производного объекта.
  • ResolutionStatus (:doc:`ResolutionStatus <ResolutionStatus>`, чтение) - текущий статус согласования документа
  • Resolutions (:doc:`коллекция <Collection>` объектов :doc:`Resolution <Resolution>`, чтение) - история согласования документа
  • ResolutionRequests (:doc:`коллекция <Collection>` объектов :doc:`ResolutionRequest <ResolutionRequest>`, чтение) - коллекция запросов на согласование
  • ResolutionRequestDenials (:doc:`коллекция <Collection>` объектов :doc:`ResolutionRequestDenial <ResolutionRequestDenial>`, чтение) - коллекция объектов отмены запросов на согласование
  • RevocationStatus (строка, чтение) - статус аннулирования документа
  • SenderSignatureStatus (строка, чтение) - статус проверки ЭЦП отправителя
  • RecipientResponseStatus (строка, чтение) - отвечает за состояние ответного действия со стороны получателя документа
  • RoamingNotificationStatus (строка, чтение) - статус передачи документа через роуминг
  • RoamingNotificationStatusDescription (строка, чтение) - описание статуса передачи документа через роуминг.
  • CustomData (:doc:`коллекция <Collection>` объектов :doc:`CustomDataItem <CustomDataItem>`, чтение) - коллекция элементов "ключ-значение"
  • Metadata (:doc:`коллекция <Collection>` объектов :doc:`MetadataItem <MetadataItem>`) - коллекция метаданных
  • RecipientReceiptMetadata (:doc:`RecipientReceiptMetadata <RecipientReceiptMetadata>`, чтение) - метаданные - отвечает за ИОП на документ
  • ConfirmationMetadata (:doc:`ConfirmationMetadata <ConfirmationMetadata>`, чтение) - метаданные - отвечает за подтверждение оператором даты отправки/получения документа или служебного документа (ИОП)
  • AmendmentRequestMetadata (:doc:`AmendmentRequestMetadata`, чтение) - метаданные уведомления об уточнении (УОУ)
  • IsDeleted (булево, чтение) - признак того, что данный документ был удален
  • IsTest (булево, чтение) - признак того, что данный документ является тестовым и не имеет юридической силы
  • HasCustomPrintForm (булево, чтение) - признак того, что данный документ имеет нестандартную печатную форму
  • IsLockedPackage (булево, чтение) - признак того, что документ является частью нередактируемого пакета
  • IsRead (булево, чтение) - флаг, указывающий на то, что документ был прочитан сотрудником организации
  • IsEncryptedContent (булево, чтение) - флаг, указывающий на то, что содержимое документа зашифровано

Свойство Direction принимает одно из следующих значений:

  • "Inbound" - входящий документ
  • "Outbound" - исходящий документ
  • "Internal" - внутренний документ

Свойство RevocationStatus принимает одно из следующих значений:

  • "RevocationStatusNone" - документ не аннулирован, и не было предложений об аннулировании
  • "RevocationIsRequestedByMe" - отправлено исходящее предложение об аннулировании документа
  • "RequestsMyRevocation" - получено входящее предложение об аннулировании документа
  • "RevocationAccepted" - документ аннулирован
  • "RevocationRejected" - получен или отправлен отказ от предложения об аннулировании документа
  • "UnknownRevocationStatus" - неизвестный статус аннулирования документа

Свойство RoamingNotificationStatus принимает одно из следующих значений:

  • "RoamingNotificationStatusNone" - документ не роуминговый или документ без подтверждения доставки в роуминг
  • "RoamingNotificationStatusSuccess" - документ с подтверждением успешной доставки в роуминг
  • "RoamingNotificationStatusError" - документ с ошибкой доставки в роуминг
  • "UnknownRoamingNotificationStatus" - неизвестный роуминговый статус документа

Свойство SenderSignatureStatus принимает одно из следующих значений:

  • "WaitingForSenderSignature" - ожидается подпись отправителя
  • "SenderSignatureUnchecked" - подпись отправителя еще не проверена
  • "SenderSignatureCheckedAndValid" - подпись отправителя проверена и валидна
  • "SenderSignatureCheckedAndInvalid" - подпись отправителя проверена и невалидна
  • "UnknownSenderSignatureStatus" - неизвестный статус проверки подписи

Свойство RecipientResponseStatus принимает одно из следующих значений:

  • "RecipientResponseStatusUnknown" - неизвестный статус ответного действия
  • "RecipientResponseStatusNotAcceptable" - ответного действия не требуется
  • "WaitingForRecipientSignature" - ожидается ответное действие получателя
  • "WithRecipientSignature" - получатель подписал документ (ответный титул)
  • "RecipientSignatureRequestRejected" - получатель отказал в подписи
  • "InvalidRecipientSignature" - получатель подписал документ некорректной подписью

Методы объекта

.. toctree::
   :name: Auto
   :hidden:

   SaveAllContent <SaveAllContent>
   SaveAllContentAsync <SaveAllContentAsync>
   SaveAllContentZip <SaveAllContentZip>
   SaveAllContentZipAsync <SaveAllContentZipAsync>
   GetComment <GetComment>
   Move <Move>
   Delete <Delete>
   SaveContent <SaveContent>
   Approve <Approve>
   Disapprove <Disapprove>
   SetOneSDocumentId <SetOneSDocumentId>
   ReSetOneSDocumentId <ReSetOneSDocumentId>
   AddSubordinateOneSDocumentId <AddSubordinateOneSDocumentId-(Document)>
   RemoveSubordinateOneSDocumentId <RemoveSubordinateOneSDocumentId>
   CreateResolutionRequestTask <CreateResolutionRequestTask>
   GetSenderSignature <GetSenderSignature>
   GetRecipientSignature <GetRecipientSignature>
   GetStructuredDataAttachment <GetStructuredDataAttachment>
   SendRevocationRequest <SendRevocationRequest>
   AcceptRevocationRequest <AcceptRevocationRequest>
   RejectRevocationRequest <RejectRevocationRequest>
   GetPrintForm <GetPrintForm>
   GetDocumentPackage <GetDocumentPackage>
   CreateReplySendTask <CreateReplySendTask-(Document)>
   CreateOutDocumentSignTask <CreateOutDocumentSignTask-(Document)>
   MarkAsRead <MarkAsRead>
   CreateCustomDataPatchTask <CreateCustomDataPatchTask>
   GetAnyComment <GetAnyComment>


Производные объекты

Следующие объекты являются производными от Document:

.. toctree::
   :name: DocumentsChild
   :maxdepth: 1
   :caption: Производные объекты
   :hidden:

   Contract <Contract>
   Invoice <Invoice>
   InvoiceRevision <InvoiceRevision>
   InvoiceCorrection <InvoiceCorrection>
   InvoiceCorrectionRevision <InvoiceCorrectionRevision>
   Nonformalized <Nonformalized>
   NonformalizedAcceptanceCertificate <NonformalizedAcceptanceCertificate>
   NonformalizedTorg12 <NonformalizedTorg12>
   NonformalizedProforma <NonformalizedProformaInvoice>
   XmlAcceptanceCertificate <XmlAcceptanceCertificate>
   XmlTorg12 <XmlTorg12>
   Utd <Utd>
   UtdRevision <UtdRevision>
   Ucd <Ucd>
   UcdRevision <UcdRevision>
   BaseDocument <BaseDocument>

Структуры для работы с содержимым документов

Для работы с содержимым формализованных документов можно использовать специальные объекты, которые представляют данные xml-файла в виде объектной модели.

Объектные модели документов

В компоненте реализованы следующие объекты:

.. toctree::
   :name: Auto2
   :hidden:

   AcceptanceCertificateContent <AcceptanceCertificateContent>
   AcceptanceCertificateSellerContent <AcceptanceCertificateSellerContent>
   AcceptanceCertificateBuyerContent <AcceptanceCertificateBuyerContent>
   ContractContent <ContractContent>
   InvoiceContent <InvoiceContent>
   InvoiceCorrectionContent <InvoiceCorrectionContent>
   NonformilizedContent <NonformilizedContent>
   ProformaInvoiceContent <ProformaInvoiceContent>
   Torg12Content <Torg12Content>
   Torg12SellerContent <Torg12SellerContent>
   Torg12BuyerContent <Torg12BuyerContent>
   UtdSellerContent <UtdSellerContent>
   UtdBuyerContent <UtdBuyerContent>
   UcdSellerContent <UcdSellerContent>
   TovTorgSellerContent <TovTorgSellerContent>
   TovTorgBuyerContent <TovTorgBuyerContent>
   Act552SellerContent <Act552SellerContent>
   Act552BuyerContent <Act552BuyerContent>

Вспомогательные объекты

Для работы с содержимым также используются следующие вспомогательные объекты:

.. toctree::
   :name: Auto3
   :hidden:

   AdditionalInfoId <AdditionalInfoId>
   AddressInfo <AddressInfo>
   Attorney <Attorney>
   ExtendedOrganizationInfo <ExtendedOrganizationInfo>
   ExtendedSigner <ExtendedSigner>
   OrganizationInfo <OrganizationInfo>
   PaymentDocument <PaymentDocument>
   Signer <Signer>
   Shipper <Shipper>
   ShipperOrConsigneeInfo <ShipperOrConsigneeInfo>
   StructedAdditionalInfo <StructedAdditionalInfo>
   Official <Official>
   ResolutionRequest <ResolutionRequest>
   ResolutionRequestDenial <ResolutionRequestDenial>
   GroundInfo <GroundInfo>
   CustomDataItem <CustomDataItem>
You can’t perform that action at this time.