---
title: "Получить оплаты с нераспределённым остатком"
method: GET
path: "/api/v1/finance/settlements/payments"
tags: ["Finance settlements"]
---

# Получить оплаты с нераспределённым остатком

`GET /api/v1/finance/settlements/payments`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/finance/settlements/payments`
- 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

Страница фиксирована двумя сотнями оплат, своего limit у операции нет: offset шагают на 200. Страница короче двухсот означает, что оплаты кончились.

## Query parameters

- `company_id` string, uuid, required
- `currency` string
- `contact_id` string, uuid
- `direction` 'in' | 'out'
- `q` string
- `offset` integer

## Headers

- `X-Tenant` string, required

## Response `200`

Оплаты и нераспределённые суммы

- FinanceSettlementPaymentPage
  - `count` integer, required
  - `results` FinanceSettlementPayment[], required
    - `document` CoreDocument, required
      - `id` string, uuid, required
      - `type_id` string, uuid, required
      - `type_key` string, required
      - `type_name` string, required
      - `number` string, required
      - `date` string, date, required
      - `status` 'draft' | 'posted' | 'cancelled', required
      - `basis_type` string, uuid, required
      - `basis_id` string, uuid, required
      - `basis_number` string, required
      - `entity_refs` object, required
      - `payload` object, required
      - `comment` string, required
      - `is_marked_deleted` boolean, required
      - `created_by` integer, nullable, required
      - `created_by_name` string, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `posted_at` string, required
      - `cancelled_at` string, required
      - `custom` object: Значения своих полей кабинета (графы вида core.document.<ключ вида>). Отдаёт карточка документа; списки поле не несут
    - `remaining` string, required: Decimal string

## Other responses

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

---

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