service_contracts, which follows the response
structure rules.
contract_debits, contract_debit_diffs, and contract_ends have no /v1/ endpoint
yet — fetch them via the unversioned path in the meantime, see the full data
model.service_contracts
GET /v1/contracts/service_contracts — maintenance and service contracts.
string
required
Unique property identifier.
string
required
Identifies the service provider. References
Stakeholder.creditor — see the
Stakeholder field reference.string
Display name of the service provider.
null in most rows — join through creditor_id
for a reliable name instead.string
required
Contract identifier, a formatted string (e.g.
"2019/00015").string
Human-readable contract number.
string
Contract name.
string
Contract category.
string
Contract type.
object
Contract term —
{start, end} (date strings).string
Contract value. Decimal value serialized as a string (e.g.
"0.0000"), not a JSON
number — cast before doing arithmetic on it.string
Contract value normalised to an annual figure. Decimal value serialized as a string, same
as
contract_value.string
Reason code for the contract.
string
Free-text comment on the contract reasoning.