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

Creodock API

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

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

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

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

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

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

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

Параметры

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

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

Ответы

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

200

Client payments

application/json

Схема: ClientPaymentResponse

ПолеТипОписание
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
dataОбязательно
ClientPayment[]
Элементы текущей страницы результата.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
totalОбязательно
integer
Поле «total» в структуре запроса или ответа.
{
  "availableActions": [
    "create_payment"
  ],
  "data": [
    {
      "amount": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "availableActions": [
        "create_payment"
      ],
      "client": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "comment": "string",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "externalReference": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "invoiceIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "method": "string",
      "occurredAt": "2026-09-05T12:00:00Z",
      "orderId": "00000000-0000-0000-0000-000000000000",
      "possibleDuplicate": true,
      "status": "pending",
      "version": 1
    }
  ],
  "total": 1
}