List open items

Returns a cursor-paginated list of open-item residual ledger entries for a reconciliation context — the carried, partially-filled, and aged obligations the context carries forward across match runs. These are structurally distinct from never-matched (UNMATCHED) transactions. Optionally narrowed by lifecycle status. The listing is readable regardless of context status.

GET /v1/matching/contexts/{contextId}/open-items

List open items

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/contexts/{contextId}/open-items \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "hasMore": true,
  "items": [
    {
      "ageDays": 12,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "currency": "USD",
      "expectedBalance": "1000.00",
      "firstSeenAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "identityKey": "invoice=INV-1001|currency=USD",
      "lastActivityAt": "2025-01-20T09:00:00Z",
      "runningBalance": "250.00",
      "status": "PARTIALLY_CLEARED",
      "updatedAt": "2025-01-20T09:00:00Z",
      "obligationDate": "2025-01-10T00:00:00Z",
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "transactionId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Parámetros de ruta

contextId · string<uuid> · requerido

Reconciliation context ID

Parámetros de consulta

status · enum<string>

Filter by open-item lifecycle status

Opciones disponibles: OPEN, PARTIALLY_CLEARED, CLEARED, AGED, WITHDRAWN

limit · integer<int64> · predeterminado: 20

Maximum number of records to return

Rango requerido: 1 <= x <= 200

cursor · string

Opaque pagination cursor

sort_by · enum<string>

Field to sort by. Defaults to id (stable insertion order). ageDays sorts by aging anchor (oldest residuals first when descending)

Opciones disponibles: ageDays, runningBalance, obligationDate

sort_order · enum<string>

Sort order

Opciones disponibles: asc, desc

Respuesta

200

application/json

OK

hasMore · boolean · requerido

Ejemplo:

true

items · object[] | null · requerido

Page of open items

Maximum array length: 200

Show child attributes

limit · integer<int64> · requerido

Rango requerido: 1 <= x <= 200

Ejemplo:

20

nextCursor · string

Ejemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Ejemplo:

"eyJpZCI6IjEyMiJ9"