ODIYR: ODI Annual Performance
Annual performance record against an ODI performance commitment. Records actual performance, target, variance, and financial impact for a given reporting year.
Default definition. This article describes the default
ODIYR 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 ODIYR.Entity properties
| Property | Value |
|---|---|
| Entity code | ODIYR |
| Display name | ODI Annual Performance |
| Plural | ODI Annual Performance |
| Level | 70010 |
Use cases
Child entity of ODI. One record per reporting year per ODI. comboKey format SUB|ODI links to parent.
Fields
Reporting Period
| Field | Type | Required | Notes |
|---|---|---|---|
reportingYear | enum | Yes | Reporting year Valid ids: 2025-26 (2025-26), 2026-27 (2026-27), 2027-28 (2027-28), 2028-29 (2028-29), 2029-30 (2029-30). |
status | enum | Yes | Status Valid ids: forecast (Forecast), provisional (Provisional), submitted (Submitted), confirmed (Confirmed). |
Performance
| Field | Type | Required | Notes |
|---|---|---|---|
target | number | Target (PCL) | |
actualPerformance | number | Actual performance | |
variance | number | Positive = outperformance, negative = underperformance | |
performanceRag | enum | RAG Valid ids: green (Green - on track), amber (Amber - at risk), red (Red - off track). |
Financial Impact
| Field | Type | Required | Notes |
|---|---|---|---|
financialImpact | number | Positive = outperformance payment, negative = underperformance penalty | |
impactType | enum | Impact type Valid ids: outperformance (Outperformance payment), underperformance (Underperformance penalty), deadband (Within deadband), none (No financial impact). |
Commentary
| Field | Type | Required | Notes |
|---|---|---|---|
commentary | text (multi-line) | Explanation of performance and any mitigating factors | |
mitigatingActions | text (multi-line) | Actions being taken to address underperformance |
Relationships
- No declared relationships in the default definition.
Creating a ODI Annual Performance via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "ODIYR",
"level": 70010,
"comboKey": "SUB:<your-sub-id>|ENT:",
"reportingYear": "2025-26",
"status": "forecast",
"target": 1,
"actualPerformance": 1
}Listing ODI Annual Performance records
# All odi annual performance in your tenant
GET /v1/entities/ODIYR/SUB