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

Creodock API

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

Получить: финансы

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

OpenAPI: Read direction-scoped operational finance overview

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

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

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

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

Параметры

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

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

Ответы

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

200

Financial overview

application/json

Схема: FinanceOverviewResponse

ПолеТипОписание
agingОбязательно
ReceivableAging[]
Поле «aging» в структуре запроса или ответа.
asOfОбязательно
string · date-time
Поле «asOf» в структуре запроса или ответа.
attentionОбязательно
FinanceAttentionItem[]
Поле «attention» в структуре запроса или ответа.
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
cashFlowОбязательно
object[]
Поле «cashFlow» в структуре запроса или ответа.
metricsОбязательно
FinanceMetric[]
Поле «metrics» в структуре запроса или ответа.
recentOperationsОбязательно
FinancialOperation[]
Поле «recentOperations» в структуре запроса или ответа.
{
  "aging": [
    {
      "currency": "string",
      "current": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "days1To7": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "days31Plus": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "days8To30": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "scale": 1
    }
  ],
  "asOf": "2026-09-05T12:00:00Z",
  "attention": [
    {
      "amount": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "availableActions": [
        "create_payment"
      ],
      "clientId": "00000000-0000-0000-0000-000000000000",
      "detail": "string",
      "entityId": "00000000-0000-0000-0000-000000000000",
      "href": "string",
      "id": "string",
      "kind": "pending_payment",
      "title": "string",
      "version": 1
    }
  ],
  "availableActions": [
    "create_payment"
  ],
  "cashFlow": [
    {
      "currency": "string",
      "points": [
        {}
      ],
      "scale": 1
    }
  ],
  "metrics": [
    {
      "approvedPayouts": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "confirmedReceipts": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "currency": "string",
      "currentReceivable": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "orderCharges": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "scale": 1
    }
  ],
  "recentOperations": [
    {
      "attachmentName": "string",
      "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "availableActions": [
        "create_payment"
      ],
      "balanceAfter": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "basis": "string",
      "change": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "client": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "payment",
      "occurredAt": "2026-09-05T12:00:00Z",
      "recipient": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "relatedLabel": "string",
      "reversesOperationId": "00000000-0000-0000-0000-000000000000",
      "status": "pending",
      "version": 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": "Выберите формат." }
  ]
}