La référence de l'API est publiée en anglais.

Record a finance event

POST/api/companies/{companyId}/finance-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

idempotencyKeystring | nullFacultatif1–200 characters
agentIdstring (uuid) | nullFacultatif
issueIdstring (uuid) | nullFacultatif
projectIdstring (uuid) | nullFacultatif
goalIdstring (uuid) | nullFacultatif
heartbeatRunIdstring (uuid) | nullFacultatif
costEventIdstring (uuid) | nullFacultatif
billingCodestring | nullFacultatif
descriptionstring | nullFacultatifat most 500 characters
eventKindstringObligatoireone 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"
directionstringFacultatifone of: "debit", "credit"
billerstringObligatoireat least 1 character
providerstring | nullFacultatifat least 1 character
executionAdapterTypestring | nullFacultatifone 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 | nullFacultatifat least 1 character
regionstring | nullFacultatifat least 1 character
modelstring | nullFacultatifat least 1 character
quantityinteger | nullFacultatif≥ 0
unitstring | nullFacultatifone 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 | numberObligatoire
currencystringFacultatifpattern: ^[A-Za-z]{3}$
estimatedbooleanFacultatif
externalInvoiceIdstring | nullFacultatif
metadataJsonobject | nullFacultatif
occurredAtstring (date-time)Obligatoire

Réponses

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

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Costs and budgets