Sign in
Ledger Account Balances

Get ledger account balance by ID

Returns a single daily balance snapshot. The snapshot is trigger-maintained and carries day/week/month/year cumulative totals and the last known control limits from the risk engine.

get/api/ledger-account-balances/{id}

Request

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

Path parameters

idstring uuid required

Ledger account balance ID

Response

Ledger account balance

balance_datestring date

Calendar date for this snapshot

daily_creditinteger

Total credits on this calendar day (minor currency units). Trigger-maintained.

daily_debitinteger

Total debits on this calendar day (minor currency units). Trigger-maintained.

idstring uuid
inserted_atstring date-time
iso_weekinteger

ISO week number (1–53)

last_daily_credit_limitinteger nullable

Last known daily credit limit from risk engine. NULL = unconstrained.

last_daily_debit_limitinteger nullable

Last known daily debit limit from risk engine (minor currency units). NULL = unconstrained. Enforced by DB CHECK constraint. Trigger-maintained.

last_monthly_credit_limitinteger nullable

Last known monthly credit limit from risk engine. NULL = unconstrained.

last_monthly_debit_limitinteger nullable

Last known monthly debit limit from risk engine. NULL = unconstrained.

last_weekly_credit_limitinteger nullable

Last known weekly credit limit from risk engine. NULL = unconstrained.

last_weekly_debit_limitinteger nullable

Last known weekly debit limit from risk engine. NULL = unconstrained.

last_yearly_credit_limitinteger nullable

Last known yearly credit limit from risk engine. NULL = unconstrained.

last_yearly_debit_limitinteger nullable

Last known yearly debit limit from risk engine. NULL = unconstrained.

ledger_account_idstring uuid required
monthinteger

Calendar month (1–12)

monthly_creditinteger

Month-to-date cumulative credits (minor currency units). Trigger-maintained.

monthly_debitinteger

Month-to-date cumulative debits (minor currency units). Trigger-maintained.

tenant_idstring uuid
updated_atstring date-time
weekly_creditinteger

Week-to-date cumulative credits (minor currency units). Trigger-maintained.

weekly_debitinteger

Week-to-date cumulative debits (minor currency units). Trigger-maintained.

yearinteger

Calendar year

yearly_creditinteger

Year-to-date cumulative credits (minor currency units). Trigger-maintained.

yearly_debitinteger

Year-to-date cumulative debits (minor currency units). Trigger-maintained.

Example response

{
  "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
}

Changes

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