Ledger API reference · API documentation example

Accounts and transactions over JSON. Explore resource definitions, request parameters and response states alongside copyable cURL examples.

Getting started

These pages describe an API you can implement using the same financial model as the Application and Specification.

Set $API_ORIGIN to your backend's origin before using the requests. This catalog does not expose a financial API, issue credentials or run requests.

Resources

Accounts

Financial classification, reporting currency and derived balances.

Transactions

Dated signed activity, linked accounts and verification state.

Conventions

Content-Typeapplication/json: Requests and responses use JSON. Resource identifiers are integers.
Dates and amountsdate-only · decimal: Transaction dates use YYYY-MM-DD. All signed amounts and account balances are USD.
ErrorsJSON object: Field validation uses 400; unknown resources use 404; duplicate names and deletion dependencies use 409.

Application demo forms validate without persistence. API request examples describe an implementation contract, not operations performed by the preview.

[ { "accountType": "Asset", "balance": 15611, "currency": "USD", "id": 101, "name": "Operating checking" }, { "accountType": "Asset", "balance": 7950, "currency": "USD", "id": 102, "name": "Tax reserve" }, { "accountType": "Liability", "balance": -775, "currency": "USD", "id": 103, "name": "Business credit card" }, { "accountType": "Asset", "balance": 5000, "currency": "USD", "id": 104, "name": "Savings" }, { "accountType": "Expense", "balance": 0, "currency": "USD", "id": 105, "name": "Unassigned expense" } ]