Record a finance event

POST/api/companies/{companyId}/finance-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

idempotencyKeystring | nullOptional1–200 characters
agentIdstring (uuid) | nullOptional
issueIdstring (uuid) | nullOptional
projectIdstring (uuid) | nullOptional
goalIdstring (uuid) | nullOptional
heartbeatRunIdstring (uuid) | nullOptional
costEventIdstring (uuid) | nullOptional
billingCodestring | nullOptional
descriptionstring | nullOptionalat most 500 characters
eventKindstringRequiredone 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"
directionstringOptionalone of: "debit", "credit"
billerstringRequiredat least 1 character
providerstring | nullOptionalat least 1 character
executionAdapterTypestring | nullOptionalone 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 | nullOptionalat least 1 character
regionstring | nullOptionalat least 1 character
modelstring | nullOptionalat least 1 character
quantityinteger | nullOptional≥ 0
unitstring | nullOptionalone 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 | numberRequired
currencystringOptionalpattern: ^[A-Za-z]{3}$
estimatedbooleanOptional
externalInvoiceIdstring | nullOptional
metadataJsonobject | nullOptional
occurredAtstring (date-time)Required

Responses

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

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Costs and budgets