Reporting

Get expiration schedule

Returns when outstanding lot-mode liability expires, in calendar-aligned buckets by asset and program. LOT-mode assets only. This report does not accept created_after or created_before.

get/v1/reports/expiration-schedule

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/reports/expiration-schedule
Auth: HTTP bearer

Query parameters

period_startstring date-time required

Start of the reporting period, inclusive, RFC 3339.

period_endstring date-time required

End of the reporting period, inclusive, RFC 3339.

granularity'day' | 'week' | 'month'

Bucket granularity: day, week, or month (default month)

program_idstring uuid

Attribute lots to this program via their source journal entry and restrict to program-linked assets

asset_idstring uuid

Restrict to a single LOT inventory-mode asset

Response

Expiration schedule

Example response

{
  "data": [
    {
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "asset_name": "Points",
      "asset_symbol": "PTS",
      "attribution_adjustment": "0",
      "buckets": [
        {
          "amount": "865",
          "bucket_end": "2027-12-31T23:59:59Z",
          "bucket_start": "2027-01-15T10:30:00Z",
          "lot_count": 12
        }
      ],
      "expiring_after_window": "350",
      "expiring_before_window": "0",
      "gross_lot_outstanding": "1465",
      "never_expiring": "250",
      "overdraft_offset": "15",
      "total_outstanding": "1450"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

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