CompCreateRequest

A deal to record: the one property it is about, its numbers, its parties and its sources. Every rule is checked server-side and answered with 422: a signing or a completion date is needed, land takes no yield, a portfolio needs its number of properties, a party is a contact or company in your network, a source carries exactly the link its kind needs. When the deal looks like one your organisation already has, nothing is recorded and the candidates come back with 409; send it again with allowDuplicate to record it anyway.

property
Type:
required

The property the deal is about: one of your records by id, or a new record for somebody else's building.

Properties: 14
allowDuplicate
Type: boolean

Record the deal even when it looks like one your organisation already has.
completedIsPlanned
Type: boolean

The completion date is planned, not reached; the deal is then filed under its signing date.
completedOn
Type: null | stringFormat: date

Completion date (ISO 8601 date)
locationPrecision
Type: enumnullable

address (default), or area to show only the deal's area when its address is not public.

values
addressarea
name
Type: null | string

The deal's name; the property's name is shown when omitted.
parties
Type: …50

The deal's parties

Properties: 4
price
Type: nullable

The price with its currency; scale may be used ({ "value": 180, "currency": "SEK", "scale": "millions" }).

Properties: 3
priceApproximate
Type: boolean

Whether the price is approximate
priceCertainty
Type: enumnullable

How sure you are about the price; confirmed when omitted with a price.

values
confirmedreportedestimated
priceUnknown
Type: boolean

The price is known to be unknown; send no price then.
signedOn
Type: null | stringFormat: date

Signing date (ISO 8601 date)
sources
Type: …50

Where your team learned about the deal

Properties: 10
streetAddress
Type: null | string
max length:
256

The deal's street address; the deal lacks its address when omitted.
yield
Type: null | number | stringFormat: double

The yield in percent (5.0 = 5%); never for land.
yieldApproximate
Type: boolean

Whether the yield is approximate
yieldCertainty
Type: enumnullable

confirmed, reported or estimated

values
confirmedreportedestimated

CompCertaintyPublicValue

CompDuplicateCandidate