Skip to main content
GET
Get expiration schedule
Returns when outstanding value expires, aggregated from lots into calendar-aligned buckets by asset and program. Use it for breakage estimation and liability forecasting. Buckets plus the never_expiring, expiring_before_window, and expiring_after_window figures sum exactly to each asset’s total_outstanding. Applies to LOT-mode assets only; requesting a SIMPLE-mode asset returns a 400.
For the lot lifecycle, see Lots & Expiration. 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

Window start (inclusive, RFC3339)

to
string<date-time>
required

Window end (inclusive, RFC3339)

granularity
enum<string>
default:month

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

Available options:
day,
week,
month
program_id
string<uuid>

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

asset_id
string<uuid>

Restrict to a single LOT inventory-mode asset

Response

Expiration schedule

Expiration schedule results

data
object[]

Per-asset expiration schedules (LOT inventory-mode assets only)

pagination
object

Pagination metadata for list responses