Справочник API публикуется на английском языке.

Record a finance event

POST/api/companies/{companyId}/finance-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 4 · История

Record a finance event.

Amounts accept exact decimal cents in the recorded currency. Credits use a nonnegative amount with direction credit. No currency conversion is inferred. Receipt-key conflicts return 409.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

idempotencyKeystring | nullНеобязательный1–200 characters
agentIdstring (uuid) | nullНеобязательный
issueIdstring (uuid) | nullНеобязательный
projectIdstring (uuid) | nullНеобязательный
goalIdstring (uuid) | nullНеобязательный
heartbeatRunIdstring (uuid) | nullНеобязательный
costEventIdstring (uuid) | nullНеобязательный
billingCodestring | nullНеобязательный
descriptionstring | nullНеобязательныйat most 500 characters
eventKindstringОбязательныйone of: "inference_charge", "platform_fee", "credit_purchase", "credit_refund", "credit_expiry", "byok_fee", "gateway_overhead", "log_storage_charge", "logpush_charge", "provisioned_capacity_charge", "training_charge", "custom_model_import_charge", "custom_model_storage_charge", "manual_adjustment"
directionstringНеобязательныйone of: "debit", "credit"
billerstringОбязательныйat least 1 character
providerstring | nullНеобязательныйat least 1 character
executionAdapterTypestring | nullНеобязательныйone of: "process", "http", "claude_local", "codex_local", "veyra_hands", "cursor_cloud", "gemini_local", "grok_local", "hermes_gateway", "hermes_local", "kimi_local", "opencode_local", "pi_local", "cursor", "openclaw_gateway"
pricingTierstring | nullНеобязательныйat least 1 character
regionstring | nullНеобязательныйat least 1 character
modelstring | nullНеобязательныйat least 1 character
quantityinteger | nullНеобязательный≥ 0
unitstring | nullНеобязательныйone of: "input_token", "output_token", "cached_input_token", "request", "credit_usd", "credit_unit", "model_unit_minute", "model_unit_hour", "gb_month", "train_token", "unknown"
amountCentsstring | numberОбязательный
currencystringНеобязательныйpattern: ^[A-Za-z]{3}$
estimatedbooleanНеобязательный
externalInvoiceIdstring | nullНеобязательный
metadataJsonobject | nullНеобязательный
occurredAtstring (date-time)Обязательный

Ответы

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Costs and budgets