PropertyCategory

Property category with yield, rental income, and area data.

type
Type: string
required

Asset type with optional sub-type: "office", "retail/shopping_mall", "industrial/warehouse", etc.
conversions
Type: array string[] | null

Potential conversion categories: residential, office, retail, industrial, hotel, etc. Uses the same values as the category field.
locationClass
Type: null | string

Location class: "A", "B", "C" (micro-location quality rating).
rentalIncome
Type: object · Price nullable

Annual rental income.
- currency
  Type: string
  min length:
  3
  max length:
  3
  required
  
  ISO 4217 currency code (e.g., "SEK", "EUR", "USD").
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  min:
  0
  required
  
  Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.
- scale
  Type: string
  
  Scale factor for the value: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.
rentedArea
Type: object · Area nullable

Total rented floor area.
- unit
  Type: string
  required
  
  Area unit. Write requests must include "sqm"; read responses are normalized to "sqm".
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  required
  
  Area value.
vacantArea
Type: object · Area nullable

Total vacant floor area.
- unit
  Type: string
  required
  
  Area unit. Write requests must include "sqm"; read responses are normalized to "sqm".
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  required
  
  Area value.
yieldPercent
Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

Yield percentage.