Docflow mirror

Получить пакет документов

Вид документа, его подвид и регламент — слова ОПЕРАТОРА, а не наша классификация: зеркало обязано сохранить то, что действительно пришло. Сумма приходит строкой ровно так, как её прислал оператор: через плавающую точку здесь теряются копейки, а сверять их придётся с проводками.

get/api/v1/docflow/messages/{id}

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/docflow/messages/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Path parameters

idstring uuid required

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Пакет документов

idstring uuid required
connectionstring uuid required
external_idstring required

Идентификатор пакета у оператора

external_revisionstring required

Редакция пакета: оператор меняет содержимое конверта, не меняя его идентификатор

direction'incoming' | 'outgoing' required
doc_typestring required

Слова оператора, а не наша классификация

doc_subtypestring required
doc_regulationstring required
numberstring required
datestring required

Календарная дата документа ГГГГ-ММ-ДД; пусто означает, что даты нет вовсе

amountstring required

Сумма строкой ровно так, как её прислал оператор; пусто означает «суммы нет», а не ноль

currencystring required
state_codestring required

Код состояния документооборота у оператора

state_namestring required

Состояние словами оператора: своего перевода состояний у нас нет и быть не должно

our_org_external_idstring required
received_atstring date-time
created_atstring date-time required
updated_atstring date-time required
connection_namestring required
connection_providerstring required
stage_repeatboolean

Оператор подключения умеет «Повторить этап» утверждения входящего документа (Saby). У Контур.Диадока такого действия нет

companystring uuid
company_namestring required
attachments_totalinteger required
signatures_totalinteger required
actions_dueinteger required

Сколько незакрытых этапов у пакета. Ноль означает «ход не за нами»

stage_namestring required

Название ближайшего незакрытого этапа словами оператора

sign_requiredboolean required

У пакета открыт этап, который закрывается нашей подписью под самим документом. Отдельно от actions_due и stage_name: счётчик говорит «ход за нами», а название этапа — слова оператора, и отличить по ним подпись от согласования нельзя. Пока признак поднят, приёмка к учёту отказывает кодом docflow.edo.sign_first

notice_sign_requiredboolean required

Открытый подписной этап служебный: извещение о получении, подтверждение даты, квитанция. Отдельным признаком, потому что человеку это другое дело — «Подписать извещение» подтверждает технологию обмена, а не содержание документа. Приёмку к учёту служебный этап НЕ держит

accounting_documentstring uuid
accepted_atstring date-time nullable

Когда пакет приняли к учёту. Переживает удаление учётного документа: приёмка была

accepted_byinteger nullable

Кто принял пакет к учёту

accounting_numberstring

Номер учётного документа приёмки для строки «В учёте: … № …»; пусто — не принят или документ не прочитан

accounting_typestring

Вид учётного документа приёмки (ключ вида документа ядра), например finance_purchase

draftboolean required

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

deleted_atstring date-time nullable

Корзина НАШЕГО зеркала: контрагент её не видит, и пакет у оператора остаётся прежним

deleted_byinteger nullable
deleted_reason'' | 'trashed' | 'draft_removed' required

Возвращают из корзины только trashed: у draft_removed документа у оператора больше нет

viewedboolean required

Открывал ли карточку пакета текущий сотрудник — личная отметка, а не состояние у оператора. Считается в ленте одним запросом на страницу; карточка отдаёт false, потому что её открытие само ставит отметку дверью viewed.

state_category'in_work' | 'awaiting_signature' | 'cancellation_requested' | 'cancellation_refused' | 'draft' | 'error' | 'signer_invalid' | 'approved' | 'rejected' | 'cancelled' | 'interrupted' required

Состояние пакета нашими словами поверх кода оператора (справочник «Код состояния документа»): в работе, ждёт подписи, запрос на аннулирование, отказ в аннулировании, черновик, с ошибкой, подписант не прошёл проверку, утверждён, отклонён, аннулирован, прервано. Слово оператора остаётся в state_name.

operator_linkstring required

Карточка документа в кабинете нашей организации у оператора («СсылкаДляНашаОрганизация»); пусто, пока карточку не перечитали

Changes

No recorded changes to this operation across all 1 revision of this API.