DocumentBase

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

Свойства

TypeInfo:

FlatDocumentTypeInfo, чтение - описание типа документа

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

Organization:

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

OrganizationGuid:

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

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

Direction:

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

Counteragent:

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

ProxyBox:

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

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

FromDepartment2:

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

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

ToDepartment2:

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

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

ProxyDepartment2:

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

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

Department2:

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

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

RouteId:

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

DocumentId:

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

InitialDocumentIds:

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

SubordinateDocumentIds:

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

OneSDocumentId:

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

PackageId:

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

CustomDocumentId:

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

DraftInfo:

DraftInfo, чтение - информация о черновике. Если документ не является черновиком, то будет пустым

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

Metadata:

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

Timestamp:

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

DocumentDate:

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

DocumentNumber:

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

FileName:

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

Title:

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

PathURL:

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

EditingSettingId:

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

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

WorkflowId:

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

CustomData:

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

IsDeleted:

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

IsTest:

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

IsLockedPackage:

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

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

IsEncryptedContent:

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

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

IsRead:

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

DocflowStatus:

DocflowStatus , чтение - текстовое представление статуса документа. Поле рекомендуется использовать для отоборажения статуса документа аналогично веб-интерфейсу Диадок. Для реализации логики интеграционного решения рекомендуется использовать поля, отвечающие за частичные статусы документооборота, например SenderSignatureStatus, RecipientResponseStatus и т.п.

SenderSignatureStatus:

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

RecipientResponseStatus:

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

ProxySignatureStatus:

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

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

RoamingNotificationStatus:

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

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

RoamingNotificationStatusDescription:

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

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

RevocationStatus:

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

ResolutionStatus:

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

LastExternalStatuses:

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

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

NeedReceipts:

Булево, чтение - флаг, говорящий о том, что нужно отправить какой-то из ИоП, вызвав метод SendReceiptsAsync() или SendReceiptsWithPowerOfAttorney() или запустив ReceiptGenerationProcess

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

SenderReceiptMetadata:

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

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

RecipientReceiptMetadata:

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

ConfirmationMetadata:

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

AmendmentRequestMetadata:

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

Предупреждение

Поля устарели

Поле

Рекомендуемая альтернатива

Когда устарел

Когда удалён

AttachmentVersion

Version

5.21.0

Type

TypeNamedId

5.21.0

OrganizationId

OrganizationGuid

5.31.0

TimestampSeconds

Timestamp

5.30.2

Status

DocflowStatus или поля со статусами отдельных сущностей

5.34.0

HasCustomPrintForm

DetectCustomPrintForm()

5.35.0

ResolutionRequests

GetResolutionRequests()

5.34.0

Resolutions

GetResolutions()

5.34.0

ResolutionRequestDenials

GetResolutionRequestDenials()

5.34.0

FromDepartment

FromDepartment2

5.47.0

ToDepartment

ToDepartment2

5.47.0

ProxyDepartment

ProxyDepartment2

5.47.0

Department

Department2

5.47.0

TypeNamedId

TypeInfo.TypeId.Type

5.50.0

DocumentFunction

TypeInfo.TypeId.Function

5.50.0

DocumentVersion

TypeInfo.TypeId.Version

5.50.0
AttachmentVersion:

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

Type:

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

OrganizationId:

Строка, чтение - идентификатор ящика собственной организации в Диадок в формате ...@diadoc.ru

TimestampSeconds:

Вещественное число, чтение - количество секунд, прошедших с начала дня до отправки документа

Status:

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

HasCustomPrintForm:

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

ResolutionRequests:

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

Resolutions:

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

ResolutionRequestDenials:

Коллекция объектов ResolutionRequestDenial - коллекция отказов в запросах согласований, подписаний, аннулирований

FromDepartment:

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

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

ToDepartment:

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

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

ProxyDepartment:

Department , чтение - подразделение промежуточного получателя. Не показывает информацию о головном подразделениии

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

Department:

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

TypeNamedId:

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

DocumentFunction:

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

Version:

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

Методы

DocumentBase.GetSenderSignature()

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

DocumentBase.GetRecipientSignature()

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

DocumentBase.GetDynamicContent(DocflowSide)
DocflowSide:

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

Возвращает упрощённое представление контента титула документа со стороны DocflowSide. Если запрашиваемого титула нет или для него не существует упрощённого представления контента (см. DocumentTitle), то вернётся Пустой COM-объект

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:

Строка - признак необходимости сохранения протокола передачи документа

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

Будут сохранены все сущности с теми именами, которые у них есть в Диадоке, их подписи и МЧД приложенные к этим подписями, а также печатная форма и протокол с подписью (опционально). Если имя файла сущности в Диадок - FileName.extension, то будут сохранены:

  • FileName.extension

  • FileName.extension_1.SGN

  • FileName.extension_1 МЧД.xml

  • FileName.extension_1 МЧД.xml.sgn

  • FileName.extension_2.SGN

  • FileName.extension_2 МЧД.xml

  • FileName.extension_2 МЧД.xml.sgn

  • ...

  • FileName.extension_N.SGN

  • FileName.extension_N МЧД.xml

  • FileName.extension_N МЧД.xml.sgn

Имя файла печатной формы - Печатная форма <Имя документа>.pdf, например Печатная форма УПД №20931204660 от 28.05.20.pdf

Файлы протокола: Протокол.pdf, ПротоколSGN.sgn

