Работа со статусами документа
За свой жизненный цикл документ в Диадоке проходит через множество событий, например:
- пользователь формирует или загружает документы в Диадок, согласовывает, подписывает и отправляет контрагенту,
- контрагент подписывает документ или формирует ответный титул,
- пользователь или его контрагент могут аннулировать документ,
- контрагент может запросить исправление или корректировку,
- оператор проверяет валидность подписей под документом.
Эти и другие события влияют на состояние документа.
Понять, в каком состоянии и на какой стадии обработки находится документ, можно с помощью статусов документа.
Для каждой стадии документооборота в Диадоке существуют свои статусы. Они зависят от того, какой этап проходит документ, выполнили ли ответственные сотрудники задачи по согласованию и подписанию, подписан ли документ контрагентом. Многие статусы парные, но с разных сторон отображаются по-разному: например, «Подписан» и «Подписан контрагентом».
Кроме этого возможны так называемые двойные статусы, которые одновременно отражают состояние документа по нескольким аспектам, например: «Отказано в подписи. Требуется подписать извещение» или «Требуется подпись. Отказано в аннулировании».
Кроме основных статусов жизненного цикла документа существуют и второстепенные статусы, которые отражают состояния, не влияющие на ход и завершенность документооборота: например, статусы согласования документа. Статусы согласования отображаются только в том ящике, в котором это согласование выполняется, и не видны другой стороне.
Подробнее про статусы можно почитать в статье на сайте Диадока.
В Диадоке проводить операции с документом и отслеживать его статусы можно как с помощью интеграционных решений, так и в веб-интерфейсе.
Состояния документов
Основные состояния документа, которые можно отследить с помощью статусов:
- Завершенность документооборота. Документооборот считается завершенным, если жизненный цикл документа закончен и никакие действия по нему больше не требуются:
- под документом проставлены все необходимые подписи или отправлены извещения о получении,
- контрагент отказал в подписи,
- документ был исправлен или откорректирован: в этом случае документооборот первичного документа считается завершенным, а дальнейший документооборот ведется уже в рамках исправления или корректировки,
- документ был аннулирован,
- аннулирование по подписанному документу было запрошено, но контрагент отказал в аннулировании: в этом случае документ продолжает иметь юридическую силу.
- Ожидание действий от участников документооборота:
- требуется подписать и отправить документ: это возможно в случае, если документ сохранен как исходящий неотправленный,
- требуется подпись или титул получателя,
- требуется извещение о получении.
- Уточнение документа:
- контрагент запросил уточнение по документу: в этом случае от пользователя требуется отправить уточнение по документу — исправление или корректировку,
- пользователь отправил на документ корректировку,
- пользователь отправил на документ исправление.
- Аннулирования документа:
- документ аннулирован в одностороннем порядке: это возможно в случае, если пользователь отправил документ контрагенту в Диадоке, но этот документ еще не был обработан контрагентом,
- запрошено аннулирование по документу: запрос на аннулирование требуется в случае, если документ уже был обработан контрагентом (подписан документ, отправлено извещение о получении) или если документ был отправлен в роуминг,
- запрос на аннулирование одобрен,
- запрос на аннулирование отклонен.
- Согласование документа:
- согласование запрошено,
- согласовано,
- в согласовании отказано.
В разделах ниже приведены таблицы с возможными статусами для односторонних и двусторонних документов. Узнать об особенностях документооборота можно с помощью информации о виде документооборота.
Структуры для определения статуса
В API Диадока статусы документа можно отследить двумя способами:
- из данных структуры Document — если вы работаете с лентой событий по документам,
- из данных структуры DocflowV4 — если вы работаете с Docflow.
Статусы в этих структурах идентичны, использование того или иного способа зависит только от подхода, выбранного для работы в интеграционном решении.
Ниже приведена таблица, в которой описаны поля со статусами документов в структурах Document и DocflowV4.
Где хранятся статусы
| — | Поля структуры Document | Поля структуры DocflowV4 |
|---|---|---|
| Титул отправителя | SenderSignatureStatus | SenderTitle |
| Ответ промежуточного получателя | ProxySignatureStatus | ProxyResponse |
| Ответ получателя | RecipientResponseStatus | RecipientResponse |
| ИоП получателя на документ | RecipientReceiptMetadata | RecipientReceipt |
| ИоП отправителя на документ | SenderReceiptMetadata | SenderReceipt |
| Аннулирование | RevocationStatus | Revocation |
| Уточнение первого титула | AmendmentRequestMetadata | AmendmentRequest |
| Уточнение второго титула | RecipientResponseAmendmentRequestMetadata | RecipientResponse.AmendmentRequest |
| Согласование | ResolutionStatus | Resolution |
| Подтверждение оператора на документ | ConfirmationMetadata | Confirmation |
| Общий статус | DocflowStatus | DocflowStatus |
| Внешний документооборот | LastOuterDocflows | OuterDocflows |
| Роуминг | RoamingNotificationStatus | SenderTitle.RoamingNotification |
Статусы внешнего документооборота для документов с маркированными и прослеживаемыми товарами, а также для перевозочных документов описаны на страницах Документы с маркированными товарами, Документы с прослеживаемыми товарами и Обработка в ГИС ЭПД соответственно.
У некоторых структур, отражающих статус документа в DocflowV4, есть признак IsFinished, который отражает завершенность документооборота каждой отдельной сущности: титула отправителя и получателя, извещения о получении, аннулирования, уточнения, согласования и подтверждения оператора. Вы можете использовать этот признак, чтобы определить, требуются ли еще какие-либо действия по документообороту этих сущностей.
Статусы односторонних документов
В этом разделе рассматриваются однотитульные документы без запроса подписи.
К таким документам относятся, например, УПД с функцией СЧФ, счета-фактуры и неформализованные документы без запроса ответной подписи.
В зависимости от вида документооборота существуют следующие особенности таких документов:
- Ответным действием получателя для некоторых типов документов может считаться извещение о получении — например, для формализованных документов. Определить необходимость отправки извещения можно по свойству вида документооборота
TitleReceiptBehaviorдля соответствующего участника —Sender,RecipientилиProxy. В случае необходимости отправки извещения документооборот будет считаться завершенным только после получения извещения. - Для некоторых видов документооборота существует возможность запросить уточнение (т.е. отправить уведомление об уточнении) и отправить уточнение. Определить возможность уточнения можно по свойству вида документооборота
SupportsAmendmentRequest. Уточнение отправляется в виде КСФ/ИСФ или УКД/ИУПД соответственно.
Статусы однотитульных документов без запроса подписи
| Статус у отправителя | Статус у получателя | Поля структуры Document | Поля структуры DocflowV4 |
|---|---|---|---|
| Завершенный документооборот | |||
| Документооборот завершен | Документооборот завершен |
|
|
| Аннулирован | Аннулирован |
|
|
| Отказано в аннулировании | Отказано в аннулировании |
|
|
| Исправлен | Исправлен |
|
|
| Откорректирован | Откорректирован |
|
|
| Требуется действие отправителя | |||
| Требуется подписать и отправить | — |
|
|
| Ошибка в подписи | — |
|
|
| Требуется аннулирование | Ожидается аннулирование |
|
|
| Требуется действие получателя | |||
| Ожидается извещение о получении | Требуется подписать извещение |
|
|
| Ожидается аннулирование | Требуется аннулирование |
|
|
| Согласование | |||
| Согласован | Согласован |
|
|
| На согласовании или подписании | На согласовании или подписании |
|
|
| Запрошена подпись | На подписании |
|
|
| Отказано в согласовании | Отказано в согласовании |
|
|
| Отказано в запросе подписи | Отказано в запросе подписи |
|
|
| Другое | |||
| Подпись отправителя не проверена | — |
|
|
| Подпись отправителя проверена и валидна | — |
|
|
| Не прочитан | — |
|
|
Статусы двусторонних документов
В этом разделе рассматриваются двухтитульные документы, а также однотитульные документы с запросом подписи или с обязательной подписью.
К таким документам относятся, например, УПД c функциями ДОП и СЧФДОП, акты, накладные и неформализованные документы с запросом ответной подписи.
В зависимости от вида документооборота существуют следующие особенности таких документов:
- Ответное действие может представлять собой либо подпись под документом, либо сформированный титул получателя в формате XML-файла. Определить, какое действие требуется для документа, — подпись или ответный титул, — можно по свойству вида документооборота
ParticipantActionдля участникаRecipient. Для простоты в таблице ниже оба этих действия называются подписью: для документов с ответным титулом под действием «Подписать» понимается необходимость сформировать и отправить ответный титул. - Для некоторых видов документооборота возможен запрос извещения о получении для одной или обеих сторон документооборота: в этом случае возможен двойной статус документа, когда помимо подписи от контрагента ожидается еще и извещение о получении. Определить возможность запроса извещения о получении на любой титул можно по свойству вида документооборота
TitleReceiptBehaviorдля соответствующего участника —Sender,RecipientилиProxy. - Для некоторых видов документооборота существует возможность запросить уточнение (т.е. отправить уведомление об уточнении) и отправить уточнение. Определить возможность уточнения можно по свойству вида документооборота
SupportsAmendmentRequest. Уточнение отправляется в виде УКД/ИУПД соответственно.
Особенности обработки документов:
- Для документов с ответным титулом в формате XML-файла возможно формирование подписи с разногласиями — в этом случае получатель формирует ответный документ и в комментариях указывает разногласия.
- Для документов с ответным титулом в формате XML-файла отказ в подписи можно передавать как сформированный титул получателя в формате XML-файла (код итога = 3) или как сформированный служебный документ с отказом в подписи.
- Документооборот документов с ответным титулом в формате XML-файла считается завершенным только в случае, если извещение о получении на титул получателя либо не было запрошено, либо было получено.
- Уточнения первого и второго титулов независимы. При одновременных уточнениях обоих титулов в основном статусе приоритет имеет требование действия по собственному титулу («Требуется уточнение») над ожиданием действия другой стороны («Ожидается уточнение»).
Статусы двухтитульных документов и однотитульных документов с запросом подписи или с обязательной подписью
| Статус у отправителя | Статус у получателя | Поля структуры Document | Поля структуры DocflowV4 |
|---|---|---|---|
| Завершенный документооборот | |||
| Подписан контрагентом | Подписан |
|
|
| Подписан с разногласиями контрагентом | Подписан с разногласиями |
|
|
| Контрагент отказал в подписи | Отказано в подписи |
|
|
| Аннулирован | Аннулирован |
|
|
| Отказано в аннулировании | Отказано в аннулировании |
|
|
| Исправлен | Исправлен |
|
|
| Откорректирован | Откорректирован |
|
|
| Требуется действие отправителя | |||
| Требуется подписать и отправить | — |
|
|
| Ошибка в подписи | — |
|
|
| Требуется подписать извещение | Ожидается извещение о получении |
|
|
| Требуется уточнение | Ожидается уточнение |
|
|
| Требуется аннулирование | Ожидается аннулирование |
|
|
| Требуется действие получателя | |||
| Ожидается подпись контрагента | Требуется подпись |
|
|
| Ожидается уточнение | Требуется уточнение |
|
|
| Ожидается подпись контрагента | Ошибка в подписи |
|
|
| Ожидается извещение о получении | Требуется подписать извещение |
|
|
| Ожидается аннулирование | Требуется аннулирование |
|
|
| Согласование | |||
| Согласован | Согласован |
|
|
| На согласовании или подписании | На согласовании или подписании |
|
|
| Запрошена подпись | На подписании |
|
|
| Отказано в согласовании | Отказано в согласовании |
|
|
| Отказано в запросе подписи | Отказано в запросе подписи |
|
|
| Другое | |||
| Подпись отправителя проверена и валидна | — |
|
|
| Подпись отправителя не проверена | — |
|
|
| Не прочитан | — |
|
|