Skip to main content

FlatTableDTO

A row of the apartment list returned by POST /v1/open-api/flat/filter — the apartment plus its building, house and currency in flattened form.

idint32

Apartment ID

Example: 1024
numberstringnullable

Apartment number

Example: 45
roomsstringnullable

Room count, stored as text

Example: 3
areadoublenullable

Total area, m²

Example: 78.4
livingAreadoublenullable

Living area, m²

Example: 52.1
floorint32nullable

Floor

Example: 7
entranceNumberint32nullable

Entrance (podyezd) number

Example: 2
entranceNamestringnullable

Entrance name

Example: 2-podyezd
statusCommerceStatus

Commercial status of an apartment.

  • SALE — on sale
  • BOOKED — booked
  • SOLD — sold
  • RESERVE — reserved
  • DELIVERED — keys handed over
  • REGISTERED — registered to the client

Possible values: [SALE, BOOKED, SOLD, RESERVE, DELIVERED, REGISTERED]

Example: SALE
repairedbooleannullable

Whether the apartment is repaired

Example: true
apartmentbooleannullable

Whether the unit is an apartment

Example: true
categoryFlatCategory

Apartment class.

Possible values: [ECONOMICAL, COMFORT, BUSINESS, PREMIUM]

Example: COMFORT
nonResidentialTypeNonResidentialType

Type of a non-residential unit.

  • BASEMENT — basement
  • SHOP — shop
  • PARKING — parking place
  • APARTMENT — apartment

Possible values: [BASEMENT, SHOP, PARKING, APARTMENT]

Example: SHOP
pricedoublenullable

Total price, in currencyCcy

Example: 780000000
pricePerAreadoublenullable

Price per m²

Example: 9948000
priceRepaireddoublenullable

Total price with repair

Example: 860000000
priceNotRepaireddoublenullable

Total price without repair

Example: 780000000
prepaymentdoublenullable

Required prepayment amount

Example: 234000000
delayint32nullable

Instalment length, months

Example: 24
terraceAreadoublenullable

Terrace area, m² (null when the apartment has no terrace)

Example: 6.2
buildingIdint32nullable

Building ID

Example: 34
buildingNamestringnullable

Building name

Example: A blok
houseIdint32nullable

House ID

Example: 144
houseNamestringnullable

House name

Example: Green Valley
currencyIdint32nullable

Currency ID of the house prices

Example: 1
currencyCcystringnullable

ISO code of the price currency

Example: UZS
createdTimestampint64nullable

Creation time (epoch seconds)

Example: 1672531200
deletedTimestampint64nullable

Always null — soft-deleted apartments are never returned by this endpoint.

Example: null
fields object[]nullable

Apartment custom field values. null when the caller didn't request them.

  • Array [
  • fieldIdint64

    Field ID — matches FlatFieldDTO.id

    Example: 12
    valuestringnullable

    The resolved value as text (option name, date, URL, …)

    Example: Ochiq
    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
    requiredbooleannullable

    Whether the field is mandatory

    Example: false
    sortOrderint32nullable

    Display position

    Example: 1
    numberdoublenullable

    Numeric value — NUMBER fields only

    Example: 1500000
    currencyIdint32nullable

    Currency of number — NUMBER fields only

    Example: 24
    valuesstring[]

    Ordered values of a multi-value field (MULTI_SELECT, EMPLOYEE, FILE). Empty for single-value types.

    Example: []
    latitudedoublenullable

    Latitude — LOCATION fields only

    Example: null
    longitudedoublenullable

    Longitude — LOCATION fields only

    Example: null
    files object[]

    Attached files — FILE fields only. Empty for every other type.

  • Array [
  • absolutePathstringnullable

    Presigned URL to the full-size file

    Example: https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600
    thumbAbsolutePathstringnullable

    Presigned URL to the thumbnail rendition

    Example: https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600
    smallestAbsolutePathstringnullable

    Presigned URL to the smallest rendition

    Example: https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600
  • ]
  • ]
  • FlatTableDTO
    {
    "id": 1024,
    "number": "45",
    "rooms": "3",
    "area": 78.4,
    "livingArea": 52.1,
    "floor": 7,
    "entranceNumber": 2,
    "entranceName": "2-podyezd",
    "status": "SALE",
    "repaired": true,
    "apartment": true,
    "category": "COMFORT",
    "nonResidentialType": "SHOP",
    "price": 780000000,
    "pricePerArea": 9948000,
    "priceRepaired": 860000000,
    "priceNotRepaired": 780000000,
    "prepayment": 234000000,
    "delay": 24,
    "terraceArea": 6.2,
    "buildingId": 34,
    "buildingName": "A blok",
    "houseId": 144,
    "houseName": "Green Valley",
    "currencyId": 1,
    "currencyCcy": "UZS",
    "createdTimestamp": 1672531200,
    "deletedTimestamp": null,
    "fields": [
    {
    "fieldId": 12,
    "value": "Ochiq",
    "name": "Balkon turi",
    "type": "SELECT",
    "required": false,
    "sortOrder": 1,
    "number": 1500000,
    "currencyId": 24,
    "values": [],
    "latitude": null,
    "longitude": null,
    "files": [
    {
    "absolutePath": "https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600",
    "thumbAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600",
    "smallestAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600"
    }
    ]
    }
    ]
    }