LEASE: Lease Agreement
A lease agreement for tower or site space, tracking terms, fees, and contract documentation.
Default definition. This article describes the default
LEASE 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 LEASE.Entity properties
| Property | Value |
|---|---|
| Entity code | LEASE |
| Display name | Lease Agreement |
| Plural | Lease Agreements |
| Level | 40000 |
Use cases
LEASE is a transactional entity representing a contractual agreement for the use of tower or site infrastructure. Each lease links to a tower (TOWER entity) and a tenant company (COM entity), with status tracked via LEASESTAT lookup. The General panel captures identification (lease number), parties, and status.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
leaseNumber | text | Yes | Lease Number |
tower | reference → TOWER | Yes | Tower |
company | reference → COM | Yes | Company |
status | reference → LEASESTAT | Lease Status |
Lease Terms
| Field | Type | Required | Notes |
|---|---|---|---|
startDate | date | Yes | Start Date |
endDate | date | Yes | End Date |
renewalOption | boolean | Renewal Option | |
noticePeriod | number | Notice Period (days) |
Fees & Rates
| Field | Type | Required | Notes |
|---|---|---|---|
monthlyFee | number | Monthly Fee | |
annualEscalation | number | Annual Escalation Rate (%) |
Additional Terms
| Field | Type | Required | Notes |
|---|---|---|---|
specialTerms | text (multi-line) | Special Terms | |
contractFile | text (URL) | Contract File Path |
Relationships
- Lookups:
towerpoints at aTOWERrecord.companypoints at aCOMrecord.statuspoints at aLEASESTATrecord.
Creating a Lease Agreement via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "LEASE",
"level": 40000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"leaseNumber": "Example",
"tower": "",
"company": "",
"startDate": "2026-01-01"
} Listing Lease Agreements records
# All lease agreements in your tenant
GET /v1/entities/LEASE/SUB