Documentation menu
These are pre-release docs from the main branch.

API reference

4 operations in fx. Raw spec: openapi.json.

GET/api/v1/fx/rates

GET /api/fx/rates — the org's append-only rate book, newest first.

Parameters

NameInTypeRequiredDescription
base_currencyquerystringNo
quote_currencyquerystringNo

Responses

StatusDescription
200

Security: bearer

POST/api/v1/fx/rates

POST /api/fx/rates — manual entry (the built-in provider's write path). Append-only: corrections are new rows; the effective-rate resolver always picks the newest capture on-or-before the requested date.

Request body

RecordRateRequest

Responses

StatusDescription
200
422

Security: bearer

GET/api/v1/fx/rates/resolve

GET /api/fx/rates/resolve — the effective rate for one direction on one date (defaults to today). Read-only; mirrors the resolver the lock-moment write paths use.

Parameters

NameInTypeRequiredDescription
fromquerystringYes
toquerystringYes
as_ofquerystringNo

Responses

StatusDescription
200
404

Security: bearer

GET/api/v1/fx/reconciliation

GET /api/fx/reconciliation — the FX deliverable to the books (FX7): original amount, rate, source/date, base equivalent, sync target. The core records conversions that happened; realized/unrealized gain-loss stays in the accounting system.

Parameters

NameInTypeRequiredDescription
limitqueryintegerNo

Responses

StatusDescription
200

Security: bearer