Skip to main content

FlatDTO

Full apartment object returned by GET /v1/open-api/flat/{id} — with the nested building, house, terrace, currency and address.

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
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
pricedoublenullable

Total price, in currency

Example: 780000000
pricePerAreadoublenullable

Price per m²

Example: 9948000
pricePerAreaRepaireddoublenullable

Price per m² with repair

Example: 10969000
priceRepaireddoublenullable

Total price with repair

Example: 860000000
priceNotRepaireddoublenullable

Total price without repair

Example: 780000000
floorint32nullable

Floor

Example: 7
building object

A building (block) of a house.

idint32

Building ID

Example: 34
namestringnullable

Building name

Example: A blok
isSalebooleannullable

Whether the building is on sale

Example: true
startDatestringnullable

Construction start date (dd.MM.yyyy)

Example: 05.01.2025
finishDatestringnullable

Construction finish date (dd.MM.yyyy)

Example: 01.12.2027
deletedTimestampint64nullable

Deletion time (epoch seconds, null if active)

Example: null
house object

House (project) as embedded in FlatDTO — without the buildings list.

idint32

House ID

Example: 12
namestringnullable

House name

Example: Green Valley
addressstringnullable

Street address of the house

Example: Chilonzor 9-kvartal
deletedTimestampint64nullable

Deletion time (epoch seconds, null if active)

Example: null
isSalebooleannullable

Whether the house is on sale

Example: true
buildingStartsstringnullable

Construction start date (dd.MM.yyyy)

Example: 05.01.2025
releasestringnullable

Planned hand-over date (dd.MM.yyyy)

Example: 01.12.2027
terrace objectnullable

The apartment's terrace, null when it has none.

idint32

Terrace ID

Example: 501
areadoublenullable

Terrace area, m²

Example: 6.2
pricePerAreadoublenullable

Terrace price per m²

Example: 4000000
pricePerAreaRepaireddoublenullable

Terrace price per m² with repair

Example: 4500000
currency objectnullable

Currency of the prices — the house's currency, null when the house has none.

idint32

Currency ID

Example: 1
valuedouble

Exchange rate (1 for the basic currency)

Example: 1
updateTimestampint64

Last update time (epoch seconds)

Example: 1672531200
basicboolean

Whether it's the company's basic currency

Example: true
ccystring

Currency code

Example: USD
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
address objectnullable

The house's address, null when the house has no district set.

indexint32nullable

Postal index

Example: 100096
zonestringnullable

Country zone / phone zone

Example: UZ
country_enstringnullable
Example: Uzbekistan
country_rustringnullable
Example: Узбекистан
country_uzstringnullable
Example: O'zbekiston
country_krstringnullable
Example: Ўзбекистон
country_trstringnullable
Example: Özbekistan
country_tjstringnullable
Example: Ӯзбекистон
country_kystringnullable
Example: Өзбекстан
region_enstringnullable
Example: Tashkent
region_rustringnullable
Example: Ташкент
region_uzstringnullable
Example: Toshkent
region_krstringnullable
Example: Тошкент
region_trstringnullable
Example: Taşkent
region_tjstringnullable
Example: Тошканд
region_kystringnullable
Example: Ташкент
city_enstringnullable
Example: Chilanzar
city_rustringnullable
Example: Чиланзар
city_uzstringnullable
Example: Chilonzor
city_krstringnullable
Example: Чилонзор
city_trstringnullable
Example: Çilanzar
city_tjstringnullable
Example: Чилонзор
city_kystringnullable
Example: Чиланзар
streetstringnullable

Street address of the house

Example: Chilonzor 9-kvartal
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
  • ]
  • ]
  • FlatDTO
    {
    "id": 1024,
    "number": "45",
    "rooms": "3",
    "area": 78.4,
    "status": "SALE",
    "repaired": true,
    "apartment": true,
    "price": 780000000,
    "pricePerArea": 9948000,
    "pricePerAreaRepaired": 10969000,
    "priceRepaired": 860000000,
    "priceNotRepaired": 780000000,
    "floor": 7,
    "building": {
    "id": 34,
    "name": "A blok",
    "isSale": true,
    "startDate": "05.01.2025",
    "finishDate": "01.12.2027",
    "deletedTimestamp": null
    },
    "house": {
    "id": 12,
    "name": "Green Valley",
    "address": "Chilonzor 9-kvartal",
    "deletedTimestamp": null,
    "isSale": true,
    "buildingStarts": "05.01.2025",
    "release": "01.12.2027"
    },
    "terrace": {
    "id": 501,
    "area": 6.2,
    "pricePerArea": 4000000,
    "pricePerAreaRepaired": 4500000
    },
    "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
    },
    "category": "COMFORT",
    "nonResidentialType": "SHOP",
    "address": {
    "index": 100096,
    "zone": "UZ",
    "country_en": "Uzbekistan",
    "country_ru": "Узбекистан",
    "country_uz": "O'zbekiston",
    "country_kr": "Ўзбекистон",
    "country_tr": "Özbekistan",
    "country_tj": "Ӯзбекистон",
    "country_ky": "Өзбекстан",
    "region_en": "Tashkent",
    "region_ru": "Ташкент",
    "region_uz": "Toshkent",
    "region_kr": "Тошкент",
    "region_tr": "Taşkent",
    "region_tj": "Тошканд",
    "region_ky": "Ташкент",
    "city_en": "Chilanzar",
    "city_ru": "Чиланзар",
    "city_uz": "Chilonzor",
    "city_kr": "Чилонзор",
    "city_tr": "Çilanzar",
    "city_tj": "Чилонзор",
    "city_ky": "Чиланзар",
    "street": "Chilonzor 9-kvartal"
    },
    "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"
    }
    ]
    }
    ]
    }