CompUpdateRequest

A partial update of a deal's own fields: a field you omit keeps its value, a field you send as null is cleared. On a deal from a closed project the project's fields — price, yield, dates, the portfolio pair — are refused with 409; correct them with POST /api/v1/projects/{id}/close/correct. Send the deal's etag as If-Match to refuse a change on a stale version (412).

completedIsPlanned
Type: null | boolean

Whether the completion date is only planned
completedOn
Type: null | stringFormat: date

Completion date (omit to keep, null to clear)
isPortfolio
Type: null | boolean

Whether the deal is a portfolio
locationPrecision
Type: enumnullable

address, or area to show only the deal's area

values
addressarea
name
Type: null | string

The deal's name (omit to keep, null to clear)
price
Type: nullable

The price with currency and optional scale (omit to keep, null to clear)

Properties: 3
priceApproximate
Type: null | boolean

Whether the price is approximate
priceCertainty
Type: enumnullable

confirmed, reported or estimated (omit to keep, null to clear)

values
confirmedreportedestimated
priceUnknown
Type: null | boolean

Whether the price is known to be unknown
propertyCount
Type: null | integerFormat: int32

Number of properties in a portfolio (omit to keep, null to clear)
signedOn
Type: null | stringFormat: date

Signing date (omit to keep, null to clear)
streetAddress
Type: null | string

The deal's street address; also on a deal from a closed project.
yield
Type: null | numberFormat: decimal

Yield in percent (omit to keep, null to clear)
yieldApproximate
Type: null | boolean

Whether the yield is approximate
yieldCertainty
Type: enumnullable

confirmed, reported or estimated (omit to keep, null to clear)

values
confirmedreportedestimated

CompSummaryReasonPublicValue

Connection