CreateMandateCategoryRequest

Mandate category entry (POST create + PATCH update). Categories are replace-all on PATCH — partial-by-id semantics are not supported because the category list is small and the contained ranges are independently optional.

  • type
    Type: string
    required

    Asset type token. Either a recognised top-level category (e.g. office) or slash-notation category/subtype where both halves are recognised and the subtype belongs to the declared base (e.g. retail/shopping_mall). Empty halves, unknown tokens, and mixed-base pairs return 400 with the accepted base-type list in the error message.

  • leasableUnits
    Type: object · AreaRange nullable

    Leasable units (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.

  • locationClasses
    Type: array string[] | null

    Allowed location classes for this category (A | B | C).

  • rentPerUnit
    Type: object · PriceRange nullable

    Target rent per unit (currency-bearing).

    • 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

    Acceptable vacancy rate range.

    • 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

    Target yield percentage range.

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