DocumentBase

Базовый объект для всех типов документов .

Свойства

TypeNamedId:

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

DocumentFunction:

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

Version:

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

Organization:

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

OrganizationGuid:

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

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

Direction:

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

Counteragent:

BoxInfo , чтение - контрагент документа. Для внутренних документов будет пустым

FromDepartment:

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

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

ToDepartment:

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

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

Department:

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

RouteId:

Строка, чтение - идентификатор маршрута согласования, на котором находится документ

DocumentId:

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

InitialDocumentIds:

Коллекция строк, чтение - коллекция идентификаторов документов, на который ссылается данный документ (т.е. документы, которые по отношению к данному документы являются «родительскими»

SubordinateDocumentIds:

Коллекция строк, чтение - коллекция идентификаторов документов, которые ссылаются на данный документ (т.е. документы, которые по отношению к данному документу являются «дочерними»)

OneSDocumentId:

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

PackageId:

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

CustomDocumentId:

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

Metadata:

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

Timestamp:

Дата и время, чтение - дата и время отправки документа (в текущем часовом поясе)

DocumentDate:

Дата, чтение - дата документа

DocumentNumber:

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

FileName:

Строка, чтение - имя файла документа, с которым он загружался в Диадок

Title:

Строка, чтение - название документа, например, Счет-фактура №123 от 20.02.18

PathURL:

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

EditingSettingId:

Строка, чтение - идентификатор настройки редактирования содержимого документа. Наличие данной настройки означает, что в содержимом файла может отсутствовать контент, редактирование которого разрешено данной настройкой

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

WorkflowId:

Целое число, чтение - идентификатор типа документооборота

CustomData:

Коллекция объектов CustomDataItem , чтение - коллекция тэгов документа

IsDeleted:

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

IsTest:

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

HasCustomPrintForm:

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

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

IsLockedPackage:

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

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

IsEncryptedContent:

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

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

IsRead:

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

Status:

Строка, чтение - Общий статус документа в Диадоке. Возможный набор значений зависит от типа объекта-наследника

SenderSignatureStatus:

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

RecipientResponseStatus:

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

ProxySignatureStatus:

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

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

RoamingNotificationStatus:

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

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

RoamingNotificationStatusDescription:

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

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

RevocationStatus:

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

ResolutionStatus:

ResolutionStatus , чтение - текущий статус запрошенного согласования или подписи документа

ResolutionRequests:

Коллекция объектов ResolutionRequest , чтение - история запросов резолюций документа: запросов согласований, запросов подписаний, запросов аннулирований

Resolutions:

Коллекция объектов Resolution , чтение - история резолюций документа: согласований, подписаний, аннулирований

ResolutionRequestDenials:

Коллекция объектов ResolutionRequestDenial , чтение - коллекция объектов отказов по резолюциям

LastExternalStatuses:

коллекция объектов ExternalStatusLite , чтение - набор последних статусов внешнего документооборота

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

RecipientReceiptMetadata:

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

ConfirmationMetadata:

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

AmendmentRequestMetadata:

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

Методы

GetSenderSignature() SaveContent() GetAnyComment() CreateReplySendTask2()
GetRecipientSignature() SaveBuyerContent() GetExternalStatuses() SendReceiptsAsync()
GetDynamicContent() SaveAllContent() GetDocumentPackage() Approve()
GetBase64Content() SaveAllContentAsync() Delete() Disapprove()
GetBase64ContentAsync() SaveAllContentZip() Move() CreateOutDocumentSignTask()
GetBase64Signature() SaveAllContentZipAsync() MarkAsRead() CreateResolutionRequestTask()
GetBase64OriginalSignature() GetPrintForm() AssignToResolutionRoute() CreateCustomDataPatchTask()
    RemoveFromResolutionRoute()  
DocumentBase.GetSenderSignature()

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

DocumentBase.GetRecipientSignature()

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

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

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

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

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

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

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

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

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

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

Возвращает оригинальную подпись (обычно без метки времени) титула документа со стороны DocflowSide в виде Base64 строки

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

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

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

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

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

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

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

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

DocumentBase.SaveAllContentZip(FilePath)
FilePath:Строка Путь до файла, в который будет сохранён архив

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

DocumentBase.SaveAllContentZipAsync(FilePath)
FilePath:Строка Путь до файла, в который будет сохранён архив

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

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

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

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

DocumentBase.GetAnyComment(CommentType)
CommentType:строка Тип комментария. Возможные значения

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

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

DocumentBase.GetExternalStatuses()

Возвращает коллекцию внешних статусов документа

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

DocumentBase.GetDocumentPackage()

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

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

Примечание

понятие пакета в терминах компоненты и в терминах HTTP-API или Веб-интерфейса разные. В данном случае в пакете будут содержаться только документы с одинаковым MessageId

DocumentBase.Delete()

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

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

Перемещает документ в указанное подразделение

DocumentBase.MarkAsRead()

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

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

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

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

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

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

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

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

DocumentBase.SendReceiptsAsync()

Отправляет извещения о получении документа, необходимые для завершения документооборота. Возвращает объект AsyncResult с типом результата Булево

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

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

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

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

DocumentBase.CreateOutDocumentSignTask()

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

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

DocumentBase.CreateResolutionRequestTask()

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

DocumentBase.CreateCustomDataPatchTask()

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

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

Объекты, производные от Document Описание
Contract договор
Invoice счет-фактура
InvoiceRevision исправление счета-фактуры
InvoiceCorrection корректировочный счет-фактура
InvoiceCorrectionRevision исправление корректировочного счета-фактуры
Nonformalized неформализованный документ
NonformalizedAcceptanceCertificate акт о выполнении работ в неформализованном виде
NonformalizedTorg12 ТОРГ-12 в неформализованном виде
NonformalizedProforma счет на оплату
XmlAcceptanceCertificate акт о выполнении работ в формализованном виде
XmlTorg12 ТОРГ-12 в формализованном виде
Utd универсальный передаточный документ
UtdRevision исправление универсального передаточного документа
Ucd универсальный корректировочный документ
UcdRevision исправление универсального корректировочного документа
Document документ произвольного типа

Устаревшие методы

DocumentBase.GetComment()

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

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

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

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

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

DocumentBase.ReSetOneSDocumentId()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DocumentBase.AcceptRevocationRequest()

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

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

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

DocumentBase.RejectRevocationRequest()

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

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

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