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

Creodock API

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

Получить: финансовые операции

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

OpenAPI: Read one immutable financial journal entry

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
operationIdОбязательно
pathstring · uuid
Идентификатор ресурса в пути запроса: operationId.

Ответы

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

200

Financial operation detail

application/json

Схема: FinancialOperation

ПолеТипОписание
attachmentNameНеобязательно
string
Поле «attachmentName» в структуре запроса или ответа.
authorНеобязательно
Option
Поле «author» в структуре запроса или ответа.
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
balanceAfterНеобязательно
Money
Поле «balanceAfter» в структуре запроса или ответа.
basisОбязательно
string
Поле «basis» в структуре запроса или ответа.
changeОбязательно
Money
Поле «change» в структуре запроса или ответа.
clientНеобязательно
Option
Поле «client» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
kindОбязательно
string
Поле «kind» в структуре запроса или ответа.Допустимо: payment, order_charge, reserve, release, invoice, refund_to_balance, cash_refund, adjustment, reversal, payout_accrual, payoutПример: payment
occurredAtОбязательно
string · date-time
Поле «occurredAt» в структуре запроса или ответа.
recipientНеобязательно
Option
Поле «recipient» в структуре запроса или ответа.
relatedLabelНеобязательно
string
Поле «relatedLabel» в структуре запроса или ответа.
reversesOperationIdНеобязательно
string · uuid
Поле «reversesOperationId» в структуре запроса или ответа.
statusОбязательно
string
Текущий статус объекта.Допустимо: pending, confirmed, rejected, reversedПример: pending
versionНеобязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "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

404

Problem Details response

application/json

Схема: Problem

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

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

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

Формат 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": "Выберите формат." }
  ]
}