Docflow flow

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

Список карточек внутреннего документооборота: договоры, спецификации, акты и прочие бумаги кабинета. Каждая строка — ПОЛНАЯ карточка текущей редакции вместе с файлами и связями. Листа согласования в ней нет: согласование вынесено в самостоятельную сущность со своим предметом и читается операциями крыла согласований.

Отбор awaiting_my_approval=true оставляет только то, что ждёт решения ТЕКУЩЕГО человека: действующее лицо сервер берёт из сессии, назвать в отборе чужого нечем. Допустимых значений ровно два — true и false; любое другое отвечает отказом 400, а не молча игнорируется. Значение false отбор не сужает и равнозначно его отсутствию.

Набор строк называется items — как у остальных страниц этого контура. Крыло обмена с контрагентами (ЭДО) в том же модуле исторически называет его results, и это расхождение здесь названо вслух, а не оставлено на догадку читателя.

Без явного status архивные документы скрыты. Отбор related_to возвращает связную компоненту графа связей документа целиком, и архивные в ней остаются: разорванная история — это не история.

get/api/v1/docflow/flow/documents

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/docflow/flow/documents
  • 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)

Query parameters

searchstring

Поиск подстрокой по заголовку, номеру, контрагенту, юрлицу, предмету договора и ИНН контрагента; до 200 знаков

kind'contract' | 'specification' | 'amendment' | 'invoice' | 'act' | 'upd' | 'goods_waybill' | 'transport_waybill' | 'consignment_note' | 'transport_order' | 'tax_invoice' | 'correction' | 'return' | 'discrepancy_act' | 'reconciliation_act' | 'power_of_attorney' | 'other'

Вид документа внутреннего контура. Вид называет бумагу, а не учётную операцию: продажу и закупку из бумаги делают отдельные команды.

status'draft' | 'registered' | 'archived'
company_idstring uuid

Сузить юрлицом кабинета

contact_idstring uuid

Сузить контрагентом

related_tostring uuid

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

awaiting_my_approval'true' | 'false'

true — только ждущие решения текущего человека. Иное значение, кроме false, — отказ

validity'active' | 'expiring' | 'expired'

Срок договора на сегодняшний московский день: active — зарегистрирован и срок не прошёл (или бессрочный), expiring — зарегистрирован и истекает в ближайшие 30 дней, expired — зарегистрирован, срок прошёл. Вместе со status, отличным от registered, — отказ

regular'true' | 'false'

true — только карточки с правилом графика платежей (регулярный договор)

kindsstring

Виды карточек через запятую — отбор галочками в шапке общего списка; складывается с kind и group

contact_idsstring

Контрагенты через запятую (UUID) — отбор галочками в шапке общего списка

deal'yes' | 'no'

yes — только бумаги, лежащие в сделке (связь «основание» с продажей, закупкой или договором), no — только без сделки

withstring

Через запятую. counts — вернуть state_counts: пилюли списка договоров при тех же отборах, кроме status и validity; marks — отметки строк (канал ЭДО и ход за нами, сделка, оплата счёта); total — число документов при отборах (на первой странице). Порядок строк — по дате документа, свежие сверху

limitinteger
offsetinteger

Headers

X-Tenantstring required

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

Response

Страница документов

has_moreboolean required

Changes

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