Ledga
GET /schedule-items

List prepayment-plan schedule items (open, overdue or complete)

One row per instalment: the net position of its chain of contra transactions, still expected (encumbered_open), in flight (pending_open) and settled (settled_applied). status is derived; open includes overdue. A cancelled instalment is not listed. Rows are projected asynchronously and can briefly lag a committed 202 posting; for a figure recomputed from the entries, use the point-in-time balance endpoint. Oldest due date first; a malformed cursor is a 422.

Parameters

NameInTypeDescription
account_id query string
uuid
Restrict to one pot / agreement account.
plan_id query string
max length: 128
Restrict to one plan (exact match on the plan_id attribute value).
schedule_item_id query string
max length: 128
Restrict to one instalment (exact match).
status query string
enum: open | overdue | complete
open (includes overdue), overdue (open and past due in the ledger timezone), or complete.
limit query integer
default: 25 · min: 1 · max: 100
Items per page, 1 to 100.
cursor query string The previous page's meta.pagination.next_cursor; omit it for the first page. A cursor not shaped like this list's is a 422.

Responses

200Successful operation
{
  "success": true,
  "meta": {
    "pagination": {
      "limit": 25,
      "has_more": true,
      "next_cursor": "eyJpZCI6IjAxOTk3YzFlLTRkMmEtN2MzZS05YTFiLTJmMGU4YzZkNGI1YSJ9",
      "previous_cursor": null
    }
  },
  "data": [
    {
      "id": "01997c1e-4d2a-7c3e-9a1b-2f0e8c6d4b5a",
      "schedule_item_id": "PLAN-000123-INS2",
      "plan_id": "PLAN-000123",
      "account_id": "01997c1e-4d2a-7c3e-9a1b-2f0e8c6d4b5a",
      "due_date": "2026-08-01",
      "status": "open",
      "is_overdue": true,
      "original_amount": "17.99",
      "original_amount_minor": "1799",
      "encumbered_open": "17.99",
      "encumbered_open_minor": "1799",
      "pending_open": "0.00",
      "pending_open_minor": "0",
      "settled_applied": "0.00",
      "settled_applied_minor": "0",
      "last_ledger_sequence": 42,
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ]
}
401Unauthenticated
{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}
403Forbidden (no ledger context)
{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}
422Validation error (bad status, over-long filter, malformed cursor, out-of-range limit)
{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}

Examples

curl https://ledga.io/api/v1/schedule-items \
  -H "Authorization: Bearer sk_xxxxxxxx_your_secret"

← All endpoints