Inventory Pro
Skip to main content

Contents

api

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

FieldTypeDescription
recintegerUnique asset record ID
shortIdstringUnique asset identifier
descriptionstringAsset description
assetTagstringAsset tag / barcode
serialstringSerial number
modelstringModel number
manufacturerstringManufacturer name
locationstringLocation within warehouse
assetTypeIdintegerAsset type ID
wIdintegerWarehouse ID
createddatetimeRecord creation date
modifieddatetimeLast modification date

Note: The GET /Asset/All and single-asset (GET /Asset/{id}) responses include additional fields — for the All endpoint this includes discontinued, underMaintenance, department, facePlate, installDate, purchaseDate, retireDate, installCost, replacementCost, warranty, warrantyDate, comment.

List Assets

GET /Asset

Returns active (non-discontinued) assets with standard pagination parameters.

Parameters

FieldTypeRequiredDescription
pageintegerNoPage number (default 1)
pageSizeintegerNoResults per page
sortstringNoField to sort by
directionstringNoasc 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/All

Same response shape as List Assets but includes discontinued records.

List Asset Types

GET /Asset/Types

Returns 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

FieldTypeDescription
idintegerAsset type ID
descriptionstringDisplay name
activebooleanWhether the type is active
tangiblebooleanWhether the type is tangible
modifieddatetimeLast 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 /Asset

Upsert — 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

FieldTypeRequiredDescription
assetstringYesUnique asset identifier
descriptionstringYesAsset description
assetTypestringNoAsset type name
serialstringNoSerial number
supplierstringNoSupplier reference
modelstringNoModel number
manufacturerstringNoManufacturer name
locationstringNoLocation within warehouse
ownerstringNoOwner reference
instDatedatetimeNoInstall date
instCostdecimalNoInstall cost

Response

Returns the result of the upsert operation (the asset identifier).

Receive an Asset

POST /Asset/Receive

Receives an asset by its temporary receiving record.

Request Body

{
  "rec": 1024,
  "complete": false
}

Parameters

FieldTypeRequiredDescription
recintegerYesTemporary receiving record ID
completebooleanNoMark the receiving record complete (default false)

Response

Returns the result of the receive operation.

Update Asset Fields

POST /Asset/Update

Updates 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

FieldTypeRequiredDescription
assetTagstringYesAsset tag identifying the asset to update
facePlatestringNoFaceplate/label identifier
dateShippedstringNoDate asset was shipped
dateReturnedstringNoDate asset was returned
widintegerNoWarehouse 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

ActionRequired Permission
List / Get assetsAll Assets (SecurityID 26)
Create / Update / Receive / DiscontinueAsset Catalog (SecurityID 161)