---
title: "Получить остатки регистра"
method: GET
path: "/api/v1/core/registers/{key}/balance"
tags: ["Core registers"]
---

# Получить остатки регистра

`GET /api/v1/core/registers/{key}/balance`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/core/registers/{key}/balance`
- 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

Страница остатков: строка на каждое сочетание измерений, по возрастанию разреза. Остаток — не одна цифра, и у склада с тысячей артикулов в разрезе партий он в одну страницу не помещается, поэтому у операции есть offset. Ответ называет применённые limit и offset — страница ровно в limit строк означает, что итог срезан, запрашивайте следующую с offset += limit или сужайте разрез.

## Path parameters

- `key` string, required

## Query parameters

- `group` string
- `dim.<key>` string
- `date_from` string
- `date_to` string
- `limit` integer
- `offset` integer

## Headers

- `X-Tenant` string, required

## Response `200`

Остатки по разрезам

- CoreRegisterBalancePage
  - `count` integer, required
  - `limit` integer, required: Применённый размер страницы — то число, на котором читающая функция реально режет выдачу
  - `offset` integer, required: Применённое смещение
  - `results` CoreRegisterBalanceRow[], required
    - `dims` object, required
    - `totals` object, required: Итог по каждому ресурсу — числом JSON, а не десятичной строкой, как денежные поля документов: {"qty": 6.8, "amount": 34000}
    - `entry_count` integer, required

## 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)