Ledger Account Balances

List ledger account balances

Returns a paginated list of daily balance snapshots scoped to the authenticated tenant.

Balance rows are created and updated entirely by the ledger_entry_propagate_to_balances PostgreSQL trigger — never by application code directly.

Each row carries day/week/month/year cumulative totals and the last known control limits propagated from the risk engine via the triggering ledger_entry's *_limit_at_entry snapshot.

Supports Flop pagination and filtering:

  • page - Page number (1-indexed, default: 1)
  • page_size - Items per page (default: 20, max: 100)
  • order_by - Field to sort by (balance_date, inserted_at, updated_at)
  • order_directions - Sort direction (asc or desc)
  • filters - Flop filters (ledger_account_id, balance_date, iso_week, month, year)
get/api/ledger-account-balances

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/ledger-account-balances
  • Auth: none required

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Ledger account balance list

Example response

{
  "data": [
    {
      "balance_date": "2020-04-20",
      "daily_credit": 0,
      "daily_debit": 0,
      "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "inserted_at": "2020-04-20T16:20:00Z",
      "iso_week": 0,
      "last_daily_credit_limit": 0,
      "last_daily_debit_limit": 0,
      "last_monthly_credit_limit": 0,
      "last_monthly_debit_limit": 0,
      "last_weekly_credit_limit": 0,
      "last_weekly_debit_limit": 0,
      "last_yearly_credit_limit": 0,
      "last_yearly_debit_limit": 0,
      "ledger_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "month": 0,
      "monthly_credit": 0,
      "monthly_debit": 0,
      "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "updated_at": "2020-04-20T16:20:00Z",
      "weekly_credit": 0,
      "weekly_debit": 0,
      "year": 0,
      "yearly_credit": 0,
      "yearly_debit": 0
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.