# Описание формата импорта данных
сгенерировано: 14.07.2025 12:52
Данные должны располагаться в сети интернет, иметь постоянный url и представлять собой текстовый документ в кодировке utf-8 содержащий JSON object [ImportModel](#importmodel).
Ниже представлены все типы данных с описаниями.
# Типы данных
## datetime
Это строка вида `"2022-02-16T13:06:17.1166667Z"`
## guid
Это строка вида `"ffffffff-ffff-ffff-ffff-ffffffffffff"`
## number
Это числовое значение с плавающей точкой. Пример: `123` или `123.12`
## integer
Это целое числовое значение. Пример: `234`
## ImportModel
### тип: Объект
> Модель содержит 3 коллекции данных:
> `Недвижимость`, `Помещения` и `Предложения по помещениям`.
### Свойства
|название|тип|опционально|ограничения|описание|
|-|-|-|-|-|
|**realties**|[RealtyModel[]](#realtymodel)|✅||Недвижимость|
|**objects**|[RealtyObjectModel[]](#realtyobjectmodel)|✅||Помещения|
|**offers**|[OfferModel[]](#offermodel)|✅||Предложения по помещениям|
### Пример данных:
```json
{
"realties": [ ... ],
"objects": [ ... ],
"offers": [ ... ]
}
```
## RealtyModel
### тип: Объект
> Недвижимость это чаще всего строение с конкретным адресом, выраженном в географической координате.
### Свойства
|название|тип|опционально|ограничения|описание|
|-|-|-|-|-|
|**internalId**|string|❌||Идентификатор недвижимости|
|**lat**|[number](#number)|❌|>= -90, <= 90|Широта в градусах|
|**lng**|[number](#number)|❌|>= -180, <= 180|Долгота в градусах|
|**status**|[entityStates](#entitystates)|❌|разрешённые значения:
**"actual"**, **"archived"**
|Статус недвижимости| |**name**|string|✅||Название| |**photos**|[ModelPhotos](#modelphotos)|✅||Изображения недвижимости| ### Пример данных: ```json { "internalId": "abcdef...", "lat": -3.4240809015110512, "lng": -1.5249777690158122, "status": "archived", "name": "abcdef...", "photos": { } } ``` ## ModelPhotos ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**main**|string|✅||Главная фотография| |**layouts**|string[]|✅||Планировки| |**photos**|string[]|✅||Дополнительные фотографии| ### Пример данных: ```json { "main": "abcdef...", "layouts": null, "photos": null } ``` ## RealtyObjectModel ### тип: Объект > Помещение находится в конкретной недвижимости и имеет одно или более предложений и набор характеристик. ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**internalId**|string|❌||Идентификатор помещения| |**realtyInternalId**|string|❌||Идентификатор недвижимости| |**status**|[realtyObjectStatuses](#realtyobjectstatuses)|❌|разрешённые значения:
**"actual"**, **"archived"**
|Статус помещения| |**photos**|[ModelPhotos](#modelphotos)|✅||Изображения помещения| |**info**|[ObjectInfo](#objectinfo)|❌||Общая информация| |**office**|[ObjectOfficeDetails](#objectofficedetails)|✅||Детали офисного помещения| |**warehouse**|[ObjectWarehouseDetails](#objectwarehousedetails)|✅||Детали складского помещения| |**retail**|[ObjectRetailDetails](#objectretaildetails)|✅||Детали retail помещения| |**apartment**|[ObjectApartmentDetails](#objectapartmentdetails)|✅||Детали апартаментов| |**lessee**|[ObjectLesseeInfo](#objectlesseeinfo)|✅||Информация об арендаторе (для готового бизнеса)| ### Пример данных: ```json { "internalId": "abcdef...", "realtyInternalId": "abcdef...", "status": "actual", "photos": { }, "info": { },
"office": { },
"warehouse": { },
"retail": { },
"apartment": { },
"lessee": { }
}
```
## ObjectInfo
### тип: Объект
### Свойства
|название|тип|опционально|ограничения|описание|
|-|-|-|-|-|
|**features**|[realtyObjectInfoFeatures](#realtyobjectinfofeatures)|❌||Особенности|
|**squareTotal**|[number](#number)|❌|> 0|Вся площадь|
|**squareOffer**|[number](#number)|❌|> 0|Площадь доступная для предложения|
|**squareMin**|[number](#number)|✅||Деление от|
|**floor**|[integer](#integer)|✅||Этаж|
|**floorsCount**|[integer](#integer)|✅|>= 1|Количество этажей помещения|
|**roomsCount**|[integer](#integer)|✅||Количество кабинетов/комнат|
|**floorsHeight**|[number](#number)|✅|> 0|Высота потолков|
|**floorsHeightWork**|[number](#number)|✅|> 0|Рабочая высота потолков|
|**roomNumber**|string|✅||Номер площади(номер офиса/кабинета, номер объекта)|
|**state**|[realtyObjectStates](#realtyobjectstates)|❌||Состояние|
|**spaceLayout**|[spaceLayouts](#spacelayouts)|❌||Планировка|
|**purposes**|[realtyPurposes](#realtypurposes)|❌|**запрещенные** значения:
**"none"**
|Возможные назначения| |**currentPurpose**|[realtyPurposes](#realtypurposes)|❌|строго одно значение|Текущее назначение| |**roomDepth**|[number](#number)|✅|> 0|Глубина помещения| |**waterPoint**|[waterPoints](#waterpoints)|❌||Санузел/мокроя точка| |**waterPointCount**|[integer](#integer)|✅|>= 0|Количество санузлов| |**parking**|[realtyParkings](#realtyparkings)|❌||| |**parkingCarPlaces**|[integer](#integer)|✅|>= 0|Количество машиномест на парковке| |**parkingNote**|string|✅||Дополнительная информация о парковке| |**power**|[number](#number)|✅|>= 0|Электричество, кВт| |**note**|string|✅||Заметка| ### Пример данных: ```json { "features": "wholeFloor, basement", "squareTotal": 49.61, "squareOffer": 151.95, "squareMin": 26.34, "floor": 38, "floorsCount": 58, "roomsCount": -12, "floorsHeight": 87.56, "floorsHeightWork": 31.41, "roomNumber": "abcdef...", "state": "clean", "spaceLayout": "open", "purposes": "office, workSpace, psn, restaurant, canteen, retail, showRoom, gasStation, medicalService, hotel, openGround, apartments, groundArea", "currentPurpose": "beautySalon", "roomDepth": 18.93, "waterPoint": "onFloor", "waterPointCount": 128, "parking": "freeOpen, freeClosedWarm, freeClosedCold, paidOpen, paidClosedCold, outsideTerritory, underground", "parkingCarPlaces": 52, "parkingNote": "abcdef...", "power": 108.86, "note": "abcdef..." } ``` ## ObjectOfficeDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**features**|[officeFeatures](#officefeatures)|❌||Особенности офиса| |**note**|string|✅||Заметка| ### Пример данных: ```json { "features": "serverRoom", "note": "abcdef..." } ``` ## ObjectWarehouseDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**floorMaterial**|[warehouseFloors](#warehousefloors)|❌||Тип пола| |**features**|[warehouseFeatures](#warehousefeatures)|❌||Особенности складского помещения| |**heating**|[realtyObjectHeatings](#realtyobjectheatings)|❌||Отопление| |**freezeEquipment**|[warehouseFreezeEquipments](#warehousefreezeequipments)|❌||Морозильное оборудование| |**unloadingFeatures**|[warehouseUnloadingFeatures](#warehouseunloadingfeatures)|❌||Особенности разгрузки| |**unloadingEquipment**|[warehouseUnloadingEquipments](#warehouseunloadingequipments)|❌||Оснащение| |**gatesCount**|[integer](#integer)|✅|>= 0|Количество ворот| |**gatesNote**|string|✅||Описание ворот (тип или комментарий)| |**palletPlaces**|[integer](#integer)|✅|>= 0|Колличество паллетомест| |**columnStepA**|[number](#number)|✅|> 0|Шаг колонн А (А х Б)| |**columnStepB**|[number](#number)|✅|> 0|Шаг колонн Б (А х Б)| |**floorLoadMax**|[number](#number)|✅|> 0|Максимальная нагрузка на пол (кг на кв. м)| |**note**|string|✅||Заметка| ### Пример данных: ```json { "floorMaterial": "asphalt", "features": "floorAntiDust, trustKeeping, handlingService, food", "heating": "none", "freezeEquipment": "freeze", "unloadingFeatures": "pandus, railroad, railroadPandus", "unloadingEquipment": "none", "gatesCount": 28, "gatesNote": "abcdef...", "palletPlaces": 131, "columnStepA": 20.36, "columnStepB": 73.93, "floorLoadMax": 126.22, "note": "abcdef..." } ``` ## ObjectRetailDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**note**|string|✅||Заметка| ### Пример данных: ```json { "note": "abcdef..." } ``` ## ObjectApartmentDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**kitchensCount**|[integer](#integer)|✅|>= 0|Всего кухонь| |**bedroomsCount**|[integer](#integer)|✅|>= 0|Всего спален| |**bathroomsCount**|[integer](#integer)|✅|>= 0|Всего ванных комнат| |**dressingRoomsCount**|[integer](#integer)|✅|>= 0|Всего гардеробных| |**hasPlaceForOffice**|boolean|✅||Есть комната под отдельный кабинет| |**kitchenSquare**|[number](#number)|✅|>= 0|Площадь кухни (если не одна, то общая площадь всех)| |**notLivingSquare**|[number](#number)|✅|>= 0|Нежилая площадь| |**note**|string|✅||Заметка| ### Пример данных: ```json { "kitchensCount": 138, "bedroomsCount": 34, "bathroomsCount": 29, "dressingRoomsCount": 79, "hasPlaceForOffice": false, "kitchenSquare": 83.01, "notLivingSquare": 1.63, "note": "abcdef..." } ``` ## ObjectLesseeInfo ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**occupied**|boolean|✅||Наличие арендатора в данное время| |**longDuration**|boolean|✅||Долгосрочная аренда| |**occupiedAt**|[datetime](#datetime)|✅||Дата въезда арендатора| |**releaseAt**|[datetime](#datetime)|✅||Примерная дата освобождения| |**companyName**|string|✅||Название арендатора| |**companyDescription**|string|✅||Род деятельности арендатора| |**note**|string|✅||Описание арендного бизнеса| |**incomeInMonth**|[number](#number)|✅|>= 0|Прибыль в месяц| ### Пример данных: ```json { "occupied": false, "longDuration": false, "occupiedAt": "2024-07-21T09:52:58.0935865Z", "releaseAt": "2025-06-08T09:52:58.0935865Z", "companyName": "abcdef...", "companyDescription": "abcdef...", "note": "abcdef...", "incomeInMonth": 20.71 } ``` ## OfferModel ### тип: Объект > Предложение - это коммерческие условия по продаже или аренде для потенциального клиента и агентские условия для посредника. > У помещения одновременно может быть много предложений. ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**objectInternalId**|string|❌||Идентификатор помещения| |**operation**|[realtyOperations](#realtyoperations)|❌|**запрещенные** значения:
**"none"**
, строго одно значение|Операция| |**market**|[realtyMarkets](#realtymarkets)|❌|**запрещенные** значения:
**"none"**
, строго одно значение|Категория предложения| |**status**|[realtyOfferStatuses](#realtyofferstatuses)|❌|разрешённые значения:
**"active"**, **"off"**
|Статус предложения| |**forCustomer**|[CustomerCondition](#customercondition)|❌||Условия для клиента| |**forAgent**|[AgentCondition](#agentcondition)|✅||Условия для агента| ### Пример данных: ```json { "objectInternalId": "abcdef...", "operation": "rent", "market": "apartments", "status": "active", "forCustomer": { },
"forAgent": { }
}
```
## CustomerCondition
### тип: Объект
### Свойства
|название|тип|опционально|ограничения|описание|
|-|-|-|-|-|
|**taxType**|[taxTypes](#taxtypes)|❌|**запрещенные** значения:
**"none"**
|Налогообложение| |**boma**|[number](#number)|❌|>= 1|Коридорный коэффициент| |**priceMeter**|[number](#number)|✅|> 0|Базовая стоимость квадратного метра (для аренды - в год) - без ндс и кор. коэф.| |**priceIncludes**|[priceAdditionals](#priceadditionals)|✅||В стоимость включено| |**priceExcludes**|[priceAdditionals](#priceadditionals)|✅||В стоимость не включено| |**offerContractType**|[offerContractTypes](#offercontracttypes)|✅||Тип договора| |**rentDurationDate**|[datetime](#datetime)|✅||Дата окончания аренды| |**note**|string|✅||Описание| ### Пример данных: ```json { "taxType": "nds", "boma": 46.3, "priceMeter": 50.39, "priceIncludes": "internet", "priceExcludes": "utilities, parking, cleaning, internet", "offerContractType": "subRent", "rentDurationDate": "2025-08-11T09:52:58.1105857Z", "note": "abcdef..." } ``` ## AgentCondition ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**contractType**|[ownerToAgentContractTypes](#ownertoagentcontracttypes)|❌||Тип договора с агентом| |**income**|[number](#number)|✅||% комиссии| |**paymentTimes**|[integer](#integer)|✅||Количество платежей, если вознаграждение структурировано| |**description**|string|✅||Дополнительная информация| ### Пример данных: ```json { "contractType": "noContract", "income": 71.79, "paymentTimes": 24, "description": "abcdef..." } ``` ## Перечисления Перечисление - это строковое значение из строгого списка значений. В некоторых случаях несколько значений могут быть переданы в одной строке разделённые запятыми. ## entityStates ### тип: Перечисление, строго одно значение из списка #### Список значений ``` actual, editing, archived, deleted ``` |значение|описание| |-|-| |**actual**|Актуально| |**editing**|На редактировании| |**archived**|Отправлено в архив| |**deleted**|Удалено| ## realtyObjectStatuses ### тип: Перечисление, строго одно значение из списка #### Список значений ``` notVerified, actual, archived, deleted ``` |значение|описание| |-|-| |**notVerified**|требует проверки| |**actual**|актуально| |**archived**|в архиве| |**deleted**|удалён| ## realtyObjectInfoFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, noWindows, ownEntrance, wholeBuilding, noLift, personalLift, socleFloor, mansard, loggia, legalAddress, wholeFloor, basement, terrace, veranda ``` |значение|описание| |-|-| |**none**|Отсутствуют| |**noWindows**|Без окон| |**ownEntrance**|Отдельный вход| |**wholeBuilding**|Здание целиком| |**noLift**|Без лифта| |**personalLift**|Персональный лифт| |**socleFloor**|Цокольный этаж| |**mansard**|Мансарда| |**loggia**|Лоджия| |**legalAddress**|Юр. адрес| |**wholeFloor**|Этаж целиком| |**basement**|Подвальное помещение| |**terrace**|Терраса| |**veranda**|Веранда| ## realtyObjectStates ### тип: Перечисление, строго одно значение из списка #### Список значений ``` ready, cosmetic, clean, unknown ``` |значение|описание| |-|-| |**ready**|готово к въезду| |**cosmetic**|нужен косметический ремонт| |**clean**|требуется отделка| |**unknown**|в неизвестном состоянии| ## spaceLayouts ### тип: Перечисление, строго одно значение из списка #### Список значений ``` undefined, other, rooms, open, mixed, hallRooms ``` |значение|описание| |-|-| |**undefined**|неизвестно| |**other**|другая| |**rooms**|кабинетная| |**open**|открытая| |**mixed**|смешанная| |**hallRooms**|коридорно-кабинетная| ## realtyPurposes ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, office, workSpace, psn, bank, cafe, restaurant, canteen, fastFood, fitnes, retail, showRoom, salesOffice, pharmacy, gasStation, medicalService, beautySalon, hostel, hotel, openGround, warehouse, safeKeeping, production, autoService, apartments, flat, room, cottage, townhouse, groundArea ``` |значение|описание| |-|-| |**none**|Не указано| |**office**|Офис| |**workSpace**|Рабочее место| |**psn**|Псн| |**bank**|Банк| |**cafe**|Кафе/бар| |**restaurant**|Ресторан| |**canteen**|Столовая| |**fastFood**|Фастфуд| |**fitnes**|Фитнес| |**retail**|Магазин| |**showRoom**|Шоурум| |**salesOffice**|Офис продаж| |**pharmacy**|Аптека| |**gasStation**|Заправка| |**medicalService**|Медицинские услуги| |**beautySalon**|Салон Красоты| |**hostel**|Хостел| |**hotel**|Гостиница| |**openGround**|Открытая площадка| |**warehouse**|Склад| |**production**|Производство| |**autoService**|Автосервис| |**apartments**|Апартаменты| |**flat**|Квартира| |**room**|Комната| |**cottage**|Дом| |**townhouse**|таунхаус| |**groundArea**|Земельный участок| ## waterPoints ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, missing, present, inside, onFloor, inBuilding, near ``` |значение|описание| |-|-| |**none**|Неизвестно| |**missing**|Отсутствует| |**present**|Есть| |**inside**|Внутри| |**onFloor**|На этом же этаже| |**inBuilding**|В этом же здании| |**near**|В соседнем здании/на территории| ## realtyParkings ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, natural, freeOpen, freeClosedWarm, freeClosedCold, paidOpen, paidClosedCold, paidClosedWarm, outsideTerritory, onTerritory, underground, roof ``` |значение|описание| |-|-| |**none**|значение не задано| |**natural**|Стихийная| |**freeOpen**|Бесплатная открытая| |**freeClosedWarm**|Бесплатная тёплая| |**freeClosedCold**|Бесплатная закрытая холодная| |**paidOpen**|Платная открытая| |**paidClosedCold**|Платная закрытая холодная| |**paidClosedWarm**|Платная тёплая| |**outsideTerritory**|За пределами прилегающей территории| |**onTerritory**|На прилегающей территории| |**underground**|Подземная| |**roof**|На крыше| ## officeFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, furniture, airCondition, hasKitchen, serverRoom, scs ``` |значение|описание| |-|-| |**none**|Не задано| |**furniture**|Есть мебель| |**airCondition**|Есть кондиционирование| |**hasKitchen**|Есть кухня| |**serverRoom**|Есть Серверная| |**scs**|Есть СКС| ## warehouseFloors ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, antiDust, tile, beton, asphalt ``` |значение|описание| |-|-| |**none**|неизвестно| |**antiDust**|антипыль| |**tile**|плитка| |**beton**|бетон| |**asphalt**|асфальт| ## warehouseFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, floorAntiDust, trustKeeping, handlingService, pharm, alcohol, food ``` |значение|описание| |-|-| |**none**|Не указано| |**floorAntiDust**|Пол антипыль| |**trustKeeping**|TrustKeeping| |**handlingService**|Погрузочно-разгрузочные работы| |**pharm**|Фармацевтика| |**alcohol**|Алкоголь| |**food**|Пища| ## realtyObjectHeatings ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, noHeating, heating ``` |значение|описание| |-|-| |**none**|значение не задано| |**noHeating**|холодный| |**heating**|отапливаемый| ## warehouseFreezeEquipments ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, cold, freeze ``` |значение|описание| |-|-| |**none**|значение не задано| |**cold**|холодильная установка| |**freeze**|морозильная установка| ## warehouseUnloadingFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, pandus, docGates, railroad, railroadPandus, railroadHigh ``` |значение|описание| |-|-| |**none**|значение не задано| |**pandus**|пандус| |**docGates**|доки| |**railroad**|ж/д| |**railroadPandus**|ж/д пандус| |**railroadHigh**|ж/д высокий путь| ## warehouseUnloadingEquipments ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, catCrane, travellingGantryCrane ``` |значение|описание| |-|-| |**none**|значение не задано| |**catCrane**|кран-балка| |**travellingGantryCrane**|козловой кран| ## realtyOperations ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, rent, sell ``` |значение|описание| |-|-| |**none**|значение не задано| |**rent**|Аренда| |**sell**|Продажа| ## realtyMarkets ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, offices, warehouses, retail, apartments, flats, countryHouses, business, land ``` |значение|описание| |-|-| |**none**|значение не задано| |**offices**|Офисы| |**warehouses**|Склады| |**retail**|Ритейл| |**apartments**|Апартаменты| |**flats**|Квартиры| |**countryHouses**|Загородное жилье| |**business**|Бизнес| |**land**|Земельные участки| ## realtyOfferStatuses ### тип: Перечисление, строго одно значение из списка #### Список значений ``` notModerated, active, off ``` |значение|описание| |-|-| |**notModerated**|ожидает модерации| |**active**|публикуется| |**off**|не публикуется| ## taxTypes ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, usn, nds ``` |значение|описание| |-|-| |**none**|Не установлено| |**usn**|УСН| |**nds**|НДС| ## priceAdditionals ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, operational, utilities, water, electricity, security, parking, cleaning, internet ``` |значение|описание| |-|-| |**operational**|Эксплуатационные расходы| |**utilities**|Коммунальные услуги| |**water**|Вода| |**electricity**|Электричество| |**security**|Охрана| |**parking**|Парковка| |**cleaning**|Уборка| |**internet**|Интернет| ## offerContractTypes ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, sell, directRent, subRent ``` |значение|описание| |-|-| |**none**|Не указан| |**sell**|Продажа| |**directRent**|Прямая аренда| |**subRent**|Субаренда| ## ownerToAgentContractTypes ### тип: Перечисление, строго одно значение из списка #### Список значений ``` noContract, verbaly, singleDealContract, contract, paysByWeekends, undefined ``` |значение|описание| |-|-| |**noContract**|не работает с агентами| |**verbaly**|устный договор| |**singleDealContract**|договор под клиента| |**contract**|агентский договор| |**undefined**|необходимо узнать|
**"actual"**, **"archived"**
|Статус недвижимости| |**name**|string|✅||Название| |**photos**|[ModelPhotos](#modelphotos)|✅||Изображения недвижимости| ### Пример данных: ```json { "internalId": "abcdef...", "lat": -3.4240809015110512, "lng": -1.5249777690158122, "status": "archived", "name": "abcdef...", "photos": { } } ``` ## ModelPhotos ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**main**|string|✅||Главная фотография| |**layouts**|string[]|✅||Планировки| |**photos**|string[]|✅||Дополнительные фотографии| ### Пример данных: ```json { "main": "abcdef...", "layouts": null, "photos": null } ``` ## RealtyObjectModel ### тип: Объект > Помещение находится в конкретной недвижимости и имеет одно или более предложений и набор характеристик. ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**internalId**|string|❌||Идентификатор помещения| |**realtyInternalId**|string|❌||Идентификатор недвижимости| |**status**|[realtyObjectStatuses](#realtyobjectstatuses)|❌|разрешённые значения:
**"actual"**, **"archived"**
|Статус помещения| |**photos**|[ModelPhotos](#modelphotos)|✅||Изображения помещения| |**info**|[ObjectInfo](#objectinfo)|❌||Общая информация| |**office**|[ObjectOfficeDetails](#objectofficedetails)|✅||Детали офисного помещения| |**warehouse**|[ObjectWarehouseDetails](#objectwarehousedetails)|✅||Детали складского помещения| |**retail**|[ObjectRetailDetails](#objectretaildetails)|✅||Детали retail помещения| |**apartment**|[ObjectApartmentDetails](#objectapartmentdetails)|✅||Детали апартаментов| |**lessee**|[ObjectLesseeInfo](#objectlesseeinfo)|✅||Информация об арендаторе (для готового бизнеса)| ### Пример данных: ```json { "internalId": "abcdef...", "realtyInternalId": "abcdef...", "status": "actual", "photos": { }, "info": {
**"none"**
|Возможные назначения| |**currentPurpose**|[realtyPurposes](#realtypurposes)|❌|строго одно значение|Текущее назначение| |**roomDepth**|[number](#number)|✅|> 0|Глубина помещения| |**waterPoint**|[waterPoints](#waterpoints)|❌||Санузел/мокроя точка| |**waterPointCount**|[integer](#integer)|✅|>= 0|Количество санузлов| |**parking**|[realtyParkings](#realtyparkings)|❌||| |**parkingCarPlaces**|[integer](#integer)|✅|>= 0|Количество машиномест на парковке| |**parkingNote**|string|✅||Дополнительная информация о парковке| |**power**|[number](#number)|✅|>= 0|Электричество, кВт| |**note**|string|✅||Заметка| ### Пример данных: ```json { "features": "wholeFloor, basement", "squareTotal": 49.61, "squareOffer": 151.95, "squareMin": 26.34, "floor": 38, "floorsCount": 58, "roomsCount": -12, "floorsHeight": 87.56, "floorsHeightWork": 31.41, "roomNumber": "abcdef...", "state": "clean", "spaceLayout": "open", "purposes": "office, workSpace, psn, restaurant, canteen, retail, showRoom, gasStation, medicalService, hotel, openGround, apartments, groundArea", "currentPurpose": "beautySalon", "roomDepth": 18.93, "waterPoint": "onFloor", "waterPointCount": 128, "parking": "freeOpen, freeClosedWarm, freeClosedCold, paidOpen, paidClosedCold, outsideTerritory, underground", "parkingCarPlaces": 52, "parkingNote": "abcdef...", "power": 108.86, "note": "abcdef..." } ``` ## ObjectOfficeDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**features**|[officeFeatures](#officefeatures)|❌||Особенности офиса| |**note**|string|✅||Заметка| ### Пример данных: ```json { "features": "serverRoom", "note": "abcdef..." } ``` ## ObjectWarehouseDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**floorMaterial**|[warehouseFloors](#warehousefloors)|❌||Тип пола| |**features**|[warehouseFeatures](#warehousefeatures)|❌||Особенности складского помещения| |**heating**|[realtyObjectHeatings](#realtyobjectheatings)|❌||Отопление| |**freezeEquipment**|[warehouseFreezeEquipments](#warehousefreezeequipments)|❌||Морозильное оборудование| |**unloadingFeatures**|[warehouseUnloadingFeatures](#warehouseunloadingfeatures)|❌||Особенности разгрузки| |**unloadingEquipment**|[warehouseUnloadingEquipments](#warehouseunloadingequipments)|❌||Оснащение| |**gatesCount**|[integer](#integer)|✅|>= 0|Количество ворот| |**gatesNote**|string|✅||Описание ворот (тип или комментарий)| |**palletPlaces**|[integer](#integer)|✅|>= 0|Колличество паллетомест| |**columnStepA**|[number](#number)|✅|> 0|Шаг колонн А (А х Б)| |**columnStepB**|[number](#number)|✅|> 0|Шаг колонн Б (А х Б)| |**floorLoadMax**|[number](#number)|✅|> 0|Максимальная нагрузка на пол (кг на кв. м)| |**note**|string|✅||Заметка| ### Пример данных: ```json { "floorMaterial": "asphalt", "features": "floorAntiDust, trustKeeping, handlingService, food", "heating": "none", "freezeEquipment": "freeze", "unloadingFeatures": "pandus, railroad, railroadPandus", "unloadingEquipment": "none", "gatesCount": 28, "gatesNote": "abcdef...", "palletPlaces": 131, "columnStepA": 20.36, "columnStepB": 73.93, "floorLoadMax": 126.22, "note": "abcdef..." } ``` ## ObjectRetailDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**note**|string|✅||Заметка| ### Пример данных: ```json { "note": "abcdef..." } ``` ## ObjectApartmentDetails ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**kitchensCount**|[integer](#integer)|✅|>= 0|Всего кухонь| |**bedroomsCount**|[integer](#integer)|✅|>= 0|Всего спален| |**bathroomsCount**|[integer](#integer)|✅|>= 0|Всего ванных комнат| |**dressingRoomsCount**|[integer](#integer)|✅|>= 0|Всего гардеробных| |**hasPlaceForOffice**|boolean|✅||Есть комната под отдельный кабинет| |**kitchenSquare**|[number](#number)|✅|>= 0|Площадь кухни (если не одна, то общая площадь всех)| |**notLivingSquare**|[number](#number)|✅|>= 0|Нежилая площадь| |**note**|string|✅||Заметка| ### Пример данных: ```json { "kitchensCount": 138, "bedroomsCount": 34, "bathroomsCount": 29, "dressingRoomsCount": 79, "hasPlaceForOffice": false, "kitchenSquare": 83.01, "notLivingSquare": 1.63, "note": "abcdef..." } ``` ## ObjectLesseeInfo ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**occupied**|boolean|✅||Наличие арендатора в данное время| |**longDuration**|boolean|✅||Долгосрочная аренда| |**occupiedAt**|[datetime](#datetime)|✅||Дата въезда арендатора| |**releaseAt**|[datetime](#datetime)|✅||Примерная дата освобождения| |**companyName**|string|✅||Название арендатора| |**companyDescription**|string|✅||Род деятельности арендатора| |**note**|string|✅||Описание арендного бизнеса| |**incomeInMonth**|[number](#number)|✅|>= 0|Прибыль в месяц| ### Пример данных: ```json { "occupied": false, "longDuration": false, "occupiedAt": "2024-07-21T09:52:58.0935865Z", "releaseAt": "2025-06-08T09:52:58.0935865Z", "companyName": "abcdef...", "companyDescription": "abcdef...", "note": "abcdef...", "incomeInMonth": 20.71 } ``` ## OfferModel ### тип: Объект > Предложение - это коммерческие условия по продаже или аренде для потенциального клиента и агентские условия для посредника. > У помещения одновременно может быть много предложений. ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**objectInternalId**|string|❌||Идентификатор помещения| |**operation**|[realtyOperations](#realtyoperations)|❌|**запрещенные** значения:
**"none"**
, строго одно значение|Операция| |**market**|[realtyMarkets](#realtymarkets)|❌|**запрещенные** значения:
**"none"**
, строго одно значение|Категория предложения| |**status**|[realtyOfferStatuses](#realtyofferstatuses)|❌|разрешённые значения:
**"active"**, **"off"**
|Статус предложения| |**forCustomer**|[CustomerCondition](#customercondition)|❌||Условия для клиента| |**forAgent**|[AgentCondition](#agentcondition)|✅||Условия для агента| ### Пример данных: ```json { "objectInternalId": "abcdef...", "operation": "rent", "market": "apartments", "status": "active", "forCustomer": {
**"none"**
|Налогообложение| |**boma**|[number](#number)|❌|>= 1|Коридорный коэффициент| |**priceMeter**|[number](#number)|✅|> 0|Базовая стоимость квадратного метра (для аренды - в год) - без ндс и кор. коэф.| |**priceIncludes**|[priceAdditionals](#priceadditionals)|✅||В стоимость включено| |**priceExcludes**|[priceAdditionals](#priceadditionals)|✅||В стоимость не включено| |**offerContractType**|[offerContractTypes](#offercontracttypes)|✅||Тип договора| |**rentDurationDate**|[datetime](#datetime)|✅||Дата окончания аренды| |**note**|string|✅||Описание| ### Пример данных: ```json { "taxType": "nds", "boma": 46.3, "priceMeter": 50.39, "priceIncludes": "internet", "priceExcludes": "utilities, parking, cleaning, internet", "offerContractType": "subRent", "rentDurationDate": "2025-08-11T09:52:58.1105857Z", "note": "abcdef..." } ``` ## AgentCondition ### тип: Объект ### Свойства |название|тип|опционально|ограничения|описание| |-|-|-|-|-| |**contractType**|[ownerToAgentContractTypes](#ownertoagentcontracttypes)|❌||Тип договора с агентом| |**income**|[number](#number)|✅||% комиссии| |**paymentTimes**|[integer](#integer)|✅||Количество платежей, если вознаграждение структурировано| |**description**|string|✅||Дополнительная информация| ### Пример данных: ```json { "contractType": "noContract", "income": 71.79, "paymentTimes": 24, "description": "abcdef..." } ``` ## Перечисления Перечисление - это строковое значение из строгого списка значений. В некоторых случаях несколько значений могут быть переданы в одной строке разделённые запятыми. ## entityStates ### тип: Перечисление, строго одно значение из списка #### Список значений ``` actual, editing, archived, deleted ``` |значение|описание| |-|-| |**actual**|Актуально| |**editing**|На редактировании| |**archived**|Отправлено в архив| |**deleted**|Удалено| ## realtyObjectStatuses ### тип: Перечисление, строго одно значение из списка #### Список значений ``` notVerified, actual, archived, deleted ``` |значение|описание| |-|-| |**notVerified**|требует проверки| |**actual**|актуально| |**archived**|в архиве| |**deleted**|удалён| ## realtyObjectInfoFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, noWindows, ownEntrance, wholeBuilding, noLift, personalLift, socleFloor, mansard, loggia, legalAddress, wholeFloor, basement, terrace, veranda ``` |значение|описание| |-|-| |**none**|Отсутствуют| |**noWindows**|Без окон| |**ownEntrance**|Отдельный вход| |**wholeBuilding**|Здание целиком| |**noLift**|Без лифта| |**personalLift**|Персональный лифт| |**socleFloor**|Цокольный этаж| |**mansard**|Мансарда| |**loggia**|Лоджия| |**legalAddress**|Юр. адрес| |**wholeFloor**|Этаж целиком| |**basement**|Подвальное помещение| |**terrace**|Терраса| |**veranda**|Веранда| ## realtyObjectStates ### тип: Перечисление, строго одно значение из списка #### Список значений ``` ready, cosmetic, clean, unknown ``` |значение|описание| |-|-| |**ready**|готово к въезду| |**cosmetic**|нужен косметический ремонт| |**clean**|требуется отделка| |**unknown**|в неизвестном состоянии| ## spaceLayouts ### тип: Перечисление, строго одно значение из списка #### Список значений ``` undefined, other, rooms, open, mixed, hallRooms ``` |значение|описание| |-|-| |**undefined**|неизвестно| |**other**|другая| |**rooms**|кабинетная| |**open**|открытая| |**mixed**|смешанная| |**hallRooms**|коридорно-кабинетная| ## realtyPurposes ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, office, workSpace, psn, bank, cafe, restaurant, canteen, fastFood, fitnes, retail, showRoom, salesOffice, pharmacy, gasStation, medicalService, beautySalon, hostel, hotel, openGround, warehouse, safeKeeping, production, autoService, apartments, flat, room, cottage, townhouse, groundArea ``` |значение|описание| |-|-| |**none**|Не указано| |**office**|Офис| |**workSpace**|Рабочее место| |**psn**|Псн| |**bank**|Банк| |**cafe**|Кафе/бар| |**restaurant**|Ресторан| |**canteen**|Столовая| |**fastFood**|Фастфуд| |**fitnes**|Фитнес| |**retail**|Магазин| |**showRoom**|Шоурум| |**salesOffice**|Офис продаж| |**pharmacy**|Аптека| |**gasStation**|Заправка| |**medicalService**|Медицинские услуги| |**beautySalon**|Салон Красоты| |**hostel**|Хостел| |**hotel**|Гостиница| |**openGround**|Открытая площадка| |**warehouse**|Склад| |**production**|Производство| |**autoService**|Автосервис| |**apartments**|Апартаменты| |**flat**|Квартира| |**room**|Комната| |**cottage**|Дом| |**townhouse**|таунхаус| |**groundArea**|Земельный участок| ## waterPoints ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, missing, present, inside, onFloor, inBuilding, near ``` |значение|описание| |-|-| |**none**|Неизвестно| |**missing**|Отсутствует| |**present**|Есть| |**inside**|Внутри| |**onFloor**|На этом же этаже| |**inBuilding**|В этом же здании| |**near**|В соседнем здании/на территории| ## realtyParkings ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, natural, freeOpen, freeClosedWarm, freeClosedCold, paidOpen, paidClosedCold, paidClosedWarm, outsideTerritory, onTerritory, underground, roof ``` |значение|описание| |-|-| |**none**|значение не задано| |**natural**|Стихийная| |**freeOpen**|Бесплатная открытая| |**freeClosedWarm**|Бесплатная тёплая| |**freeClosedCold**|Бесплатная закрытая холодная| |**paidOpen**|Платная открытая| |**paidClosedCold**|Платная закрытая холодная| |**paidClosedWarm**|Платная тёплая| |**outsideTerritory**|За пределами прилегающей территории| |**onTerritory**|На прилегающей территории| |**underground**|Подземная| |**roof**|На крыше| ## officeFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, furniture, airCondition, hasKitchen, serverRoom, scs ``` |значение|описание| |-|-| |**none**|Не задано| |**furniture**|Есть мебель| |**airCondition**|Есть кондиционирование| |**hasKitchen**|Есть кухня| |**serverRoom**|Есть Серверная| |**scs**|Есть СКС| ## warehouseFloors ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, antiDust, tile, beton, asphalt ``` |значение|описание| |-|-| |**none**|неизвестно| |**antiDust**|антипыль| |**tile**|плитка| |**beton**|бетон| |**asphalt**|асфальт| ## warehouseFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, floorAntiDust, trustKeeping, handlingService, pharm, alcohol, food ``` |значение|описание| |-|-| |**none**|Не указано| |**floorAntiDust**|Пол антипыль| |**trustKeeping**|TrustKeeping| |**handlingService**|Погрузочно-разгрузочные работы| |**pharm**|Фармацевтика| |**alcohol**|Алкоголь| |**food**|Пища| ## realtyObjectHeatings ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, noHeating, heating ``` |значение|описание| |-|-| |**none**|значение не задано| |**noHeating**|холодный| |**heating**|отапливаемый| ## warehouseFreezeEquipments ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, cold, freeze ``` |значение|описание| |-|-| |**none**|значение не задано| |**cold**|холодильная установка| |**freeze**|морозильная установка| ## warehouseUnloadingFeatures ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, pandus, docGates, railroad, railroadPandus, railroadHigh ``` |значение|описание| |-|-| |**none**|значение не задано| |**pandus**|пандус| |**docGates**|доки| |**railroad**|ж/д| |**railroadPandus**|ж/д пандус| |**railroadHigh**|ж/д высокий путь| ## warehouseUnloadingEquipments ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, catCrane, travellingGantryCrane ``` |значение|описание| |-|-| |**none**|значение не задано| |**catCrane**|кран-балка| |**travellingGantryCrane**|козловой кран| ## realtyOperations ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, rent, sell ``` |значение|описание| |-|-| |**none**|значение не задано| |**rent**|Аренда| |**sell**|Продажа| ## realtyMarkets ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, offices, warehouses, retail, apartments, flats, countryHouses, business, land ``` |значение|описание| |-|-| |**none**|значение не задано| |**offices**|Офисы| |**warehouses**|Склады| |**retail**|Ритейл| |**apartments**|Апартаменты| |**flats**|Квартиры| |**countryHouses**|Загородное жилье| |**business**|Бизнес| |**land**|Земельные участки| ## realtyOfferStatuses ### тип: Перечисление, строго одно значение из списка #### Список значений ``` notModerated, active, off ``` |значение|описание| |-|-| |**notModerated**|ожидает модерации| |**active**|публикуется| |**off**|не публикуется| ## taxTypes ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, usn, nds ``` |значение|описание| |-|-| |**none**|Не установлено| |**usn**|УСН| |**nds**|НДС| ## priceAdditionals ### тип: Перечисление, возможно несколько значений, разделённых запятой #### Список значений ``` none, operational, utilities, water, electricity, security, parking, cleaning, internet ``` |значение|описание| |-|-| |**operational**|Эксплуатационные расходы| |**utilities**|Коммунальные услуги| |**water**|Вода| |**electricity**|Электричество| |**security**|Охрана| |**parking**|Парковка| |**cleaning**|Уборка| |**internet**|Интернет| ## offerContractTypes ### тип: Перечисление, строго одно значение из списка #### Список значений ``` none, sell, directRent, subRent ``` |значение|описание| |-|-| |**none**|Не указан| |**sell**|Продажа| |**directRent**|Прямая аренда| |**subRent**|Субаренда| ## ownerToAgentContractTypes ### тип: Перечисление, строго одно значение из списка #### Список значений ``` noContract, verbaly, singleDealContract, contract, paysByWeekends, undefined ``` |значение|описание| |-|-| |**noContract**|не работает с агентами| |**verbaly**|устный договор| |**singleDealContract**|договор под клиента| |**contract**|агентский договор| |**undefined**|необходимо узнать|