DemandFlow Support Centre

COMPINV: Asset

The COMPINV entity stores assets. Installed asset instance with serial number, location, financials, virtualization, and related subcomponents/ports.

Default definition. This article describes the default COMPINV definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches COMPINV.

Entity properties

Property	Value
Entity code	`COMPINV`
Display name	Asset
Plural	Assets
Level	100000

Use cases

COMPINV is the inventory side of the catalogue-vs-inventory dual model (catalogue: COMP, inventory: COMPINV). While COMP defines what a component IS, COMPINV tracks a specific INSTALLED instance with its own serial number, physical location, financial lifecycle, and operational state.

Fields

Basic Information

Field	Type	Required	Notes
`ref`	text		Ref. Read-only
`compId`	reference → `COMP`		Link to the component catalogue entry
`name`	text	Yes	Component Name
`description`	text (multi-line)		Description
`partNo`	text		Part number
`sku`	text		SKU
`serial`	text		Serial number
`price`	number		Cost. Read-only
`vendor`	reference → `VEN`		OEM
`class`	reference → `COMPTYPE`		Classification
`type`	enum		Type. Valid ids: `Hardware` (Hardware), `License` (License), `O&M` (O&M), `Professional Services` (Professional Services), `Software` (Software), `Solution` (Solution), `Service` (Service), `3rd Party` (3rd Party).
`assetType`	enum		Asset Type. Valid ids: `1` (Physical), `2` (Virtual Machine), `3` (Container), `4` (Cloud Instance).

Details

Field	Type	Notes
`stockRecordId`	reference → `INVSTOCK`	Links this asset to its site-level stock record
`bomId`	reference → `BOM`	The BOM this asset belongs to. Read-only
`perServerQty`	number	How many of this component per kit. Read-only
`isAsset`	boolean	Finance asset
`indAsset`	boolean	Individual stock
`power`	number	Power consumption (W)
`rackHeight`	number	Height (U)
`rack`	reference → `RACK`	Rack where this asset is mounted
`uPosition`	number	Start position from bottom of rack (U1 = bottom). Leave 0 for side-mounted equipment (e.g. 0U PDUs).
`mountPosition`	enum	Where this 0U equipment is mounted in the rack (side-mount PDUs, cable managers, etc.). Valid ids: `1` (Front Left), `2` (Front Right), `3` (Rear Left), `4` (Rear Right).
`physicalSockets`	number	Number of physical CPU sockets (for license counting)
`physicalCores`	number	Total physical CPU cores across all sockets
`hypCluster`	reference → `HYPCLUSTER`	Cluster this host is a member of
`maintenanceMode`	boolean	Host is in maintenance mode. VMs migrated off
`performance`	number	Performance (GFLOPS)
`eosl`	date	EOSL
`breakpoints`	text (multi-line)	Breakpoints

Dimensions

Field	Type	Notes
`dimHeight`	number	From catalogue entry (COMP). Read-only
`dimWidth`	number	From catalogue entry (COMP). Read-only
`dimDepth`	number	From catalogue entry (COMP). Read-only
`weight`	number	From catalogue entry (COMP). Read-only

Purchase Information

Field	Type	Notes
`purchaseDate`	date	Purchase Date
`inServiceDate`	date	In-Service Date
`price`	number	Purchase Cost
`currency`	reference → `CURRENCY`	Currency
`vendor`	reference → `VEN`	Vendor
`purchaseOrder`	reference → `PO`	Purchase Order
`invoiceNumber`	text	Invoice Number
`costCenter`	reference → `COSTCTR`	Cost Center
`budgetCode`	reference → `BUDGCODE`	Budget Code
`glAccount`	reference → `GLACCT`	GL Account

Depreciation Information

Field	Type	Notes
`depreciationMethod`	reference → `DEPMETHOD`	Depreciation Method
`usefulLifeMonths`	number	Useful Life (Months)
`depreciationStartDate`	date	Depreciation Start Date
`currentNetBookValue`	number	Current Net Book Value
`salvageValue`	number	Salvage Value
`accumulatedDepreciation`	number	Accumulated Depreciation
`lastDepreciationDate`	date	Last Depreciation Date
`lastDepreciationAmount`	number	Last Depreciation Amount
`depreciableValue`	number	Depreciable Value

Virtual Configuration

Field	Type	Notes
`hypervisor`	enum	Hypervisor. Valid ids: `1` (VMware vSphere), `2` (Microsoft Hyper-V), `3` (KVM), `4` (Xen), `5` (Oracle VM), `6` (Proxmox), `7` (Docker), `8` (Kubernetes), `9` (AWS EC2), `10` (Azure VM), `11` (Google Compute), `12` (Other).
`hostSystem`	reference → `COMPINV`	Physical host or parent VM
`vmId`	text	Hypervisor or cloud instance ID
`vmTemplate`	text	Template/Image
`vmState`	enum	VM State. Valid ids: `1` (Running), `2` (Stopped), `3` (Suspended), `4` (Migrating), `5` (Failed), `6` (Unknown).
`createdDate`	date	Creation Date
`lastBootTime`	date	Last Boot Time. Read-only

Resource Allocation

