Contents
Assets
Assets
The Assets endpoint manages fixed asset tracking — equipment, machinery, vehicles, and other tracked assets. Assets support full lifecycle operations from creation through receiving, field updates, and discontinuation.
The Asset Object
{
"rec": 42,
"shortId": "FORKLIFT-001",
"description": "Toyota 8FBE18 Electric Forklift",
"assetTag": "TAG-001",
"serial": "FLT-2025-A001",
"model": "8FBE18",
"manufacturer": "Toyota",
"location": "Bay-D",
"assetTypeId": 3,
"wId": 1,
"created": "2025-01-15T08:00:00Z",
"modified": "2025-05-10T14:30:00Z"
}Fields
| Field | Type | Description |
|---|---|---|
rec | integer | Unique asset record ID |
shortId | string | Unique asset identifier |
description | string | Asset description |
assetTag | string | Asset tag / barcode |
serial | string | Serial number |
model | string | Model number |
manufacturer | string | Manufacturer name |
location | string | Location within warehouse |
assetTypeId | integer | Asset type ID |
wId | integer | Warehouse ID |
created | datetime | Record creation date |
modified | datetime | Last modification date |
Note: The
GET /Asset/Alland single-asset (GET /Asset/{id}) responses include additional fields — for theAllendpoint this includesdiscontinued,underMaintenance,department,facePlate,installDate,purchaseDate,retireDate,installCost,replacementCost,warranty,warrantyDate,comment.
List Assets
GET /AssetReturns active (non-discontinued) assets with standard pagination parameters.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number (default 1) |
pageSize | integer | No | Results per page |
sort | string | No | Field to sort by |
direction | string | No | asc or desc |
Response
{
"value": [
{
"rec": 42,
"shortId": "FORKLIFT-001",
"description": "Toyota 8FBE18 Electric Forklift",
"assetTag": "TAG-001",
"serial": "FLT-2025-A001",
"model": "8FBE18",
"manufacturer": "Toyota",
"location": "Bay-D",
"assetTypeId": 3,
"wId": 1,
"created": "2025-01-15T08:00:00Z",
"modified": "2025-05-10T14:30:00Z"
},
{
"rec": 43,
"shortId": "COMPRESSOR-003",
"description": "Atlas Copco GA15 Air Compressor",
"assetTag": null,
"serial": "AC-GA15-2024-003",
"model": "GA15",
"manufacturer": "Atlas Copco",
"location": "Utility Room",
"assetTypeId": 5,
"wId": 2,
"created": "2024-08-22T00:00:00Z",
"modified": "2024-08-22T00:00:00Z"
}
],
"totalCount": 84,
"page": 1,
"pageSize": 25,
"pageCount": 4,
"hasMore": true
}List All Assets
GET /Asset/AllSame response shape as List Assets but includes discontinued records.
List Asset Types
GET /Asset/TypesReturns the available asset type classifications.
Response
{
"value": [
{ "id": 1, "description": "Vehicles", "active": true, "tangible": true, "modified": "2024-01-01T00:00:00" },
{ "id": 2, "description": "IT Equipment", "active": true, "tangible": true, "modified": "2024-01-01T00:00:00" },
{ "id": 3, "description": "Material Handling", "active": true, "tangible": true, "modified": "2024-01-01T00:00:00" }
],
"totalCount": 7,
"page": 1,
"pageSize": 25,
"pageCount": 1,
"hasMore": false
}Asset Type Fields
| Field | Type | Description |
|---|---|---|
id | integer | Asset type ID |
description | string | Display name |
active | boolean | Whether the type is active |
tangible | boolean | Whether the type is tangible |
modified | datetime | Last modified timestamp |
Get an Asset
GET /Asset/{id}Returns the full asset record by its asset ID (rec). Returns 404 if not found.
Response
Returns the asset object with the extended field set documented above.
Create or Update an Asset
POST /AssetUpsert — creates the asset if the identifier is new, updates if it already exists.
Request Body
{
"asset": "FORKLIFT-001",
"description": "Toyota 8FBE18 Electric Forklift",
"assetType": "Material Handling",
"serial": "FLT-2025-A001",
"model": "8FBE18",
"manufacturer": "Toyota",
"location": "Bay-D"
}Parameters
| Field | Type | Required | Description |
|---|---|---|---|
asset | string | Yes | Unique asset identifier |
description | string | Yes | Asset description |
assetType | string | No | Asset type name |
serial | string | No | Serial number |
supplier | string | No | Supplier reference |
model | string | No | Model number |
manufacturer | string | No | Manufacturer name |
location | string | No | Location within warehouse |
owner | string | No | Owner reference |
instDate | datetime | No | Install date |
instCost | decimal | No | Install cost |
Response
Returns the result of the upsert operation (the asset identifier).
Receive an Asset
POST /Asset/ReceiveReceives an asset by its temporary receiving record.
Request Body
{
"rec": 1024,
"complete": false
}Parameters
| Field | Type | Required | Description |
|---|---|---|---|
rec | integer | Yes | Temporary receiving record ID |
complete | boolean | No | Mark the receiving record complete (default false) |
Response
Returns the result of the receive operation.
Update Asset Fields
POST /Asset/UpdateUpdates specific mutable fields on an existing asset — faceplate data, ship/return dates, and warehouse.
Request Body
{
"assetTag": "FORKLIFT-001",
"facePlate": "FL-001",
"dateShipped": "2025-06-01",
"dateReturned": null,
"wid": 1
}Parameters
| Field | Type | Required | Description |
|---|---|---|---|
assetTag | string | Yes | Asset tag identifying the asset to update |
facePlate | string | No | Faceplate/label identifier |
dateShipped | string | No | Date asset was shipped |
dateReturned | string | No | Date asset was returned |
wid | integer | No | Warehouse ID |
Response
Returns the result of the update operation.
Discontinue an Asset
DELETE /Asset/{id}Marks the asset as discontinued (soft delete). The record is retained and visible via GET /Asset/All.
Response
"Asset Discontinued: FORKLIFT-001"Permissions
| Action | Required Permission |
|---|---|
| List / Get assets | All Assets (SecurityID 26) |
| Create / Update / Receive / Discontinue | Asset Catalog (SecurityID 161) |
On this page