Money

Arrears cases, payment plans, deposits and the aging buckets

One page of each of the three lists, in primary key order. limit and offset move the window on all three at once, and totals says how many of each exist. aging is measured over every case still being chased, never over the page. Balances are recomputed on read, so they never lag the payments that cleared them.

get/api/v1/arrears

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/arrears
  • Auth: API key in cookie better-auth.session_token

Query parameters

limitinteger

How many rows to return from each of the three lists. 1–1000, default 50. The store caps a page at 200, and the limit in the response says what it actually gave.

offsetinteger

How many rows to skip in each list before counting limit. Default 0. Page with offset = offset + limit until it reaches that list’s entry in totals.

Response

Aging, cases, plans and deposits.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.