Document

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

Свойства

Type:

Строка, чтение - тип документа

TypeNamedId:

Строка, чтение - строковый идентификатор типа документа

DocumentFunction:

Строка, чтение - функция документа

Version:

Строка, чтение - информация о версии XSD схемы, в соотвествии с которой сформирован документ

Organization:

Organization , чтение - организация, которая отправила исходящий документ, либо получила входящий документ

OrganizationId:

Строка, чтение - идентификатор организации, которой принадлежит документ

Counteragent:

Counteragent , чтение - контрагент документа

DocumentId:

Строка, чтение - идентификатор документа

OneSDocumentId:

Строка, чтение - дополнительный идентификатор документа

PackageId:

Строка, чтение - идентификатор пакета

Direction:

Строка, чтение - направление документа. Возможные значения

Department:

Department , чтение - подразделение организации, к которому привязан документ

FromDepartment:

Department , чтение - подразделение организации, из которого был отправлен документ

Добавлено в версии 3.0.8.

ToDepartment:

Department , чтение - подразделение организации, в которое был отправлен документ

Добавлено в версии 3.0.8.

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:

Строка, чтение - статус передачи документа через роуминг. Возможные значения

Добавлено в версии 5.3.1.

RoamingNotificationStatusDescription:

Строка, чтение - описание статуса передачи документа через роуминг

Добавлено в версии 5.3.1.

CustomData:

Коллекция объектов CustomDataItem , чтение - коллекция элементов «ключ-значение»

Metadata:

Коллекция объектов MetadataItem , чтение - коллекция метаданных

RecipientReceiptMetadata:

RecipientReceiptMetadata , чтение - метаданные извещения о получении документа получателем

ConfirmationMetadata:

ConfirmationMetadata , чтение - метаданные подтверждения оператором отправки/получения документа или служебного документа

AmendmentRequestMetadata:

AmendmentRequestMetadata , чтение - метаданные уведомления об уточнении

IsDeleted:

Булево, чтение - флаг, показывающий, был ли удален данный документ

IsTest:

Булево, чтение - флаг, показывающий, что документ является тестовым и не имеет юридической силы

HasCustomPrintForm:

Булево, чтение - флаг, показывающий, что документ имеет нестандартную печатную форму

Добавлено в версии 3.0.10.

IsLockedPackage:

Булево, чтение - флаг, показывающий, что документ является частью нередактируемого пакета

Добавлено в версии 5.3.0.

IsRead:

Булево, чтение - флаг, показывающий, что документ был прочитан сотрудником организации

IsEncryptedContent:

Булево, чтение - флаг, показывающий, что содержимое документа зашифровано

Добавлено в версии 5.3.0.

Методы

SaveContent() GetComment() GetDocumentPackage()
SaveBuyerContent() GetAnyComment() CreateReplySendTask()
SaveAllContent() Move() CreateReplySendTask2()
SaveAllContentAsync() Delete() CreateOutDocumentSignTask()
SaveAllContentZip() Approve() MarkAsRead()
SaveAllContentZipAsync() Disapprove() CreateCustomDataPatchTask()
GetDynamicContent() SetOneSDocumentId() AssignToResolutionRoute()
GetBase64Content() ReSetOneSDocumentId() RemoveFromResolutionRoute()
GetBase64ContentAsync() AddSubordinateOneSDocumentId() SendRevocationRequest()
GetBase64Signature() RemoveSubordinateOneSDocumentId() AcceptRevocationRequest()
GetSenderSignature() CreateResolutionRequestTask() RejectRevocationRequest()
GetRecipientSignature() GetPrintForm()  
Document.SaveContent(FilePath)
FilePath:Строка Путь до файла, в который будет записан контент

Сохраняет титул отправителя на диск

Document.SaveBuyerContent(FilePath)
FilePath:Строка Путь до файла, в который будет записан контент

