Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить список: балансы клиентов

Возвращает балансы клиентов. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: List current client account states

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/finance/client-balances?directionId={directionId}
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdОбязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
currencyНеобязательно
querystring
Параметр фильтрации или управления выдачей: currency.Допустимо: all, USDПример: all
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Client balances

application/json

Схема: ClientBalanceResponse

ПолеТипОписание
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
dataОбязательно
ClientBalanceRow[]
Элементы текущей страницы результата.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
totalОбязательно
integer
Поле «total» в структуре запроса или ответа.
{
  "availableActions": [
    "create_payment"
  ],
  "data": [
    {
      "available": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "availableActions": [
        "create_payment"
      ],
      "balance": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "billingModel": "deposit",
      "currency": "string",
      "debt": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lastPaymentAt": "2026-09-05T12:00:00Z",
      "manager": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "name": "string",
      "overdue": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "reserved": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "scale": 1,
      "state": "normal"
    }
  ],
  "total": 1
}
403

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}