Изменено в версии 5.49.0: Для каждой МЧД, выпущенной через передоверие будет создана папка Передоверие <Имя файла, в который сохранена МЧД без расширения>. В созданную папку будет сохранены каждая МЧД из цепочки передоверия с именем <регистрационный номер МЧД>.xml, а также подпись этой доверенности с именем <регистрационный номер МЧД>.xml.sgn

Примечание

Пусть есть неформализованный документ, отправленный в файле [Nonformalized; default; v1] №1.txt подписанный отправителем и получателем с использованием МЧД. Тогда выгрузка для него может выглядеть так:

  • [Nonformalized; default; v1] №1.txt

  • [Nonformalized; default; v1] №1.txt_1.sgn

  • [Nonformalized; default; v1] №1.txt_1 МЧД.xml

  • [Nonformalized; default; v1] №1.txt_1 МЧД.xml.sgn

  • [Nonformalized; default; v1] №1.txt_2.sgn

  • [Nonformalized; default; v1] №1.txt_2 МЧД.xml

  • [Nonformalized; default; v1] №1.txt_2 МЧД.xml.sgn

  • Печатная форма [Nonformalized; default; v1] №1.txt.pdf

  • Протокол.pdf

  • ПротоколSGN.sgn

  • Передоверие [Nonformalized; default; v1] №1.txt_1 МЧД\97114285-f287-4d20-a05a-9dabc9b87844.xml

  • Передоверие [Nonformalized; default; v1] №1.txt_1 МЧД\97114285-f287-4d20-a05a-9dabc9b87844.xml.sgn

  • Передоверие [Nonformalized; default; v1] №1.txt_2 МЧД\89be6d90-2ee2-40c3-a2a0-8da9bb6053b8.xml

  • Передоверие [Nonformalized; default; v1] №1.txt_2 МЧД\89be6d90-2ee2-40c3-a2a0-8da9bb6053b8.xml.sgn

DocumentBase.SaveAllContentAsync(DirectoryPath, WithProtocol=False)
DirectoryPath:

Строка - путь до директории, в которой будут сохранены файлы

WithProtocol:

Строка - признак необходимости сохранения протокола передачи документа

Асинхронный вариант метода DocumentBase.SaveAllContent(). Возвращает AsyncResult с булевым результатом.

DocumentBase.SaveAllContentZip(FilePath)
FilePath:

Строка - путь до файла, в который будет сохранён архив

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

DocumentBase.SaveAllContentZipAsync(FilePath)
FilePath:

Строка - путь до файла, в который будет сохранён архив

Асинхронный вариант метода DocumentBase.SaveAllContentZip(). Возвращает AsyncResult с булевым результатом.

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()

Возвращает документы, отправленные одновременно с данным. У документов в результате будет совпадать MessageId

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

DocumentBase.GetPackageDocuments(DetectCustomPrintForm=False)
DetectCustomPrintForm:

Булево - Флаг необходимости определить наличие нестандартной печатной формы (КПФ) у документов.

Возвращает коллекцию документов, объединённых в один пакет. У документов в результате будет совпадать PackageId.

Если решение предполагает использование признака наличия у документов КПФ, то рекомендуется устанавливать параметр DetectCustomPrintForm в истину - определение наличия КПФ для документов из результата будет выполняться пакетно, вместо необходимости запрашивать этот признак для каждого документа в отдельности

DocumentBase.GetResolutions()

Метод возвращает коллекцию резолюций документа: согласований, подписаний, аннулирований, их запросов и т.д.

DocumentBase.GetResolutionRequests()

Метод возвращает коллекцию запросов резолюций документа: запросов согласований, запросов подписаний, запросов аннулирований и т.д.

DocumentBase.GetResolutionRequestDenials()

Метод возвращает коллекцию отказов в резолюциях документа

DocumentBase.GetPowersOfAttorney()

Метод возвращает коллекцию МЧД , использованных для подписания сущностей документа

DocumentBase.DetectCustomPrintForm()

Метод возвращает признак наличия у документа нетиповой печатной формы (КПФ)

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

DocumentBase.Approve([Comment])
Comment:

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

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

DocumentBase.Disapprove([Comment])
Comment:

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

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

DocumentBase.CreateResolutionRequestTask()

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

DocumentBase.CreateCustomDataPatchTask()

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

DocumentBase.Delete()

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

Изменено в версии 5.50: Если документ лежит в черновике или закрытом пакете, то будет удалён весь черновик или весь пакет

DocumentBase.Move(DepartmentId)
DepartmentId:

Строка - идентификатор подразделения

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

DocumentBase.MarkAsRead()

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

DocumentBase.AssignToResolutionRoute(RouteId[, Comment])
RouteId:

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

Comment:

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

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

DocumentBase.RemoveFromResolutionRoute(RouteId[, Comment])
RouteId:

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

Comment:

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

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

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

Объекты, производные от DocumentBase

Описание

Contract

договор

Invoice

счет-фактура

InvoiceRevision

исправление счета-фактуры

InvoiceCorrection

корректировочный счет-фактура

InvoiceCorrectionRevision

исправление корректировочного счета-фактуры

Nonformalized

неформализованный документ

NonformalizedAcceptanceCertificate

акт о выполнении работ в неформализованном виде

NonformalizedTorg12

ТОРГ-12 в неформализованном виде

NonformalizedProforma

счет на оплату

XmlAcceptanceCertificate

акт о выполнении работ в формализованном виде

XmlTorg12

ТОРГ-12 в формализованном виде

Utd

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

UtdRevision

исправление универсального передаточного документа

Ucd

универсальный корректировочный документ

UcdRevision

исправление универсального корректировочного документа

Document

документ произвольного типа