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

Creodock API

Все операции
PATCHИнтеграция рабочей областиИдемпотентная команда

Изменить ставку начисления

Требуется finance.operations. Сохраняет новую версию ставки; ранее зафиксированные ставки и начисления не пересчитываются. membershipId задаёт индивидуальную ставку, archived=true архивирует её. Изменение и восстановление требуют текущую version. Повтор идентичного Idempotency-Key возвращает прежний результат; иной payload возвращает 409.

PATCHhttps://api.creodock.com/api/v1/organizations/{organizationId}/finance/rates
Кто вызывает
Интеграция рабочей области
Передайте API-ключ рабочей области в заголовке Authorization: Bearer cdk_live_…
Доступ
finance.write
Все перечисленные права должны быть доступны вызывающей стороне.

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

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

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

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

Тело запроса

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

application/json
ПолеТипОписание
amountMinorНеобязательно
string
Сумма в минимальных единицах валюты.Пример: 2500
membershipIdНеобязательно
string
Поле «membershipId» в структуре запроса или ответа.Пример: 00000000-0000-0000-0000-000000000000
versionНеобязательно
integer
Версия объекта для защиты от конфликтующих изменений.Пример: 1
workTypeIdНеобязательно
string
Поле «workTypeId» в структуре запроса или ответа.Пример: 00000000-0000-0000-0000-000000000000

Ответы

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

200

Ставка обновлена

application/json

Схема: MutationResult

ПолеТипОписание
idОбязательно
string · uuid
Уникальный идентификатор объекта.
versionНеобязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "id": "00000000-0000-0000-0000-000000000000",
  "version": 1
}
403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

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