Skip to main content

FlatFieldDTO

An apartment (flat) custom field definition, returned by GET /v1/open-api/flat-field. Same shape as ContractFieldDTO, plus show/showPDF. Fields that are null are omitted from the response entirely.

idint64nullable

Field ID

Example: 12
namestringnullable

Field name

Example: Balkon turi
typeCustomFieldType

Custom field type, shared by every custom-field family (contract, flat, payment and lead task). Serialized by name. Identical value set to ContractFieldType, which remains as the contract-family alias.

Possible values: [TEXT, EXTENDED_TEXT, DATE, SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH, URL, TAG, LOCATION, COUNTER, ADDRESS, EMPLOYEE, FILE, NUMBER]

Example: SELECT
options object[]nullable

Available options — present for the option-based types (SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH).

  • Array [
    • idint64nullable

    Option ID

    Example: 7
    namestringnullable

    Option name

    Example: Ochiq
    descriptionstringnullable

    Option description

    Example: null
    colorstringnullable

    Display colour

    Example: #2E7D32
    sortOrderint32nullable

    Display position

    Example: 1
  • ]
    • requiredbooleannullable

    Whether the field is mandatory

    Example: false
    showbooleannullable

    Whether the field is shown in the UI. null means it is shown.

    Example: true
    showPDFbooleannullable

    Whether the field appears on the apartment's PDF presentation.

    Example: true
    descriptionstringnullable

    Field description

    Example: Balkon turi (ochiq/yopiq)
    iconstringnullable

    Icon key

    Example: balcony
    maxElementsint32nullable

    Maximum number of values for a multi-value field

    Example: 3
    numberFormatNumberFormat

    How a NUMBER-typed contract field's value is formatted. Serialized by name.

    Possible values: [NUMBER, PERCENT, CURRENCY]

    Example: NUMBER
    decimalPlacesint32nullable

    Decimal places for a NUMBER field

    Example: 2
    visualizationNumberVisualization

    How a NUMBER-typed contract field's value is displayed. Serialized by name.

    Possible values: [BAR, RING, NUMBER]

    Example: NUMBER
    maxValuedoublenullable

    Upper limit for a NUMBER field

    Example: 100000000
    ordersint32nullable

    Display position

    Example: 3
    FlatFieldDTO
    {
      "id": 12,
      "name": "Balkon turi",
      "type": "SELECT",
      "options": [
        {
          "id": 7,
          "name": "Ochiq",
          "description": null,
          "color": "#2E7D32",
          "sortOrder": 1
        }
      ],
      "required": false,
      "show": true,
      "showPDF": true,
      "description": "Balkon turi (ochiq/yopiq)",
      "icon": "balcony",
      "maxElements": 3,
      "numberFormat": "NUMBER",
      "decimalPlaces": 2,
      "visualization": "NUMBER",
      "maxValue": 100000000,
      "orders": 3
    }