CompPropertyHit

A property a deal may be anchored on: one of your organisation's own properties, or a property recorded for another deal of yours. Send its propertyId as property.propertyId when recording a deal or re-anchoring one.

  • dealCount
    Type: integer | stringFormat: int32
    required

    The deals of your organisation already anchored on it.

  • isPortfolio
    Type: boolean
    required

    Whether its latest deal is a portfolio.

  • name
    Type: string
    required

    The property's name

  • ownProperty
    Type: boolean
    required

    One of your own properties, readable on /api/v1/properties/{id}; otherwise a property recorded for a deal, read and changed through its deals only.

  • propertyId
    Type: string
    required

    The id to anchor a deal on

  • locality
    Type: null | string

    Locality (city or district)

  • propertyCount
    Type: null | integer | stringFormat: int32

    Number of properties in that portfolio

  • streetAddress
    Type: null | string

    The street address of the property's latest deal that shows its address.

Previous
CompPropertyFactsRequest
Next
CompPropertyPictureRequest
Propstreet Documentation