BOM: BOM
A bill of materials defining the component structure and total cost of an assembled product or system.
Default definition. This article describes the default
BOM 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 BOM.Entity properties
| Property | Value |
|---|---|
| Entity code | BOM |
| Display name | BOM |
| Plural | Boms |
| Level | 250 |
Use cases
BOM defines the component composition of a product or system build. The Brief panel provides metadata (name, description, status, design authority, and a computed total cost), while the Components panel uses the custom bomeditor row type for managing the hierarchical component tree. The design authority field (singleuser) identifies who owns the technical specification. The total cost field is readonly and currency-formatted, calculated from the sum of component costs in the BOM editor.
Fields
Brief
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. | |
status | enum | Yes | Status. Valid ids: 1 (Active), 0 (Inactive). |
designauthority | reference → user | Design authority. | |
total | number | Read-only. Total cost. |
Relationships
- No declared relationships in the default definition.
Creating a BOM via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "BOM",
"level": 250,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Name",
"status": "1",
"description": "Description",
"total": 0
}Listing Boms records
GET /v1/entities/BOM/SUB