CompPropertyRequest

The property a deal is about: one of your organisation's records by propertyId (your own property, or a property recorded for another deal — find either with POST /api/v1/comps/properties:search), or a new record for somebody else's building described by the other fields. Send one or the other.

buildingRights
Type: nullable

Building rights (gross floor area), for land.

Properties: 2
categories
Type: …20

The property types with their rented and vacant area; for land, send parcelArea instead of areas.

Properties: 3
contractLengthYears
Type: null | number | stringFormat: double

Weighted remaining lease term, in years.
country
Type: null | string

ISO 3166-1 alpha-2 country code.
isPortfolio
Type: boolean

The deal is a portfolio: one record whose facts are the portfolio's totals.
locality
Type: null | string

Locality (city or district)
location
Type: nullable

The map point (WGS84).

Properties: 2
name
Type: null | string
max length:
256

The property's name
parcelArea
Type: nullable

Land area

Properties: 2
propertyCount
Type: null | integer | stringFormat: int32

The number of properties in a portfolio, at least two.
propertyId
Type: null | string

An existing record of your organisation. The property's facts are then the record's own and the other fields are ignored, except isPortfolio and propertyCount, which say whether this deal is a portfolio.
rentalIncome
Type: nullable

Yearly rental income, with its currency.

Properties: 3
totalCosts
Type: nullable

Yearly operating costs, with their currency.

Properties: 3
yearBuilt
Type: null | integer | stringFormat: int32

Year built

CompPropertyPictureRequest

CompPropertySearchRequest