Skip to main content
GET
List overdue items

Query Parameters

apiKey
string
required
dateFrom
string<date-time>

Inclusive UTC lower bound.

dateTo
string<date-time>

Inclusive UTC upper bound.

isConsumable
boolean

Omit for both, true for consumables only, false for tracked assets only.

categoryIds
string

Comma-separated category ids.

siteIds
string

Comma-separated site ids.

projectIds
string

Comma-separated project ids.

companyIds
string

Comma-separated contact ids: the company the holder belongs to.

personnelIds
string

Comma-separated APK ids of the personnel the items are checked out to.

assetStatus
integer<int32>

Asset status for assets, inventory status for consumables.

limit
integer<int32>
default:100

Rows to return.

Required range: 1 <= x <= 1000

Response

OK. An empty array when nothing is overdue.

id
integer<int32>

Checkout line id, unique across both assets and consumables.

apkId
integer<int32> | null
assetName
string | null
serialNumber
string | null

Serial number for an asset, part number for a consumable.

ezyid
string | null

Assets only.

customId
string | null

Assets only.

categoryId
integer<int32> | null
categoryName
string | null
siteId
integer<int32> | null
siteName
string | null
projectId
integer<int32> | null
projectName
string | null
checkoutDate
string<date-time> | null

UTC.

expectedReturnDate
string<date-time> | null

UTC. The date isOverdue is measured against.

returnedDate
string<date-time> | null

UTC. Only set once the line has been returned.

isOverdue
boolean

Past its expected return date. Also true when no return date was set.

contractorName
string | null

Who holds the item.

contractorApkId
integer<int32> | null
contractorMobileNumber
string | null
contractorEmail
string | null
contractorCompany
string | null
contactId
integer<int32> | null
assetStatus
integer<int32> | null

Asset status for an asset, inventory status for a consumable.

isConsumable
boolean
quantity
number<double> | null

Quantity taken. Consumables only; null for assets, which are always one each.

locationName
string | null

Shelf location. Assets only.