Сохраняет титул получателя документа в указанный файл. Если титул отсутсвует, то ничего не произойдёт

Document.SaveAllContent(DirectoryPath)
DirectoryPath:Строка Путь до директории, в которой будут сохранены файлы

Сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию

Document.SaveAllContentAsync(DirectoryPath)
DirectoryPath:Строка Путь до директории, в которой будут сохранены файлы

Асинхронно сохраняет все файлы, относящиеся к документу (в т.ч. электронные подписи), в указанную директорию

Document.SaveAllContentZip(DirectoryPath, WithProtocol=false)
DirectoryPath:Строка Путь до директории, в которой будет сохранён архив
WithProtocol:Булево Признак необходимости сохранения протокола передачи документа

Формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию

Document.SaveAllContentZipAsync(DirectoryPath, WithProtocol=false)
DirectoryPath:Строка Путь до директории, в которой будет сохранён архив
WithProtocol:Булево Признак необходимости сохранения протокола передачи документа

Асинхронно формирует архив, содержащий все файлы, относящиеся к документу (в т.ч. электронные подписи), и сохраняет его в указанную директорию

Document.GetDynamicContent(DocflowSide)
DocflowSide:Строка Сторона документооборота, чей титул будет представлен. Возможные значения

Возвращает представление контента титула документа со стороны WorkflowSide. Если запрашиваемого титула у документа нет, то результатом будет Undefined / Неопределено. Если для данного документа не существует схемы, в которой можно представить контент документа, то так же результатом будет Undefined / Неопределено

Document.GetBase64Content(DocflowSide)
DocflowSide:Строка Сторона документооборота, чей титул будет представлен. Возможные значения

Возвращает контент титула документа со стороны DocflowSide в виде Base64 строки

Document.GetBase64ContentAsync(DocflowSide)
DocflowSide:Строка Сторона документооборота, чей титул будет представлен. Возможные значения

Возвращает контент титула документа со стороны DocflowSide в виде Base64 строки

Document.GetBase64Signature(DocflowSide)
DocflowSide:Строка Сторона документооборота, подпись титула которой будет представлена. Возможные значения

Возвращает подпись титула документа со стороны DocflowSide в виде Base64 строки

Document.GetSenderSignature()

Возвращает представление подписи титула отправителя

Document.GetRecipientSignature()

Возвращает представление подписи титула получателя

Document.GetComment()

Возвращает строку с комментарием к документу, заданным при отправке

Не рекомендуется, начиная с версии 5.20.3: Используйте GetAnyComment() с типом AttachmentComment

Document.GetAnyComment(CommentType)
CommentType:строка Тип комментария

Возвращает строку с комментарием определённого типа, связанным с документом

Значение CommentType Описание
AttachmentComment комментарий к документу
RecipientAttachmentComment комментарий к титулу покупателя
SignatureRejectionComment комментарий к отказу в подписи
AmendmentComment комментарий к запросу на уточнение

Добавлено в версии 5.20.3.

Document.Move(DepartmentId)
DepartmentId:Строка Идентификатор подразделения

Перемещает документ в указанное подразделение. Идентификатор головного подразделения всегда 00000000-0000-0000-0000-000000000000

Document.Delete()

Помечает документ как удаленный

Document.Approve([Comment])
Comment:Строка Комментарий, который будет указан при согласовании

Согласует документ

Document.Disapprove([Comment])
Comment:Строка Комментарий, который будет указан при отказе согласования

Отказывает в согласовании документа

Document.SetOneSDocumentId(ID)
ID:Строка Любая строка, идентифицирующая документ в учётной системе

Присваивает документу дополнительный идентификатор из учётной системы

Document.ReSetOneSDocumentId()

Сбрасывает дополнительный идентификатор учётной системы у документа в Диадоке

Document.AddSubordinateOneSDocumentId(ID)
ID:Строка Любая строка, идентифицирующая документ в учётной системе

