CreateMandateCategoryRequest

Request model for creating a category within a mandate.

  • type
    Type: string
    required
  • leasableUnits
    Type: object · AreaRange nullable

    Area as a min/max range. Values are in square meters.

    • 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.

  • locationClasses
    Type: array string[] | null
  • rentPerUnit
    Type: object · PriceRange nullable

    Price as a min/max range, with currency and scale.

    • 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.

  • vacancyRate
    Type: object · PercentRange nullable

    Percentage as a min/max range. Values are in percentage form (e.g., 5.2 = 5.2%).

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

      Maximum percentage (e.g., 8.0 = 8%). Omit for an open-ended lower-bounded range.

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

      Minimum percentage (e.g., 5.0 = 5%). Omit for an open-ended upper-bounded range.

  • yieldPercent
    Type: object · PercentRange nullable

    Percentage as a min/max range. Values are in percentage form (e.g., 5.2 = 5.2%).

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

      Maximum percentage (e.g., 8.0 = 8%). Omit for an open-ended lower-bounded range.

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

      Minimum percentage (e.g., 5.0 = 5%). Omit for an open-ended upper-bounded range.