Docflow payment requests

Распознать счёт для заявки на оплату

Changed on

Читает счёт поставщика и отвечает полями, которыми заполняется заявка: получатель с ИНН, расчётным счётом, БИК и банком, юрлицо-плательщик и контрагент из справочника по ИНН, сумма, валюта, налог, номер, дата и срок оплаты. Ничего не записывает. Счёт приходит одним из двух способов. JSON со ссылкой на карточку документооборота (document_id и, если файлов в карточке несколько, file_id) — путь агента и внешней системы: файл кладут в карточку сессией загрузки, а созданная заявка встаёт на ту же карточку основанием (basis docflow / flow_document). Форма multipart с полем file — путь экрана. Нечитаемый файл — не отказ: parsed=false, и заявка заполняется руками. Карточка не названа или без файла — 422 docflow.payment_request.field с полем document_id; несколько файлов без file_id или чужой file_id — то же с полем file_id.

post/api/v1/docflow/payment-requests/recognize

Request

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

Headers

X-Tenantstring required

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

Request body

document_idstring uuid required
file_idstring uuid

Response

Распознанный счёт

messagestring uuid required
source'title' | 'text' | 'none' required

Чем прочитан счёт: title — формализованный титул ФНС, text — текст вложения, none — читать было нечего.

parsedboolean required

Вышло ли из документа хоть одно поле. Ложь означает, что форма открывается тем же, чем открывалась раньше

documentstring required

Имя вложения, из которого всё прочитано, словами оператора: по нему человек откроет ту же бумагу и сверит

companystring uuid required
contactstring uuid required
contractstring uuid
vat_withoutboolean required

В счёте стояла отметка «без налога (НДС)». Пустая сумма при снятой отметке означает «про налог не сказано», а не «налога нет»

vat_mode'included' | 'added'

Налог «в том числе» или «сверху» по итогам бумаги (ERP-2733): «Итого» плюс налог дают сумму к оплате — added; нет поля — бумага этого не показывает

paper_kind'invoice' | 'act'

Вид бумаги по заголовку: «Счёт № …» или «Акт № …» (ERP-2733); нет поля — заголовка нет

Changes