CONTRACTPAY: Payment Application
The CONTRACTPAY entity stores payment applications. A payment application or valuation under an NEC or JCT contract. Tracks applied and certified amounts, valuation date, final payment date, and payment status.
Default definition. This article describes the default
CONTRACTPAY 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 CONTRACTPAY.Entity properties
| Property | Value |
|---|---|
| Entity code | CONTRACTPAY |
| Display name | Payment Application |
| Plural | Payment Applications |
| Level | 71050 |
Use cases
Child entity of CONTRACT via SUB|CONTRACT comboKey. Under NEC clause 50/51 the PM assesses the amount due.
Fields
Application Details
| Field | Type | Required | Notes |
|---|---|---|---|
applicationNumber | number | Yes | Application number |
status | enum | Yes | Status. Valid ids: applied (Applied), certified (Certified), paid (Paid), late (Late), disputed (Disputed), final (Final Account). |
name | text | Description | |
valuationDate | date | Yes | Valuation date |
applicationDate | date | Application date |
Amounts
| Field | Type | Required | Notes |
|---|---|---|---|
amountApplied | number | Amount applied | |
amountCertified | number | Amount certified | |
retentionDeducted | number | Retention deducted | |
netAmountDue | number | Net amount due | |
cumulativeValue | number | Running total of all certified amounts to date |
Payment
| Field | Type | Required | Notes |
|---|---|---|---|
finalPaymentDate | date | Calculated from contract payment terms | |
paidDate | date | Paid date | |
payNoticeDate | date | Date pay notice or pay less notice was issued | |
payLessNotice | boolean | Pay less notice issued | |
payLessReason | text (multi-line) | Pay less notice reason |
Documents
| Field | Type | Required | Notes |
|---|---|---|---|
attachments | file | Payment Documents |
Relationships
- No declared relationships in the default definition.
Creating a Payment Application via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "CONTRACTPAY",
"level": 71050,
"comboKey": "SUB:<your-sub-id>|ENT:",
"applicationNumber": 1,
"status": "applied",
"valuationDate": "2025-01-15",
"name": "Example value"
}Listing Payment Applications
GET /v1/entities/CONTRACTPAY/SUB