Документы

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

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

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

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

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

  • SaveAllContent - сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию
  • SaveAllContentAsync - асинхронно сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию
  • SaveAllContentZip - формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию
  • SaveAllContentZipAsync - асинхронно формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию
  • GetComment - возвращает комментарий к документу, заданный при отправке
  • GetAnyComment - возвращает комментарий определённого типа к документу
  • Move - перемещает документ в указанное подразделение
  • Delete - помечает документ как удаленный
  • SaveContent - сохраняет содержимое документа/титула продавца на локальный диск
  • SaveBuyerContent - сохраняет содержимое титула покупателя на локальный диск. Если документ однотитульный, то новый файл в файловой системе не создастся, исключений выкинуто не будет.
  • Approve - ставит признак согласования документа
  • Disapprove - ставит признак отказа в согласовании документа
  • SetOneSDocumentId - устанавливает идентификатор 1С для данного документа
  • ReSetOneSDocumentId - сбрасывает идентификатор 1С для данного документа
  • AddSubordinateOneSDocumentId - добавляет дополнительный идентификатор 1С для документа
  • RemoveSubordinateOneSDocumentId - удаляет дополнительный идентификатор 1С для документа
  • CreateResolutionRequestTask - создает задание для отправки запроса на согласование
  • GetSenderSignature - возвращает подпись отправителя, приложенную к документу
  • GetRecipientSignature - возвращает подпись получателя, приложенную к документу
  • GetStructuredDataAttachment - возвращает структурированные данные, описывающими те или иные документы, представленные в виде печатных форм
  • SendRevocationRequest - отправляет запрос на аннулирование документа
  • AcceptRevocationRequest - принимает запрос об аннулировании документа
  • RejectRevocationRequest - отклоняет запрос на аннулирование документа
  • GetPrintForm - получает печатную форму документа в формате pdf
  • GetDocumentPackage - возвращает пакет, в котором находится документ
  • CreateReplySendTask - создает задание на выполнение ответного действия с документом
  • CreateOutDocumentSignTask - создает задание на подписание и отправку исходящего документа с отложенной отправкой.
  • MarkAsRead - помечает, что документ был прочитан сотрудником организации (устанавливает флаг IsRead)
  • CreateCustomDataPatchTask - создает CustomDataPatchTask, позволяющий редактировать коллекцию CustomData
  • AssignToResolutionRoute - ставит документ на маршрут согласования
  • RemoveFromResolutionRoute - снимает документ с маршрута согласования

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

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

  • Contract - договор
  • Invoice - счет-фактура
  • InvoiceRevision - исправление счета-фактуры
  • InvoiceCorrection - корректировочный счет-фактура
  • InvoiceCorrectionRevision - исправление корректировочного счета-фактуры
  • Nonformalized - неформализованный документ (в том числе акт сверки, детализация, дополнительное соглашение к договору, протокол согласования цены, реестр сертификатов, ценовой лист)
  • NonformalizedAcceptanceCertificate - акт о выполнении работ в неформализованном виде
  • NonformalizedTorg12 - ТОРГ-12 в неформализованном виде
  • NonformalizedProforma - счет на оплату
  • XmlAcceptanceCertificate - акт о выполнении работ в формализованном виде
  • XmlTorg12 - ТОРГ-12 в формализованном виде
  • Utd - универсальный передаточный документ
  • UtdRevision - исправление универсального передаточного документа
  • Ucd - универсальный корректировочный документ
  • UcdRevision - исправление универсального корректировочного документа
  • BaseDocument - документ “любого типа”

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

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

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

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

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

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

  • AdditionalInfoId - для работы с информационным полем документа
  • AddressInfo - для работы с данными об адресе
  • Attorney - для работы с данными о доверенности
  • Employee - для работы с данными о работнике организации продавца или покупателя
  • ExtendedOrganizationInfo - для работы с данными об организации
  • ExtendedSigner - для работы с данными о лице, подписавшем документ
  • OrganizationInfo - для работы с данными об организации
  • OtherIssuer - для работы с данными о третьем лице
  • PaymentDocument - для работы с данными о платежно-расчетном документе
  • Signer - для работы с данными о лице, подписавшем документ
  • Shipper - для работы с данными об грузоотправителе
  • ShipperOrConsigneeInfo - для работы с данными об грузоотправителе и грузополучателе
  • StructedAdditionalInfo - для работы с дополнительными сведениями
  • Official - для работы с данными о должностном лице
  • GroundInfo - для работы с документом - основанием
  • CustomDataItem - запись “ключ-значение”