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

Creodock API

Все операции
POSTИнтерфейс CreodockИдемпотентная команда

Создать: выплаты

Безопасно создаёт выплаты на основании переданного тела запроса.

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

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

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

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdОбязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: CreatePayoutRequest

ПолеТипОписание
accrualIdsОбязательно
string[]
Поле «accrualIds» в структуре запроса или ответа.
adjustmentMinorНеобязательно
string
Поле «adjustmentMinor» в структуре запроса или ответа.Формат: ^-?[0-9]+$
commentНеобязательно
string
Поле «comment» в структуре запроса или ответа.
currencyОбязательно
string
Трёхбуквенный код валюты ISO 4217.
periodFromОбязательно
string · date
Поле «periodFrom» в структуре запроса или ответа.
periodToОбязательно
string · date
Поле «periodTo» в структуре запроса или ответа.
recipientMembershipIdОбязательно
string · uuid
Поле «recipientMembershipId» в структуре запроса или ответа.

Ответы

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

201

Payout statement draft

application/json

Схема: PayoutStatement

ПолеТипОписание
amountОбязательно
Money
Поле «amount» в структуре запроса или ответа.
approvedAtНеобязательно
string · date-time
Поле «approvedAt» в структуре запроса или ответа.
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
currencyОбязательно
string
Трёхбуквенный код валюты ISO 4217.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
itemsОбязательно
PayoutItem[]
Поле «items» в структуре запроса или ответа.
numberОбязательно
string
Поле «number» в структуре запроса или ответа.
paidAtНеобязательно
string · date-time
Поле «paidAt» в структуре запроса или ответа.
periodLabelОбязательно
string
Поле «periodLabel» в структуре запроса или ответа.
recipientОбязательно
Option
Поле «recipient» в структуре запроса или ответа.
scaleОбязательно
integer
Поле «scale» в структуре запроса или ответа.
statusОбязательно
string
Текущий статус объекта.Допустимо: draft, review, approved, paid, cancelledПример: draft
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "amount": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0
  },
  "approvedAt": "2026-09-05T12:00:00Z",
  "availableActions": [
    "create_payment"
  ],
  "currency": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "items": [
    {
      "amount": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "accrual",
      "positionId": "00000000-0000-0000-0000-000000000000",
      "taskId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "number": "string",
  "paidAt": "2026-09-05T12:00:00Z",
  "periodLabel": "string",
  "recipient": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "scale": 1,
  "status": "draft",
  "version": 1
}