LEASESTAT: Lease Status
Lifecycle status values for lease agreements with colour-coded visual indicators.
Default definition. This article describes the default
LEASESTAT 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 LEASESTAT.Entity properties
| Property | Value |
|---|---|
| Entity code | LEASESTAT |
| Display name | Lease Status |
| Plural | Lease Statuses |
| Level | 40100 |
Use cases
LEASESTAT is a lookup entity referenced by LEASE (as status) to track the contractual lifecycle of lease agreements. Beyond name and description, it includes a colour field for visual status indicators (green for active, yellow for pending, red for expired, grey for terminated, blue for renewed). The data array provides seed values covering the full lifecycle: Active, Pending, Expired, Terminated, and Renewed.
Fields
Lease Status
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
description | text (multi-line) | Description | |
color | color | Status Color |
Relationships
- No declared relationships in the default definition.
Creating a Lease Status via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "LEASESTAT",
"level": 40100,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"description": "Example text."
}Listing Lease Statuses records
# All lease statuses in your tenant
GET /v1/entities/LEASESTAT/SUB