---
title: "Показать сведение прихода с возвратами"
method: POST
path: "/api/v1/finance/settlements/refunds/preview"
tags: ["Finance settlements"]
---

# Показать сведение прихода с возвратами

`POST /api/v1/finance/settlements/refunds/preview`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/finance/settlements/refunds/preview`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)
  - HTTP bearer

Ничего не записывает. Для пары «приход ↔ возврат(ы)» одного контрагента в одной валюте показывает, какие суммы сведутся: остаток прихода, остаток каждого возврата, сумму каждой пары, итог и несведённую часть прихода.

## Headers

- `X-Tenant` string, required

## Request body

- FinanceRefundSettlementInput
  - `business_id` string, uuid
  - `company_id` string, uuid
  - `contact_id` string, uuid, required
  - `currency` string, required: Валюта прихода и возвратов, код ISO 4217
  - `date` string, date, required: Дата сведения
  - `payment` string, uuid, required
  - `returns` UUID[], required: Возвраты денег тому же контрагенту: документы оплат или строки выписки
  - `comment` string: Комментарий к документам сведения
  - `source` object: Происхождение внешнего вызова
    - `source_system` string: Внешняя система
    - `source_ref` string: Ссылка во внешней системе
    - `external_id` string: Внешний идентификатор

## Response `200`

План сведения по парам

- FinanceRefundSettlementPreview
  - `payment_number` string: Номер прихода
  - `payment_remaining` string: Остаток прихода в расчётах
  - `currency` string: Валюта
  - `pairs` FinanceRefundSettlementPair[]
    - `return_payment_id` string: Возврат
    - `return_number` string: Номер возврата
    - `return_remaining` string: Остаток возврата в расчётах
    - `amount` string: Сколько сведётся у пары
  - `total` string: Сумма по всем парам
  - `unmatched` string: Остаток прихода, не покрытый возвратами

## Other responses

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

---

[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/3c60ded179f2?raw)