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

Creodock API

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

Создать: счета

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

POSThttps://api.creodock.com/api/v1/organizations/{organizationId}/finance/invoices?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

Схема: CreateInvoiceRequest

ПолеТипОписание
clientIdОбязательно
string · uuid
ID связанного клиента.
commentНеобязательно
string
Поле «comment» в структуре запроса или ответа.
dueAtОбязательно
string · date-time
Поле «dueAt» в структуре запроса или ответа.
itemsОбязательно
object[]
Поле «items» в структуре запроса или ответа.Минимум элементов: 1

Ответы

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

201

Invoice draft

application/json

Схема: FinanceInvoice

ПолеТипОписание
amountОбязательно
Money
Поле «amount» в структуре запроса или ответа.
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
clientОбязательно
Option
Поле «client» в структуре запроса или ответа.
dueAtНеобязательно
string · date-time
Поле «dueAt» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
issuedAtНеобязательно
string · date-time
Поле «issuedAt» в структуре запроса или ответа.
itemsОбязательно
InvoiceItem[]
Поле «items» в структуре запроса или ответа.
numberОбязательно
string
Поле «number» в структуре запроса или ответа.
outstandingОбязательно
Money
Поле «outstanding» в структуре запроса или ответа.
paidОбязательно
Money
Поле «paid» в структуре запроса или ответа.
statusОбязательно
string
Текущий статус объекта.Допустимо: draft, issued, partially_paid, paid, overdue, cancelledПример: draft
taskIdsОбязательно
string[]
Поле «taskIds» в структуре запроса или ответа.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "amount": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0
  },
  "availableActions": [
    "create_payment"
  ],
  "client": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "dueAt": "2026-09-05T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "issuedAt": "2026-09-05T12:00:00Z",
  "items": [
    {
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "quantity": "string",
      "taskId": "00000000-0000-0000-0000-000000000000",
      "total": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      },
      "unitAmount": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 0
      }
    }
  ],
  "number": "string",
  "outstanding": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0
  },
  "paid": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0
  },
  "status": "draft",
  "taskIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "version": 1
}