Item Ledger Snapshot

The item ledger snapshot resource.

Base/itemLedgerSnapshot

GET/itemLedgerSnapshot

List item ledger snapshots

Retrieve a paginated list of item ledger snapshots. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/itemLedgerSnapshot

curl --request GET \
  --url '<your-host>/itemLedgerSnapshot?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "itemId": "xyz789",
    "companyId": "xyz789",
    "locationId": "xyz789",
    "quantity": 10,
    "consumed30": 0,
    "consumed90": 0,
    "storageUnitIds": [],
    "snapshotCutoff": "2026-01-01T00:00:00Z"
  }
]

GET/itemLedgerSnapshot

Retrieve a item ledger snapshot

Fetch a single item ledger snapshot by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item ledger snapshot's `itemId`, e.g. `eq.{id}`.

GET/itemLedgerSnapshot

curl --request GET \
  --url '<your-host>/itemLedgerSnapshot?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "quantity": 10,
  "consumed30": 0,
  "consumed90": 0,
  "storageUnitIds": [],
  "snapshotCutoff": "2026-01-01T00:00:00Z"
}