Compute
Compute Finance API reference
Read the Finance API boundary, direction fields, idempotency rules, read-back states, and safe export options.
On this page
On this page
What the API represents
The Compute Finance API carries content-free finance connections, mappings, sync events, projections, and reconciliation evidence. It is not a payment authority and cannot move money.
Every record names one commercial_flow: customer_payable, provider_receivable, or provider_payout_reconciliation.
Use the approved boundary
The API uses the account's approved authenticated context and role grant. It does not accept passwords, access keys, bank details, verification codes, or finance tokens as page input.
A connection describes readiness and safe references. A mapping names system_family, system_edition, external_object_kind, accounting_treatment, recipe version, mapping digest, sync mode, and reconciliation state.
Preserve idempotency
A Finance Sync event binds the account, organization, connection, projection digest, mapping digest, source digest, and replay basis. Repeating the same request uses the same immutable basis.
An idempotency replay must keep the same digest. A digest mismatch remains a refusal and keeps its evidence for review.
Read authoritative status
The safe mutation order is inspect, plan or dry-run, show the exact change, approve, apply idempotently, then read back.
Customer payment status comes from authoritative Lithi invoice read-back. Provider payout status comes from authoritative payout terminal read-back. External finance Paid is an annotation only.
If an external read-back differs, keep the mismatch visible and reconcile it. Do not mark a Lithi invoice or provider payout settled from external status.
Use export paths when needed
An approved finance system may use a Finance API, signed webhook, JSON, or CSV path. none_export_only is the safe choice when no write-capable system is approved.