Comp

The completion date is planned, not yet reached.

When the deal was recorded.

Through which surface the deal was recorded: the app, this API, an agent, or Propstreet itself.

The one date the deal is filed under: completion unless only planned, else signing, else the planned completion.

The deal's version; send it as If-Match on a write.

Hidden from the list for the whole organisation: always in the change feed, in a search only with includeHidden, never in the summary.

Unique deal identifier.

What kind of deal this is; only sale today.

address, or area when the deal shows only its area (its address is not public).

What the deal lacks to be complete; empty when nothing is missing.

The seller, buyer and advisors — companies or people in your network, or your own organisation.

The price is approximate ("around 180").

The price is known to be unknown, as opposed to not yet recorded.

Every source channel the deal counts under in the source filter.

Where your team learned about the deal. Your own project is not a source; it is project.

When the deal, its parties, sources, property or notes last changed.

The yield is approximate.

The property's primary type, the same vocabulary as the property endpoints' categories.

When the deal completed, or is planned to complete when completedIsPlanned is true.

Who recorded the deal, when known.

When the deal was deleted or voided; null while it holds.

When the deal was hidden.

The deal's name: its own, else the property's.

The agreed price in full currency units (scale is always none); null when unknown.

How sure your organisation is about the price.

Price divided by leasable area, in the price's currency per square metre; never for land, an unknown price or a missing area.

Your own project behind the deal, when it came from a closed project. A project the caller may not open comes back with accessible false and no id or name.

The one property the deal is about, with its facts as of the deal; null only for a closed project without a property.

Why the deal no longer holds; set only on deleted rows in the change feed.

When the deal was signed.

The deal's street address; null when nobody gave one (missing then names address). When locationPrecision is area the deal shows only its area.

The primary type with its sub-type, as the property endpoints spell it (for example industrial/warehouse).

Opaque Propstreet deep link (propstreet://comp/{id}); app metadata, not a website URL.

When the project behind the deal was corrected to no sale; the deal then counts as deleted.

The yield in percent (5.0 = 5%); never set for land.

How sure your organisation is about the yield.