Document

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

Свойства

Type:строка, чтение - тип документа
TypeNamedId:строка, чтение - строковый идентификатор типа документа
DocumentFunction:
 строка, чтение - функция документа
Version:строка, чтение - информация о версии XSD схемы, в соотвествии с которой сформирован документ
Organization:Organization , чтение - организация, которая отправила исходящий документ, либо получила входящий документ
OrganizationId:строка, чтение - идентификатор организации, которой принадлежит документ
Counteragent:Counteragent , чтение - контрагент документа
DocumentId:строка, чтение - идентификатор документа
OneSDocumentId:строка, чтение - дополнительный идентификатор документа
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:число, чтение - идентификатор типа документооборота
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:
 булево, чтение - флаг, показывающий, что содержимое документа зашифровано

Методы

  • SaveContent сохраняет титул отправителя на диск
  • SaveBuyerContent сохраняет титул получателя на диск
  • SaveAllContent сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию
  • SaveAllContentAsync асинхронно сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию
  • SaveAllContentZip формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию
  • SaveAllContentZipAsync асинхронно формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию
  • GetDynamicContent возвращает представление контента титула документа
  • GetBase64Content возвращает контент одного из титулов документа в base64
  • GetBase64ContentAsync асинхронно возвращает контента одного из титулов документа в base64
  • GetBase64Signature возвращает подпись одного из титулов документа в base64
  • GetSenderSignature возвращает представление подписи титула отправителя
  • GetRecipientSignature возвращает представление подписи титула получателя
  • GetComment возвращает комментарий к документу, заданный при отправке
  • GetAnyComment возвращает комментарий определённого типа, связанный с документом
  • Move перемещает документ в указанное подразделение
  • Delete помечает документ как удаленный
  • Approve ставит признак согласования документа
  • Disapprove ставит признак отказа в согласовании документа
  • SetOneSDocumentId присваивает документу дополнительный идентификатор
  • ReSetOneSDocumentId сбрасывает дополнительный идентификатор
  • AddSubordinateOneSDocumentId добавляет документу дополнительный идентификатор как подчинённый
  • RemoveSubordinateOneSDocumentId удаляет дополнительный подчинённый идентификатор
  • CreateResolutionRequestTask создает задание для отправки запроса на согласование
  • GetPrintForm получает печатную форму документа в формате pdf
  • GetDocumentPackage возвращает сообщение, в котором находится документ
  • CreateReplySendTask создает задание на выполнение ответного действия с документом
  • CreateReplySendTask2 создает задание на выполнение ответного действия с документом
  • CreateOutDocumentSignTask создает задание на подписание и отправку исходящего документа с отложенной отправкой
  • MarkAsRead помечает, что документ как прочитанный
  • CreateCustomDataPatchTask создает задание на редактирование коллекции CustomData
  • AssignToResolutionRoute ставит документ на маршрут согласования
  • RemoveFromResolutionRoute снимает документ с маршрута согласования

Дополнительная информация

Значение свойства 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 получатель подписал документ некорректной подписью
Объекты, производные от Document Описание
Contract договор
Invoice счет-фактура
InvoiceRevision исправление счета-фактуры
InvoiceCorrection корректировочный счет-фактура
InvoiceCorrectionRevision исправление корректировочного счета-фактуры
Nonformalized неформализованный документ
NonformalizedAcceptanceCertificate акт о выполнении работ в неформализованном виде
NonformalizedTorg12 ТОРГ-12 в неформализованном виде
NonformalizedProforma счет на оплату
XmlAcceptanceCertificate акт о выполнении работ в формализованном виде
XmlTorg12 ТОРГ-12 в формализованном виде
Utd универсальный передаточный документ
UtdRevision исправление универсального передаточного документа
Ucd универсальный корректировочный документ
UcdRevision исправление универсального корректировочного документа
BaseDocument документ «любого типа»