PJMATERIAL: Project Material
The PJMATERIAL entity represents a construction or installation material used on a project. Records type, quantity, weight, and calculates embodied carbon (Scope 3) via the linked carbon factor.
Default definition. This article describes the default
PJMATERIAL 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 PJMATERIAL.Entity properties
| Property | Value |
|---|---|
| Entity code | PJMATERIAL |
| Display name | Project Material |
| Plural | Project Materials |
| Level | 72010 |
Use cases
Child entity of PJ via SUB|PJ comboKey. For non-component materials (pipe, concrete, aggregate, cabling) that are not tracked in the COMP catalogue. The carbon factor objectLookup links to CARBONFACTOR for the kgCO2e per unit rate. Deployed components from COMP/COMPINV are calculated separately via the drawdown chain.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Material description. |
carbonFactor | reference → CARBONFACTOR | Yes | Carbon factor. |
quantity | number | Yes | Quantity. |
unit | text | Unit. | |
weightKg | number | Used for recyclability percentage calculation. | |
recyclable | boolean | Recyclable material. | |
carbonFactorRate | relatedProperty | Factor rate (kgCO2e/unit). | |
kgCO2e | number | Quantity x carbon factor rate. Read-only. | |
scope | enum | Scope. Valid ids: 3 (Scope 3). | |
supplier | text | Supplier. | |
deliveryDate | date | Delivery date. |
Relationships
- Lookups:
carbonFactorpoints atCARBONFACTORrecord.
Creating a Project Material via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PJMATERIAL",
"level": 72010,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"carbonFactor": "",
"quantity": 100,
"unit": "Example text"
} Listing PJMATERIAL records
# All project materials in your tenant
GET /v1/entities/PJMATERIAL/SUB