Mandate

Investor mandate: investor-side acquisition criteria. Describes what an investor is looking to buy (price range, geographic area, asset types, tags).

  • createdUtc
    Type: stringFormat: date-time
    required

    Creation timestamp (UTC).

  • etag
    Type: string
    required

    ETag for concurrency control.

  • id
    Type: string
    required

    Mandate ID.

  • name
    Type: string
    required

    Mandate name.

  • updatedUtc
    Type: stringFormat: date-time
    required

    Last update timestamp (UTC).

  • categories
    Type: array object[] · MandateCategory[]

    Asset categories with category-specific criteria.

    Category within a mandate with category-specific criteria.

    • type
      Type: string
      required

      Asset type with optional sub-type: "office", "retail/shopping_mall", etc.

    • leasableUnits
      Type: object · AreaRange nullable

      Leasable units area range.

    • locationClasses
      Type: array string[] | null

      Location classes accepted for this category — an ordered subset of ["A", "B", "C"] (micro-location quality rating). Omitted when the mandate accepts any location class.

    • rentPerUnit
      Type: object · PriceRange nullable

      Rent per unit range.

    • vacancyRate
      Type: object · PercentRange nullable

      Acceptable vacancy rate range.

    • yieldPercent
      Type: object · PercentRange nullable

      Target yield range.

  • changeOrigin
    Type: null | string

    Origin channel that triggered this change.

  • changeType
    Type: null | string

    Type of change that produced this version: "create", "update", or "delete".

  • country
    Type: null | string

    ISO 3166-1 alpha-2 country code for the primary target country.

  • deletedUtc
    Type: null | stringFormat: date-time

    Deletion timestamp (UTC) if the resource has been deleted.

  • description
    Type: null | string

    Free-text investment strategy / thesis.

  • externalRefs
    Type: array object[] | null · ExternalRef[]

    External system references for CRM integration. Each namespace can only appear once.

    Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.

    • id
      Type: string
      max length:  
      255
      required

      External identifier within the namespace (e.g., "003XXXXXXXXXXXX" for Salesforce). Case-sensitive. Format depends on the external system.

    • namespace
      Type: string
      max length:  
      50
      required

      External system namespace (e.g., "salesforce", "hubspot", "pipedrive", "csv-import"). Case-insensitive.

  • geography

    GeoJSON Polygon/MultiPolygon representing the target acquisition area. Coordinates are [longitude, latitude] (WGS84).

  • investmentSize
    Type: object · PriceRange nullable

    Investment size range.

    • currency
      Type: string
      min length:  
      3
      max length:  
      3
      required

      ISO 4217 currency code (e.g., "EUR", "SEK", "USD").

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum price. Multiply by scale factor to get actual amount. Example: max=200 with scale="millions" = 200 million. Omit for an open-ended lower-bounded range.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum price. Multiply by scale factor to get actual amount. Example: min=100 with scale="millions" = 100 million. Omit for an open-ended upper-bounded range.

    • scale
      Type: string

      Scale factor for the values: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.

  • negativeTags
    Type: array string[] | null

    Negative tags (excluded attributes). Mutually exclusive with positiveTags per tag.

  • parcelArea
    Type: object · AreaRange nullable

    Parcel area range.

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum area (sqm). Omit for an open-ended lower-bounded range.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum area (sqm). Omit for an open-ended upper-bounded range.

  • positiveTags
    Type: array string[] | null

    Positive tags (required attributes). Mutually exclusive with negativeTags per tag.

  • resolvedLocation
    Type: object · MandateResolvedLocation nullable

    Location resolved from a named location on write (e.g., "Stockholm"). Write-response only — always null on GET.

    • name
      Type: string
      required

      Normalized resolved name, e.g., "Stockholm, Stockholm County, Sweden".

    • country
      Type: null | string

      ISO 3166-1 alpha-2 country code.

    • latitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double

      Centroid latitude.

    • longitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double

      Centroid longitude.

  • uri
    Type: null | string

    Opaque canonical Propstreet entity URI for deep linking.

  • yearBuilt
    Type: object · YearRange nullable

    Year built range (e.g., 1990-2010).

    • max
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Latest year in the range (e.g. 2005). Omit for an open-ended lower-bounded range.

    • min
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Earliest year in the range (e.g. 1990). Omit for an open-ended upper-bounded range.