La referencia de la API se publica en inglés.

Record a finance event

POST/api/companies/{companyId}/finance-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 4 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

idempotencyKeystring | nullOpcional1–200 characters
agentIdstring (uuid) | nullOpcional
issueIdstring (uuid) | nullOpcional
projectIdstring (uuid) | nullOpcional
goalIdstring (uuid) | nullOpcional
heartbeatRunIdstring (uuid) | nullOpcional
costEventIdstring (uuid) | nullOpcional
billingCodestring | nullOpcional
descriptionstring | nullOpcionalat most 500 characters
eventKindstringObligatorioone 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"
directionstringOpcionalone of: "debit", "credit"
billerstringObligatorioat least 1 character
providerstring | nullOpcionalat least 1 character
executionAdapterTypestring | nullOpcionalone 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 | nullOpcionalat least 1 character
regionstring | nullOpcionalat least 1 character
modelstring | nullOpcionalat least 1 character
quantityinteger | nullOpcional≥ 0
unitstring | nullOpcionalone 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 | numberObligatorio
currencystringOpcionalpattern: ^[A-Za-z]{3}$
estimatedbooleanOpcional
externalInvoiceIdstring | nullOpcional
metadataJsonobject | nullOpcional
occurredAtstring (date-time)Obligatorio

Respuestas

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).

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Costs and budgets