Skip to main content
The Contracts domain contains rental, debit, and service contract data for your properties. Use these endpoints to retrieve time-series debit positions, monthly deviations, service agreement details, and lease-end information.

​
contract_debits

GET /contracts/contract_debits — rental debit positions as a time series. Each record represents a scheduled debit with a validity interval.
​
integer
required
Unique property identifier.
​
integer
References the unit in Property.property_structure.
​
integer
Composite key identifying a specific tenant in a specific unit.
​
integer
Composite key identifying a specific tenant at property level.
​
string
Ledger account the debit posts to.
​
number
required
The debit amount for the validity interval.
​
string
Category of the debit, for example rent or ancillary charges.
​
number
Net rent portion of the debit.
​
number
Ancillary-cost portion of the debit.
​
date
required
Start of the validity interval.
​
date
End of the validity interval.
​
integer
Day of the month the debit is due.
​
string
Status of the debit record.
Use floor_area_id to join debit data to Property.property_structure, or floor_area_person_id/property_id_person_id to join to a specific tenancy in Stakeholder.tenants.

​
contract_debit_diffs

GET /contracts/contract_debit_diffs — monthly deviations between the debit target and the actual account movements. Use this to reconcile planned debits against realised cash flow.
​
integer
required
Unique property identifier.
​
integer
Composite key identifying the tenant this deviation applies to.
​
string
Tenant identifier.
​
string
Ledger account the deviation applies to.
​
date
required
Month the deviation applies to.
​
number
Net deviation amount for the period.
​
number
Tax portion of the deviation.
​
number
Gross deviation amount including tax.
​
string
Date from which a payment reminder applies to this deviation, if any.
​
string
Manually set reminder override, if any.

​
service_contracts

GET /contracts/service_contracts — maintenance and service contracts.
​
integer
required
Unique property identifier.
​
integer
required
Identifies the service provider. References Stakeholder.creditor.
​
string
Display name of the service provider.
​
integer
required
Contract identifier.
​
string
Human-readable contract number.
​
string
Contract name.
​
string
Contract category.
​
string
Contract type.
​
date
Contract start date.
​
date
Contract end date.
​
number
Contract value.
​
number
Contract value normalised to an annual figure.
​
string
Reason code for the contract.
​
string
Free-text comment on the contract reasoning.

​
contract_ends

GET /contracts/contract_ends — lease end dates and extension/option handling. Use this to track upcoming expiries, deadlines for exercising options, and the current exercise status.
​
integer
required
Unique property identifier.
​
integer
References the unit in Property.property_structure.
​
integer
Composite key identifying the tenancy this record applies to.
​
date
Start of the lease.
​
date
Contractual end of the lease.
​
date
Effective contract end date after applying any option logic.
​
date
New end date if the lease was extended.
​
date
Date the tenant was asked to decide on an extension option.
​
date
Deadline for the tenant’s response.
​
date
Date the tenant actually responded.
​
string
How the tenant responded (e.g. exercised, declined).
​
date
Deadline by which an extension option must be exercised.
​
boolean
Whether the option is exercised automatically if the tenant does not respond.
​
integer
Number of extension options already used.
​
integer
Number of extension options still available.
​
integer
Extension length in months. Note the field name reflects the underlying source system and contains a spelling irregularity (controct, not contract) — this is not a typo in this documentation.