API reference

JSON over HTTPS. Every response uses the envelope; lists paginate by cursor.

Base URL

https://ledga.io/api/v1

OpenAPI spec

Accounts

Chart of accounts and per-account balances.

GET /accounts List all accounts in a ledger POST /accounts Create a new account GET /accounts/{accountId} Get a specific account PUT /accounts/{accountId} Update an account DELETE /accounts/{accountId} Delete an account GET /accounts/{accountId}/balance-history Get account balance history POST /accounts/initialize-defaults Initialize default chart of accounts for a ledger GET /accounts/{accountId}/entries Get all entries for an account with rolling balance GET /accounts/code/{code} Get a specific account by its code GET /accounts/code/{code}/balance Get account balance by code with layer details GET /accounts/{accountId}/balance Get account balance with layer details GET /accounts/{accountId}/balance/point-in-time Get an account point-in-time balance for a single layer GET /accounts/code/{code}/balance/point-in-time Get an account point-in-time balance for a single layer, by code

Transactions

Balanced double-entry postings, reversals and voids.

GET /transactions List all transactions in a ledger POST /transactions Create a new transaction (direct entries or trancode invocation) GET /transactions/correlation List transactions sharing a correlation ID (chronological) GET /transactions/by-attribute Search transactions by a searchable business dimension (tenant-scoped, cross-ledger) POST /transactions/batch Create multiple transactions in a batch GET /transactions/{transactionId} Get a specific transaction POST /transactions/{transactionId}/reverse Reverse a posted transaction POST /transactions/{transactionId}/void Void a posted transaction

Transaction Codes

Reusable posting templates invoked by code.

GET /trancodes List transaction code templates POST /trancodes Create a transaction code template GET /trancodes/{id} Get a specific transaction code template PUT /trancodes/{id} Update a transaction code template (increments version) POST /trancodes/{id}/deprecate Mark a transaction code as deprecated (one-way state transition) POST /trancodes/{id}/validate-params Validate a parameter payload against a transaction code's params_schema

Journals

Optional sub-ledgers that group transactions.

GET /journals List all journals POST /journals Create a new journal GET /journals/{journalId} Get a specific journal PUT /journals/{journalId} Update a journal DELETE /journals/{journalId} Delete a journal GET /journals/{journalId}/statistics Get journal statistics

Account Sets

Named groups of accounts for aggregated balances.

GET /account-sets List all account sets POST /account-sets Create a new account set GET /account-sets/{accountSetId} Get a specific account set PUT /account-sets/{accountSetId} Update an account set DELETE /account-sets/{accountSetId} Delete an account set POST /account-sets/{accountSetId}/members Add an account or nested set to this account set DELETE /account-sets/{accountSetId}/members Remove an account or nested set from this account set GET /account-sets/{accountSetId}/balance Get aggregated balance for all accounts in this set GET /account-sets/{accountSetId}/accounts Get all accounts in this set (recursively includes nested sets)

Strings

Atomic transfers and conversions between member ledgers.

GET /strings List ledger strings for the tenant POST /strings Create a ledger string GET /strings/{code} Get a ledger string with its member ledgers GET /strings/{code}/accounts List accounts across all member ledgers of a string GET /strings/{code}/accounts/{accountCode}/balance Unified per-ledger balance for an account code across a string POST /strings/{stringCode}/transfer Post an atomic same-currency transfer between two member ledgers of a string POST /strings/{stringCode}/convert Post an atomic different-currency conversion between two member ledgers of a string

FX

Exchange rates and conversion.

GET /fx/rates List stored exchange rates for the tenant POST /fx/rates Store a manual exchange-rate override GET /fx/rates/{from}/{to} Get the current resolved rate for a pair GET /fx/rates/{from}/{to}/history List stored rate history for a pair GET /fx/convert Convert an amount between two currencies (calculator, posts nothing)

Reports

Trial balance and income statement.

GET /reports/trial-balance Get trial balance report GET /reports/income-statement Get income statement report

Attribute Catalog

Searchable business dimensions on transactions.

GET /attribute-definitions List the tenant's searchable attribute definitions (catalog) POST /attribute-definitions Declare a searchable attribute key PATCH /attribute-definitions/{key} Update an attribute definition's label / indexed flag GET /attribute-settings Read the tenant's attribute settings (strict mode) PUT /attribute-settings Toggle the tenant's attribute strict mode