Field	Type	Notes
`vCpuCount`	number	vCPUs
`vCpuCoresPerSocket`	number	Cores per Socket
`vMemoryGB`	number	Memory (GB)
`vMemoryReservationGB`	number	Memory Reservation (GB)
`vStorageGB`	number	Total Storage (GB)
`vStorageUsedGB`	number	Used Storage (GB). Read-only
`storageType`	enum	Storage Type. Valid ids: `1` (Thin Provisioned), `2` (Thick Provisioned), `3` (SSD), `4` (HDD), `5` (NVMe).
`vmCluster`	reference → `HYPCLUSTER`	Cluster this VM belongs to
`vmResourcePool`	reference → `RESOURCEPOOL`	Resource pool governing this VM's CPU/memory allocation
`vmDatastore`	reference → `DATASTORE`	Primary datastore holding this VM's disk files
`networkPortGroup`	reference → `VPORTGROUP`	Primary virtual network this VM is connected to
`nwplatinst`	reference → `NWPLATINST`	Telecom platform instance this asset supports
`dplat`	reference → `DPLAT`	IT platform instance this asset supports

Audit Assessment

Field	Type	Notes
`auditStatus`	enum	Audit Status. Valid ids: `notAssessed` (Not Assessed), `inUse` (In Use), `underutilised` (Underutilised), `idle` (Idle), `candidateForRemoval` (Candidate for Removal), `decommissioned` (Decommissioned).
`auditDate`	date	Audit Date
`auditedBy`	reference → user	Audited By
`powerState`	enum	Power State. Valid ids: `on` (On), `off` (Off), `standby` (Standby), `unknown` (Unknown).
`businessOwner`	reference → user	Who owns or justifies this equipment
`businessFunction`	text	What service or application this equipment supports
`replacementCandidate`	reference → `COMPINV`	Newer equipment that could absorb this workload
`removalBlockers`	text (multi-line)	Why this equipment cannot be removed yet
`auditNotes`	text (multi-line)	Auditor observations

Operational Status

Field	Type	Notes
`isPowerDevice`	boolean	This is a power infrastructure device (PDU, UPS, etc.)
`isActive`	boolean	Equipment is powered on and in active use
`hasTraffic`	boolean	Network traffic is passing through this equipment
`cpuUtilisation`	number	Current CPU utilisation percentage

Port Utilisation

Field	Type	Required	Notes
`activePortCount`	number		Number of ports with link up
`totalPortCount`	number		Total physical ports on this equipment

Lifecycle

Field	Type	Required	Notes
`lifecycleStatus`	enum		Lifecycle Status. Valid ids: `active` (Active), `deprecated` (Deprecated), `eol` (End of Life), `eos` (End of Support).

ITAD Disposal

Field	Type	Notes
`itadStatus`	enum	ITAD Status. Valid ids: `none` (N/A), `flagged` (Flagged for Removal), `inWeeeProcess` (In WEEE Process), `disposedCertified` (Disposed & Certified).
`itadDate`	date	Date asset entered ITAD pipeline
`itadCertRef`	text	WEEE disposal certificate reference

Contract / Support

Field	Type	Notes
`supportContractEnd`	date	When maintenance or support expires
`supportVendor`	reference → `VEN`	Support Vendor
`supportContractRef`	text	Contract Reference

SNMP / Monitoring

Field	Type	Notes
`snmpLastPolled`	date	When monitoring data was last imported
`monitoringPeriod`	text	Period this data covers (e.g. March 2026)
`avgTrafficInMbps`	number	Avg Traffic In (Mbps)
`avgTrafficOutMbps`	number	Avg Traffic Out (Mbps)
`peakTrafficInMbps`	number	Peak Traffic In (Mbps)
`peakTrafficOutMbps`	number	Peak Traffic Out (Mbps)
`avgCpuPercent`	number	Avg CPU (%)
`avgMemoryPercent`	number	Avg Memory (%)
`activeVmCount`	number	Active VMs
`totalVmCount`	number	Total VMs
`uptimeDays`	number	From SNMP sysUpTime

Additional panels

Dashboard panel attached.

Relationships

Lookups: compId points at a COMP record; vendor points at a VEN record; class points at a COMPTYPE record; stockRecordId points at a INVSTOCK record; bomId points at a BOM record; rack points at a RACK record; hypCluster points at a HYPCLUSTER record; currency points at a CURRENCY record; vendor points at a VEN record; purchaseOrder points at a PO record; costCenter points at a COSTCTR record; budgetCode points at a BUDGCODE record; glAccount points at a GLACCT record; depreciationMethod points at a DEPMETHOD record; hostSystem points at a COMPINV record; vmCluster points at a HYPCLUSTER record; vmResourcePool points at a RESOURCEPOOL record; vmDatastore points at a DATASTORE record; networkPortGroup points at a VPORTGROUP record; nwplatinst points at a NWPLATINST record; dplat points at a DPLAT record; replacementCandidate points at a COMPINV record; supportVendor points at a VEN record.
Related lists: COMPINV (host), VMSNAPSHOT (SUB|COMPINV), SUBCOMPINV (SUB|COMPINV), COMPPORTINV (SUB|COMPINV), SOFTWAREINSTALL (objectRef), COMPMON (SUB|COMPINV), AUDITFINDING (asset).

Creating a Asset via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "COMPINV",
  "level":    100000,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name":        "Example value",
  "description": "Example value"
}

Listing Assets

GET /v1/entities/COMPINV/SUB

DemandFlow Support Centre

COMPINV: Asset

COMPINV: Asset

Entity properties

Use cases

Fields

Relationships

Creating a Asset via the API

Listing Assets

See also

Was this article helpful?