Reporting

Get liability report

Returns outstanding liability as of a point in time, dimensioned by asset and program, optionally split by bucket. This report does not accept created_after or created_before.

get/v1/reports/liability

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/reports/liability
Auth: HTTP bearer

Query parameters

as_ofstring date-time

Report liability as of this point in time, inclusive, RFC 3339. Defaults to now.

program_idstring uuid

Filter to liability attributed to a specific program

asset_idstring uuid

Filter to a specific asset

by_bucketboolean

When true, split each asset and program row into AVAILABLE, HELD and DEFERRED rows.

Response

Liability report

as_ofstring

The point in time this report reflects (RFC 3339). Echoes the as_of parameter, or the server time used when as_of was omitted.

Example response

{
  "as_of": "2027-01-15T10:30:00Z",
  "data": [
    {
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "asset_name": "Loyalty Points",
      "asset_symbol": "POINTS",
      "balance": "625000.00",
      "bucket": "AVAILABLE",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "program_name": "Premium Rewards",
      "scale": 2
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

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