CONTRACTCE: Compensation Event
The CONTRACTCE entity stores compensation events. An NEC compensation event or JCT variation. Tracks notification, assessment deadline, quoted and agreed cost impact, and current status.
Default definition. This article describes the default
CONTRACTCE 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 CONTRACTCE.Entity properties
| Property | Value |
|---|---|
| Entity code | CONTRACTCE |
| Display name | Compensation Event |
| Plural | Compensation Events |
| Level | 71010 |
Use cases
Child entity of CONTRACT via SUB|CONTRACT comboKey. Assessment deadline is typically notification date + 8 weeks for NEC contracts.
Fields
Compensation Event Details
| Field | Type | Required | Notes |
|---|---|---|---|
ceRef | text | Yes | CE reference. Example: e.g. CE-001 |
status | enum | Yes | Status. Valid ids: notified (Notified), under_assessment (Under Assessment), quotation_submitted (Quotation Submitted), agreed (Agreed), rejected (Rejected), disputed (Disputed), pm_assessment (PM Assessment), withdrawn (Withdrawn). |
name | text (multi-line) | Yes | Description |
notifiedBy | enum | Notified by. Valid ids: pm (Project Manager), contractor (Contractor). | |
ceClause | enum | Which clause 60.1 sub-clause applies. Valid ids: 60.1(1) (60.1(1) - PM instruction), 60.1(2) (60.1(2) - Access restriction), 60.1(3) (60.1(3) - No reply), 60.1(4) (60.1(4) - Stop/change instruction), 60.1(5) (60.1(5) - Not in Works Info), 60.1(12) (60.1(12) - Physical conditions), 60.1(13) (60.1(13) - Weather), 60.1(19) (60.1(19) - Prevention event), other (Other). | |
assigned_to | reference → user | Owner |
Dates
| Field | Type | Required | Notes |
|---|---|---|---|
notificationDate | date | Notification date | |
assessmentDeadline | date | Notification date + 8 weeks (NEC) | |
quotationDate | date | Quotation submitted | |
agreedDate | date | Date agreed |
Cost Impact
| Field | Type | Required | Notes |
|---|---|---|---|
quotedCostImpact | number | Quoted cost impact | |
agreedCostImpact | number | Agreed cost impact | |
timeImpactWeeks | number | Extension of time requested or agreed |
Commentary
| Field | Type | Required | Notes |
|---|---|---|---|
commentary | text (multi-line) | Assessment commentary |
Documents
| Field | Type | Required | Notes |
|---|---|---|---|
attachments | file | Supporting Documents |
Relationships
- No declared relationships in the default definition.
Creating a Compensation Event via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "CONTRACTCE",
"level": 71010,
"comboKey": "SUB:<your-sub-id>|ENT:",
"ceRef": "Example value",
"status": "notified",
"name": "Example value"
}Listing Compensation Events
GET /v1/entities/CONTRACTCE/SUB