Добавляет документу дополнительный идентификатор из учётной системы как подчинённый. Обычно используется чтобы обозначить связь документов друг с другом

Document.RemoveSubordinateOneSDocumentId(ID)
ID:Строка Любая строка, идентифицирующая документ в учётной системе

Удаляет дополнительный подчинённый идентификатор

Document.CreateResolutionRequestTask()

Создает задание для отправки запроса согласования

Document.GetPrintForm(FilePath[, Timeout])
FilePath:Строка Путь до файла, в который будет сохранена печатная форма
Timeout:Беззнаковое целое число Таймаут за который необходимо получить печатную форму

Получает печатную форму документа в формате .pdf и сохраняет её в указанный файл. Если расширение файла отличается от .pdf, то такой файл будет создан/ Совершается 5 попыток сгенерировать печатную форму. Если за 5 попыток она не получена или, если превышен таймаут, то будет сгенерировано исключение

Добавлено в версии 3.0.10.

Document.GetDocumentPackage()

Возвращает пакет документов, в котором находится документ

Добавлено в версии 5.3.0.

Примечание

понятие пакета в терминах компоненты и в терминах HTTP-API или Веб-интерфейса разные. В данном случае в пакете будут содержаться только те документы, у которых LetterId/MessageId (первая половина DocumentId) совпадает со значением в исходном документе. Не стоит ожидать, что если документы связаны в пакет в веб интерфейсе, то все они вернутся в этом методе.

Document.CreateReplySendTask(ReplyType="AcceptDocument")
ReplyType:Строка Тип ответа. Возможные значения

Создает задание на выполнение ответного действия с документом

Не рекомендуется, начиная с версии 5.27.0: Используйте Document.CreateReplySendTask2()

Document.CreateReplySendTask2(ReplyType="AcceptDocument")
ReplyType:строка Тип ответа. Возможные значения

Создает задание на выполнение ответного действия с документом

Добавлено в версии 5.27.0.

Document.CreateOutDocumentSignTask()

Создает задание на подписание и отправку исходящего документа с отложенной отправкой

Добавлено в версии 5.6.0.

Document.MarkAsRead()

Помечает, что документ как прочитанный

Document.CreateCustomDataPatchTask()

Создает задание на редактирование коллекции CustomData

Document.AssignToResolutionRoute(RouteId[, Comment])
RouteId:строка Идентификатор маршрута
Comment:строка Комментарий, который будет добавлен при постановке документа на маршрут

Ставит документ на маршрут согласования. Получить доступные маршруты согласования можно методом Organization.GetResolutionRoutes()

Document.RemoveFromResolutionRoute(RouteId[, Comment])
RouteId:строка Идентификатор маршрута
Comment:строка Комментарий, который будет добавлен при снятии документа с маршрута

Снимает документ с маршрута согласования

Document.SendRevocationRequest([Comment])
Comment:строка комментарий к запросу аннулирования

Запрашивает аннулирование документа

Добавлено в версии 3.0.3.

Не рекомендуется, начиная с версии 5.27.0: Используйте Document.CreateReplySendTask2()

Document.AcceptRevocationRequest()

Принимает запрос аннулирования

Добавлено в версии 3.0.3.

Не рекомендуется, начиная с версии 5.27.0: Используйте Document.CreateReplySendTask2()

Document.RejectRevocationRequest()

Отказывает в аннулировании

Добавлено в версии 3.0.3.

Не рекомендуется, начиная с версии 5.27.0: Используйте Document.CreateReplySendTask2()

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

Значение DocflowSide Описание
Seller Титул отправителя
Buyer Титул получателя
Значение ReplyType Описание
AcceptDocument подписание документа
RejectDocument отказ в подписи документа
CorrectionRequest запроc на уточнение документа
RevocationRequest запроc на аннулирование документа
AcceptRevocation принятие аннулирования документа
RejectRevocation отказ от аннулирования документа
Значение 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 документ произвольного типа