COMP: Component
The COMP entity stores components. Catalogue entry defining a component's OEM specs, part number, pricing, and subcomponent/port templates.
Default definition. This article describes the default
COMP 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 COMP.Entity properties
| Property | Value |
|---|---|
| Entity code | COMP |
| Display name | Component |
| Plural | Components |
| Level | 100000 |
Use cases
COMP is the catalogue side of the catalogue-vs-inventory dual model. It defines WHAT a component IS rather than tracking a specific installed instance (that is COMPINV).
Fields
Basic Information
| Field | Type | Required | Notes |
|---|---|---|---|
ref | text | Ref. Read-only | |
name | text | Yes | Component Name |
description | text (multi-line) | Description | |
compStatus | enum | Status. Valid ids: Active (Active), Archived (Archived). | |
partNo | text | Part number | |
sku | text | SKU | |
price | number | Yes | Cost |
vendor | reference → VEN | Yes | OEM |
class | reference → COMPTYPE | Classification | |
spendtype | reference → SPEND | Yes | Spend type |
Details
| Field | Type | Required | Notes |
|---|---|---|---|
isAsset | boolean | Finance asset | |
indAsset | boolean | Individual stock | |
power | number | Power consumption (W) | |
rackHeight | number | Height (U) | |
performance | number | Performance (GFLOPS) | |
eosl | date | EOSL | |
breakpoints | text (multi-line) | Breakpoints |
Carbon & Sustainability
| Field | Type | Required | Notes |
|---|---|---|---|
embodiedCarbonKg | number | Total cradle-to-gate carbon per unit | |
weeeCategory | text | WEEE category. Example: e.g. Cat 3 - IT & telecom | |
recyclabilityPct | number | Percentage of component weight that is recyclable |
Dimensions
| Field | Type | Required | Notes |
|---|---|---|---|
dimHeight | number | Height (mm) | |
dimWidth | number | Width (mm) | |
dimDepth | number | Depth (mm) | |
weight | number | Weight (kg) |
Purchase Information
| Field | Type | Required | 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 | Required | Notes |
|---|---|---|---|
depreciationMethod | enum | Depreciation Method. Valid ids: 1 (Straight-line). | |
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 |
Relationships
- Lookups:
vendorpoints at aVENrecord;classpoints at aCOMPTYPErecord;spendtypepoints at aSPENDrecord;currencypoints at aCURRENCYrecord;vendorpoints at aVENrecord;purchaseOrderpoints at aPOrecord;costCenterpoints at aCOSTCTRrecord;budgetCodepoints at aBUDGCODErecord;glAccountpoints at aGLACCTrecord. - Related lists:
COMPINV(comp),SUBCOMP,COMPPORT.
Creating a Component via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "COMP",
"level": 100000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example value",
"price": 1,
"vendor": "",
"spendtype": ""
}
Listing Components
GET /v1/entities/COMP/SUB