---
title: "Узнать остаток бумаг к заявке на оплату"
method: GET
path: "/api/v1/docflow/payment-requests/basis-balances"
tags: ["Docflow payment requests"]
---

# Узнать остаток бумаг к заявке на оплату

`GET /api/v1/docflow/payment-requests/basis-balances`

## Request

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

По каждой бумаге-основанию — счёту, закупке, договору, долгу, входящему документу ЭДО — отвечает «заявлено · оплачено · осталось»: сумму бумаги (total, у договора без суммы и бумаги без суммы предела нет — limited=false), сколько держат заявки на согласовании, на доработке и согласованные (claimed), сколько из них оплачено (paid) и сколько ещё можно заявить (remaining). Закупка считает и заявки по бумагам, лежащим в ней; договор с суммой — и заявки по бумагам этого договора; у долга остаток уже за вычетом оплаченного. Суммы — по всем заявкам бумаги, строки заявок (requests) — только видимые спросившему. Бумага — параметр basis вида module:kind:id, повтором или через запятую, до ста бумаг. Юрлицо, контрагент и валюта — разрез заявки: в нём числится остаток долга. except — правится эта заявка: её сумма в claimed не входит. Право — заводить, читать или согласовывать заявки. Ничего не пишет.

## Query parameters

- `basis` string[], required
- `company_id` string, uuid
- `contact_id` string, uuid
- `currency` string
- `except` string, uuid

## Headers

- `X-Tenant` string, required

## Response `200`

Остатки бумаг

- DocflowPaymentBasisBalanceList
  - `results` DocflowPaymentBasisBalance[], required
    - `module` string, required
    - `kind` string, required
    - `id` string, uuid, required
    - `paper_kind` 'invoice' | 'order' | 'contract' | 'debt' | 'paper', required: Вид бумаги: счёт, закупка, договор, долг или иная бумага
    - `currency` string, required
    - `limited` boolean, required: У бумаги есть сумма-предел; нет — total и remaining пусты
    - `total` string: Сумма бумаги: итог счёта или закупки, сумма договора, остаток долга
    - `claimed` string, required: Держат заявки на согласовании, на доработке и согласованные
    - `paid` string, required: Из заявленного оплачено
    - `remaining` string: Сколько ещё можно заявить
    - `requests` DocflowPaymentRequestBrief[], required: Заявки по бумаге, видимые спросившему, кроме отозванных
      - `id` string, uuid, required
      - `number` string, required
      - `amount` string, required
      - `currency` string, required
      - `due_date` string, date, required
      - `status` 'draft' | 'on_approval' | 'rework' | 'approved' | 'rejected' | 'cancelled', required: Состояние документа заявки: черновик, на согласовании, на доработке, согласована, отклонена, отозвана
      - `progress` string, required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права
- `422`: Запрос разобран, но бизнес-значение недопустимо
- `503`: Внешний банк, справочник или контур подключений временно недоступен

## Changes

- **2026-10-20** `765c65fadf8f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/akeda/apis/akeda-erp-client-api/changes/api/v1/docflow/payment-requests/basis-balances/get.md)

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/7a6b75f272ee?raw)
