Skip to main content
GET
/
v1
/
reports
/
liability-rollforward
Get liability rollforward
curl --request GET \
  --url https://api.scrip.dev/v1/reports/liability-rollforward \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "adjustments_net": "0.00",
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "asset_name": "Loyalty Points",
      "asset_symbol": "POINTS",
      "bucket_movements_net": "0.00",
      "closing_balance": "561400.00",
      "debited": "300.00",
      "expired": "2500.00",
      "forfeited": "2000.00",
      "holds_voided": "0.00",
      "issuance_returns": "500.00",
      "issued": "150000.00",
      "opening_balance": "500000.00",
      "program_id": "550e8400-e29b-41d4-a716-446655440001",
      "program_name": "Premium Rewards",
      "redeemed": "85000.00",
      "redemption_receipts": "0.00",
      "redemption_reversals": "1200.00",
      "reversal_clawbacks": "0.00",
      "scale": 2,
      "transfers_net": "0.00"
    }
  ],
  "from": "2026-01-01T00:00:00Z",
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  },
  "to": "2026-03-31T23:59:59Z"
}
Explains how liability changed between from and to. For each asset and program, the response shows the opening balance, every movement decomposed into named categories (issued, redeemed, forfeited, expired, transfers, and others), and the closing balance. The decomposition is exact: lines always sum to closing - opening, with no residual bucket. Activity the server cannot classify fails the request instead of misstating the report.
Pair with the liability report at from and to to reconcile a period. For usage patterns, see the Reporting guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

from
string<date-time>
required

Period start (inclusive, RFC3339)

to
string<date-time>
required

Period end (inclusive, RFC3339)

program_id
string<uuid>

Filter to rows attributed to a specific program

asset_id
string<uuid>

Filter to a specific asset

Response

Liability rollforward

Period liability rollforward results. Every line is attributed to journal action types; lines sum exactly to closing − opening per row (no plug line).

data
object[]

Rollforward rows, one per asset x program with ledger activity at or before to

from
string

Period start (inclusive, RFC 3339), echoed from the request

Example:

"2026-01-01T00:00:00Z"

pagination
object

Pagination metadata for list responses

to
string

Period end (inclusive, RFC 3339), echoed from the request

Example:

"2026-03-31T23:59:59Z"