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

{
  "shortID": "FORKLIFT-001",
  "description": "Toyota 8FBE18 Electric Forklift",
  "assetType": 3,
  "assetTypeName": "Material Handling",
  "serial": "FLT-2025-A001",
  "warehouse": 1,
  "warehouseName": "Main",
  "location": "Bay-D",
  "status": "Active",
  "created": "2025-01-15T08:00:00Z",
  "modified": "2025-05-10T14:30:00Z",
  "discontinued": null
}

Fields

Field	Type	Description
`shortID`	string	Unique asset identifier
`description`	string	Asset description
`assetType`	integer	Asset type ID
`assetTypeName`	string	Asset type display name
`serial`	string	Serial number
`warehouse`	integer	Warehouse ID
`warehouseName`	string	Warehouse name
`location`	string	Location within warehouse
`status`	string	`Active` or `Discontinued`
`created`	datetime	Record creation date
`modified`	datetime	Last modification date
`discontinued`	datetime\|null	Date discontinued; `null` if active

List Assets

GET /Asset

Returns 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": [
    {
      "shortID": "FORKLIFT-001",
      "description": "Toyota 8FBE18 Electric Forklift",
      "assetType": 3,
      "assetTypeName": "Material Handling",
      "serial": "FLT-2025-A001",
      "warehouse": 1,
      "warehouseName": "Main",
      "location": "Bay-D",
      "status": "Active",
      "created": "2025-01-15T08:00:00Z",
      "modified": "2025-05-10T14:30:00Z",
      "discontinued": null
    },
    {
      "shortID": "COMPRESSOR-003",
      "description": "Atlas Copco GA15 Air Compressor",
      "assetType": 5,
      "assetTypeName": "Equipment",
      "serial": "AC-GA15-2024-003",
      "warehouse": 2,
      "warehouseName": "North",
      "location": "Utility Room",
      "status": "Active",
      "created": "2024-08-22T00:00:00Z",
      "modified": "2024-08-22T00:00:00Z",
      "discontinued": null
    }
  ],
  "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": [
    { "assetType": 1, "typeName": "Vehicles" },
    { "assetType": 2, "typeName": "IT Equipment" },
    { "assetType": 3, "typeName": "Material Handling" },
    { "assetType": 5, "typeName": "Equipment" }
  ],
  "totalCount": 7,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

Asset Type Fields

Field	Type	Description
`assetType`	integer	Asset type ID
`typeName`	string	Display name

Get an Asset

GET /Asset/{shortID}

Returns the full asset record by its ShortID.

Response

Returns the full asset object.

Create or Update an Asset

POST /Asset

Upsert — creates the asset if shortID is new, updates if it already exists.

Request Body

{
  "shortID": "FORKLIFT-001",
  "description": "Toyota 8FBE18 Electric Forklift",
  "assetType": 3,
  "serial": "FLT-2025-A001",
  "warehouse": 1,
  "location": "Bay-D"
}

Parameters

Field	Type	Required	Description
`shortID`	string	Yes	Unique asset identifier
`description`	string	Yes	Asset description
`assetType`	integer	Yes	Asset type ID
`serial`	string	No	Serial number
`warehouse`	integer	No	Warehouse ID
`location`	string	No	Location within warehouse

Response

Returns the full asset object after create or update.

Receive an Asset

POST /Asset/Receive

Receives an asset from a purchase order by processing its temporary receiving record.

Request Body

{
  "poNumber": "PO-2025-0039",
  "shortID": "FORKLIFT-002"
}

Parameters

Field	Type	Required	Description
`poNumber`	string	Yes	Source PO number
`shortID`	string	Yes	Asset ShortID to receive

Response

Returns the full asset object after receiving.

Update Asset Fields

POST /Asset/Update

Updates specific mutable fields on an existing asset — faceplate data, ship/return dates, and other properties.

Request Body

{
  "shortID": "FORKLIFT-001",
  "faceplate": "FL-001",
  "shipDate": "2025-06-01T00:00:00Z",
  "returnDate": null
}

Parameters

Field	Type	Required	Description
`shortID`	string	Yes	Asset to update
`faceplate`	string	No	Faceplate/label identifier
`shipDate`	datetime	No	Date asset was shipped
`returnDate`	datetime	No	Date asset was returned

Response

Returns the full asset object after update.

Discontinue an Asset

DELETE /Asset/{shortID}

Marks the asset as discontinued (soft delete). The record is retained and visible via GET /Asset/All.

Response

{
  "shortID": "FORKLIFT-001",
  "status": "Discontinued",
  "discontinued": "2025-05-31T14:30:00Z"
}

Permissions

Action	Required Permission
List / Get assets	All Assets (SecurityID 26)
Create / Update / Receive / Discontinue	Asset Catalog (SecurityID 161)