Download OpenAPI specification:
REST API of the OpenImmo 2 standard for exchanging real estate data. Software providers use it to create, update and delete listings and projects on a receiving platform and to upload the associated media files.
The standard is maintained by OpenImmo e.V., Verein zur Förderung des Datenaustauschs in der Immobilienwirtschaft.
This endpoint allows you to create a new classified to be published on the receiving platform's portals. Depending on the parameters sent along with the body payload, the classified can be created but not published. This endpoint returns synchronously a response informing if the body payload format is valid or not. In the case of a valid format, the endpoint will return a 202 Accepted HTTP status code with URL links to related resources. In the case of invalid format, the endpoint will return a 400 Invalid format HTTP status code with the details of the rejection's reasons
required | object (data) |
required | object (metadata) Metadata associated with the listing in the receiving platform |
Array of objects (userDefined) en=Area for extended Data, not expilitly defined. As ARRAY. Every item has name, value with a type and modus. modus can be free used i.e. for defining CRUD atrributes. ;de= Der Bereich für -User Defined Daten- z.B. zum bilateralen Austausch zwischen Partnern | |
Array of objects (mediaRequest) Array of media items to attach to the listing. | |
object (contact) |
{- "data": {
- "estateType": "HOUSE",
- "estateSubType": {
- "house": "SINGLE_FAMILY_HOUSE"
}, - "distributionType": "BUY",
- "location": {
- "postalcode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "unit": "Block C",
- "staircase": "A",
- "floorNumber": 2,
- "entrance": "123",
- "state": "Bavaria",
- "country": "DEU",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 13.405,
- 52.52
]
}, - "showAddress": true,
- "locationNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "prices": {
- "currency": "EUR",
- "buy": {
- "price": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isLeaseBuyCombi": true,
- "leasehold": {
- "isLeasehold": true,
- "amount": 120,
- "priceTimeUnit": "YEAR",
- "duration": 99,
- "endDate": "2023-05-24"
}, - "operatingCosts": {
- "priceTimeUnit": "DAY",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "rentalIncome": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "rentalIncomeExpect": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "isOperatingCostsIncluded": false,
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "yieldFactor": 12.5,
- "countrySpecific": {
- "fr": {
- "isReducedNotaryFees": true,
- "notaryFeesFor": "BUYER",
- "lifeAnnuity": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "at": {
- "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "vatCostsPerMonth": 0,
- "costsPerMonthGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "rent": {
- "baseRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "baseRentPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "totalRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "lease": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "operatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "heatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "isHeatingIncludedInOC": true,
- "isHeatingIncludedInTR": true,
- "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "pricePerSqUnitPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "priceTimeUnit": "MONTH",
- "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "depositNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "leaseRight": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "accessPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "overRegulatedRent": 225.6
}, - "at": {
- "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadVat": 0,
- "overallRentGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "rentNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "compulsoryAuction": {
- "auctionProceeds": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "biddingGuarantee": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "marketValue": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "minimumBid": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "buyAuction": {
- "minPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false
}, - "startOfferPhase": "2023-05-24",
- "endOfferPhase": "2023-05-24"
}, - "brokerageFee": {
- "isFeeIncluded": false,
- "feeFor": "BUYER_OR_TENANT",
- "feePercentage": 4.5,
- "hasFee": "YES",
- "feeNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
}, - "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "showPrice": true,
- "priceNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "taxRegime": "string",
- "residentialLeaseType": "string",
- "isPTZeligible": true,
- "taxReductionZone": "A"
}
}
}, - "spaces": {
- "spaceMeasureUnit": "SQUARE_METER",
- "buildingFront": 23,
- "kitchenSpace": 99999999,
- "overallSpace": 99999999,
- "usableFloorSpace": 99999999,
- "spaceMax": 99999999,
- "spaceMin": 99999999,
- "plotSpace": 99999999,
- "plotFront": 60,
- "additionalSpace": 99999999,
- "residential": {
- "livingSpace": 99999999,
- "livingRoomSpace": 99999999,
- "atticSpace": 99999999,
- "balconySpace": 99999999,
- "cellarSpace": 99999999,
- "gardenSpace": 99999999,
- "terraceSpace": 99999999
}, - "commercial": {
- "maxDivisible": 99999999,
- "minDivisible": 99999999,
- "commercialSpace": 99999999,
- "shopSpace": 99999999,
- "storageSpace": 99999999,
- "sellSpace": 99999999,
- "officeSpace": 99999999,
- "officePartSpace": 99999999,
- "managementSpace": 99999999,
- "restaurantSpace": 99999999,
- "countrySpecific": { }
}
}, - "conditions": {
- "buildState": "FIRST_TIME_USE",
- "ageState": "OLD",
- "lastModernisation": 2010,
- "constructionStyle": "PREFABRICATED",
- "yearOfConstruction": 2000
}, - "energy": {
- "energyType": {
- "heatMethod": "CENTRAL",
- "heatForm": {
- "air": true,
- "radiator": true,
- "stove": true,
- "underfloor": true,
- "wallCeiling": true
}, - "energySource": {
- "coal": true,
- "districtHeating": true,
- "electric": true,
- "gas": true,
- "geothermal": true,
- "liquidGas": true,
- "oil": true,
- "solarHeat": true,
- "solarPower": true,
- "wind": true,
- "wood": true,
- "woodPellet": true
}, - "energyGeneration": {
- "fossilburning": true,
- "heatpump": true,
- "combinedHeatAndPowerPlant": true
}, - "maxElectricalPower": 200
}, - "countrySpecific": {
- "de": {
- "energyCertificates": [
- {
- "nameOfCertificate": "string",
- "certificateType": "ENEV2014",
- "certificateBasedOn": "NEED",
- "isResidentialBuilding": true,
- "primaryEnergySource": "GAS",
- "efficiencyClass": "A_PLUS",
- "releaseDate": "2023-05-24",
- "validUntil": "2023-05-28",
- "yearOfConstructionBuilding": 0,
- "yearOfConstructionHeating": 0,
- "overallEnergyNeed": 0,
- "primaryEnergyNeed": 0,
- "electricityNeed": 0,
- "heatingNeed": 0,
- "overallEnergyConsumption": 0,
- "primaryEnergyConsumption": 0,
- "isWaterHeatingIncluded": true,
- "electricityConsumption": 0,
- "heatingConsumption": 0,
- "energyConsumptionIndicator": 0
}
], - "houseEnergyStandardType": "ENERGY_EFFICIENT_40",
- "primaryEnergySource": "string"
}
}
}, - "features": {
- "accessibleFromStreet": "YES",
- "aircondition": "YES",
- "entranceHall": "YES",
- "floorCovering": {
- "tiles": "YES",
- "stone": "YES",
- "carpet": "YES",
- "parquet": "YES",
- "laminate": "YES",
- "synthetic": "YES",
- "screed": "YES",
- "linoleum": "YES",
- "marble": "YES",
- "terracotta": "YES",
- "granite": "YES",
- "raisedFloor": "YES",
- "quartz": "YES",
- "concrete": "YES",
- "antiDustConcrete": "YES",
- "woodenPlank": "YES",
- "antiStatic": "YES",
- "vinyl": "YES"
}, - "furnished": "PART",
- "garden": {
- "part": true,
- "private": true,
- "shared": true
}, - "gym": "YES",
- "internet": {
- "internetSpeedMbit": 100,
- "internetAvailability": {
- "opticalFiber": false,
- "dsl": true,
- "cable": false,
- "satellite": false
}, - "propertyInternetAccess": {
- "ethernet": false,
- "wireless": true
}
}, - "lighting": {
- "ceiling": "YES",
- "led": "YES",
- "window": "YES"
}, - "mezzanine": "YES",
- "propertyOrientation": "NORTH",
- "receptionist": "YES",
- "security": {
- "buildingIntercom": "YES",
- "cam": "YES",
- "custodian": "YES",
- "custodianRoom": "YES",
- "digitalLock": "YES",
- "emergencyCall": "YES",
- "fireSprinkler": "YES",
- "fireAlarm": "YES",
- "intruderAlarm": "YES",
- "reinforcedDoor": "YES",
- "safe": "YES"
}, - "wheelchairUse": "YES",
- "wineCellar": "YES",
- "residential": {
- "assistedLiving": "YES",
- "chimney": "YES",
- "flatSharePossible": "YES",
- "hammam": "YES",
- "houseCleaningService": "YES",
- "jacuzzi": "YES",
- "loggia": "YES",
- "sauna": "YES",
- "swimmingPool": "YES",
- "tennisField": "YES",
- "tv": "SAT",
- "veranda": "YES",
- "laundryRoom": "YES",
- "countrySpecific": {
- "fr": {
- "evacuation": "ALL_SEWER"
}
}
}, - "commercial": {
- "accessibleByTrucks": "YES",
- "auditorium": "YES",
- "bar": "YES",
- "buildingVentilation": "YES",
- "cafeteria": "YES",
- "coldStore": "YES",
- "companyRestaurant": "YES",
- "droppedCeiling": "YES",
- "engineGenerator": "YES",
- "exhaustHood": "YES",
- "flexibleRoomLayout": "YES",
- "heatedTerrace": "YES",
- "liftingPlatform": "YES",
- "numberOfStorageCells": 999999,
- "overheadCrane": "YES",
- "restaurantSeats": 999999,
- "restaurantSeatsOutside": 999999,
- "teaKitchen": "YES",
- "truckManeuveringArea": "YES",
- "verticalSlidingDoor": "YES",
- "wallSiding": "YES",
- "countrySpecific": {
- "fr": {
- "licenseType": "PETITE_LICENCE_RESTAURANT"
}
}
}, - "parking": {
- "chargingStation": "YES",
- "bikeParking": "YES"
}, - "plot": {
- "usageFor": {
- "futureDevelopmentLand": "YES",
- "twinhouse": "YES",
- "singleFamilyHouse": "YES",
- "terraceHouse": "YES",
- "apartmentBuilding": "YES",
- "orchard": "YES",
- "farmland": "YES",
- "parkingSpace": "YES",
- "garage": "YES",
- "noDevelopment": "YES"
}, - "developmentInfrastructure": {
- "districtHeating": "YES",
- "electric": "YES",
- "gas": "YES",
- "telco": "YES",
- "water": "YES"
}, - "shortTermConstructible": "YES",
- "brownfield": "YES",
- "buildingPermission": "YES",
- "demolitionSuggested": "YES",
- "fencedPlot": "YES",
- "isTerracedArea": true,
- "tilt": "NONE",
- "countrySpecific": {
- "de": {
- "buildingRules": "NEIGHBORHOOD_34",
- "siteDevelopmentState": "UNDEVELOPED"
}
}
}
}, - "structure": {
- "building": {
- "attic": "CONVERTED",
- "balconyDirection": "NORTH",
- "gardenOrientation": "NORTH",
- "barrierFree": "YES",
- "bath": {
- "shower": "YES",
- "bathtub": "YES",
- "window": "YES",
- "bidet": "YES",
- "urinal": "YES",
- "guestToilet": "YES",
- "separateBathAndToilet": "YES",
- "toilet": "YES",
- "bathroomSink": "YES"
}, - "cellar": "YES",
- "elevator": {
- "person": "YES",
- "freight": "NO"
}, - "kitchen": {
- "kitchenType": {
- "builtIn": true,
- "kitchenette": true,
- "open": true,
- "separated": true
}, - "kitchenEquipment": "NONE",
- "pantry": "YES",
- "singleStorey": "YES"
}, - "numberOfFloors": 1,
- "numberOfFacades": 1,
- "roomHeight": 3.2,
- "offeredFloors": 1,
- "roofStyle": "HALF_HIPPED_ROOF",
- "locationInBuilding": "GROUNDFLOOR",
- "locationAtCorner": "YES",
- "calm": "YES",
- "withView": {
- "courtyardView": true,
- "lakeView": true,
- "mountainView": true,
- "overlooking": true,
- "seaView": true,
- "skiView": true
}, - "luminous": "YES",
- "window": {
- "bayWindow": "YES",
- "blinds": "YES",
- "windowMaterial": {
- "woodenWindows": "YES",
- "aluminiumWindows": "YES",
- "muntinWindows": "YES",
- "plasticWindows": "YES",
- "insulatedGlazing": "YES"
}
}, - "shape": "L_SHAPE",
- "hasSplitFloor": true,
- "wallConstructionMaterial": [
- "MASSIVE_WOOD"
]
}, - "rooms": {
- "numberOfRooms": 2,
- "numberOfBedRooms": 1,
- "numberOfBathRooms": 1,
- "numberOfToilets": 1,
- "numberOfBalconies": 0,
- "numberOfTerraces": 1,
- "numberOfKitchens": 0,
- "numberOfUnits": 1
}, - "commercial": {
- "floorLoad": 0,
- "floorLoadUpperFloors": 0,
- "hallHeight": 2.9,
- "numberOfBeds": 1,
- "numberOfLoadingDocks": 999999,
- "numberOfDesks": 999999,
- "numberOfMeetingRooms": 999999,
- "numberOfOfficeRooms": 999999,
- "windowFront": 2.2
}, - "parkingLots": {
- "outside": 999999,
- "streetParking": 999999,
- "carport": 999999,
- "garage": 999999,
- "doubleGarage": 999999,
- "duplex": 999999,
- "garageArea": 999999,
- "parkingArea": 999999,
- "carPark": 999999,
- "underground": 999999,
- "boatDock": 999999
}
}, - "texts": {
- "headline": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "description": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "features": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "extendedInformation": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "area": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "management": {
- "isImmediatelyAvailable": true,
- "availableFrom": "2023-05-24",
- "availableUntil": "2023-05-24",
- "isForInvestment": true,
- "heritageProtected": "NOT_APPLICABLE",
- "marketStatus": "SOLD",
- "projectStatus": "BUILDING_PERMISSION",
- "marketLabel": "property of the week",
- "isRented": true,
- "useFor": "LIVING",
- "isForHolidayRental": true,
- "rent": {
- "favouredGender": "MALE",
- "minRentalTime": 1,
- "maxRentalTime": 3,
- "rentalTimeUnit": "YEAR",
- "certificateOfEligibilityNeeded": "YES",
- "maxPersons": 1,
- "nonSmoker": "NOT_APPLICABLE",
- "petsAllowed": "NOT_APPLICABLE",
- "isShortTimeRental": true
}, - "compulsoryAuction": {
- "auctionLocation": "string",
- "auctionSpace": "string",
- "cancellationDate": "2019-08-24",
- "coOwnership": "string",
- "countyCourt": "Berlin Charlottenburg",
- "dateOfAuction": "2023-05-24",
- "isDiscretionarySale": true,
- "distributionPlanNumber": "string",
- "fileReferenceAtCountyCourt": "string",
- "lastChangeDate": "2023-05-24",
- "insolvencyAdministrator": "string",
- "owner": "string",
- "recordationDate": "2019-08-24",
- "additionalDate": "2023-05-24",
- "isWithoutValueLimits": true,
- "isSplittingAuction": true
}
}, - "countrySpecific": {
- "de": { },
- "fr": {
- "business": {
- "isBusinessSold": true,
- "businessType": "LEISURE",
- "businessSubType": "BAKERY",
- "revenue": 100000,
- "revenueOneYearAgo": 100000,
- "revenueTwoYearsAgo": 100000,
- "revenueDetails": "Some information about the breakdown of the revenue",
- "netIncome": 100000,
- "netIncomeOneYearAgo": 100000,
- "netIncomeTwoYearsAgo": 100000,
- "isPartOfNetwork": true,
- "downPayment": 100000,
- "isNoNuisance": true,
- "isDivisible": false
}
}
}, - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}, - "links": {
}
}, - "metadata": {
- "source": {
- "offererMarketingKey": "HH-AH61a-WE15a-1",
- "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981",
- "offererEstateGroupId": "Group0815"
}, - "portalWebKey": "2rqww3y"
}, - "userDefined": [
- {
- "name": "string",
- "value": "string",
- "utyp": "string",
- "modus": "readonly"
}
], - "media": [
- {
- "externalMediaId": "B6A58E12-12D9-4F20-812F-AE2D6DAE8F99",
- "title": "Living room view"
}
], - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}
}{- "requestId": "0196106c-409b-7fg4-a317-db7393a36b77",
- "listingId": "a1b2c3d4-e5f6-4789-b0a1-c2d3e4f5a6b7",
- "externalListingId": "offererEstateId123",
- "warnings": [
- {
- "type": "LOCATION_IMPRECISE",
- "message": "The location for the listing/project is not precise enough. The listing/project may not be accurately represented on the map."
}
]
}Retrieve all listings for a customer. To fetch nextPage, use the GET /listings?nextPageToken={token} in this endpoint. To retrieve a specific listing, use the GET /listings/{externalListingId} endpoint.
| nextPageToken | string The token to retrieve the next page of results. This token is returned in the response of this endpoint when the number of listings exceeds the page size. To retrieve the first page of results, do not include this parameter in the request. |
{- "externalListingIds": [
- "string"
], - "nextPageToken": "string"
}Retrieves a listing
| externalListingId required | string Example: 2592IWF02EC6 The Unique Identifier of the listing. Can be:
|
{- "listing": {
- "data": {
- "estateType": "HOUSE",
- "estateSubType": {
- "house": "SINGLE_FAMILY_HOUSE"
}, - "distributionType": "BUY",
- "location": {
- "postalcode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "unit": "Block C",
- "staircase": "A",
- "floorNumber": 2,
- "entrance": "123",
- "state": "Bavaria",
- "country": "DEU",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 13.405,
- 52.52
]
}, - "showAddress": true,
- "locationNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "prices": {
- "currency": "EUR",
- "buy": {
- "price": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isLeaseBuyCombi": true,
- "leasehold": {
- "isLeasehold": true,
- "amount": 120,
- "priceTimeUnit": "YEAR",
- "duration": 99,
- "endDate": "2023-05-24"
}, - "operatingCosts": {
- "priceTimeUnit": "DAY",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "rentalIncome": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "rentalIncomeExpect": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "isOperatingCostsIncluded": false,
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "yieldFactor": 12.5,
- "countrySpecific": {
- "fr": {
- "isReducedNotaryFees": true,
- "notaryFeesFor": "BUYER",
- "lifeAnnuity": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "at": {
- "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "vatCostsPerMonth": 0,
- "costsPerMonthGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "rent": {
- "baseRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "baseRentPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "totalRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "lease": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "operatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "heatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "isHeatingIncludedInOC": true,
- "isHeatingIncludedInTR": true,
- "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "pricePerSqUnitPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "priceTimeUnit": "MONTH",
- "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "depositNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "leaseRight": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "accessPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "overRegulatedRent": 225.6
}, - "at": {
- "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadVat": 0,
- "overallRentGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "rentNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "compulsoryAuction": {
- "auctionProceeds": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "biddingGuarantee": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "marketValue": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "minimumBid": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "buyAuction": {
- "minPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false
}, - "startOfferPhase": "2023-05-24",
- "endOfferPhase": "2023-05-24"
}, - "brokerageFee": {
- "isFeeIncluded": false,
- "feeFor": "BUYER_OR_TENANT",
- "feePercentage": 4.5,
- "hasFee": "YES",
- "feeNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
}, - "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "showPrice": true,
- "priceNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "taxRegime": "string",
- "residentialLeaseType": "string",
- "isPTZeligible": true,
- "taxReductionZone": "A"
}
}
}, - "spaces": {
- "spaceMeasureUnit": "SQUARE_METER",
- "buildingFront": 23,
- "kitchenSpace": 99999999,
- "overallSpace": 99999999,
- "usableFloorSpace": 99999999,
- "spaceMax": 99999999,
- "spaceMin": 99999999,
- "plotSpace": 99999999,
- "plotFront": 60,
- "additionalSpace": 99999999,
- "residential": {
- "livingSpace": 99999999,
- "livingRoomSpace": 99999999,
- "atticSpace": 99999999,
- "balconySpace": 99999999,
- "cellarSpace": 99999999,
- "gardenSpace": 99999999,
- "terraceSpace": 99999999
}, - "commercial": {
- "maxDivisible": 99999999,
- "minDivisible": 99999999,
- "commercialSpace": 99999999,
- "shopSpace": 99999999,
- "storageSpace": 99999999,
- "sellSpace": 99999999,
- "officeSpace": 99999999,
- "officePartSpace": 99999999,
- "managementSpace": 99999999,
- "restaurantSpace": 99999999,
- "countrySpecific": { }
}
}, - "conditions": {
- "buildState": "FIRST_TIME_USE",
- "ageState": "OLD",
- "lastModernisation": 2010,
- "constructionStyle": "PREFABRICATED",
- "yearOfConstruction": 2000
}, - "energy": {
- "energyType": {
- "heatMethod": "CENTRAL",
- "heatForm": {
- "air": true,
- "radiator": true,
- "stove": true,
- "underfloor": true,
- "wallCeiling": true
}, - "energySource": {
- "coal": true,
- "districtHeating": true,
- "electric": true,
- "gas": true,
- "geothermal": true,
- "liquidGas": true,
- "oil": true,
- "solarHeat": true,
- "solarPower": true,
- "wind": true,
- "wood": true,
- "woodPellet": true
}, - "energyGeneration": {
- "fossilburning": true,
- "heatpump": true,
- "combinedHeatAndPowerPlant": true
}, - "maxElectricalPower": 200
}, - "countrySpecific": {
- "de": {
- "energyCertificates": [
- {
- "nameOfCertificate": "string",
- "certificateType": "ENEV2014",
- "certificateBasedOn": "NEED",
- "isResidentialBuilding": true,
- "primaryEnergySource": "GAS",
- "efficiencyClass": "A_PLUS",
- "releaseDate": "2023-05-24",
- "validUntil": "2023-05-28",
- "yearOfConstructionBuilding": 0,
- "yearOfConstructionHeating": 0,
- "overallEnergyNeed": 0,
- "primaryEnergyNeed": 0,
- "electricityNeed": 0,
- "heatingNeed": 0,
- "overallEnergyConsumption": 0,
- "primaryEnergyConsumption": 0,
- "isWaterHeatingIncluded": true,
- "electricityConsumption": 0,
- "heatingConsumption": 0,
- "energyConsumptionIndicator": 0
}
], - "houseEnergyStandardType": "ENERGY_EFFICIENT_40",
- "primaryEnergySource": "string"
}
}
}, - "features": {
- "accessibleFromStreet": "YES",
- "aircondition": "YES",
- "entranceHall": "YES",
- "floorCovering": {
- "tiles": "YES",
- "stone": "YES",
- "carpet": "YES",
- "parquet": "YES",
- "laminate": "YES",
- "synthetic": "YES",
- "screed": "YES",
- "linoleum": "YES",
- "marble": "YES",
- "terracotta": "YES",
- "granite": "YES",
- "raisedFloor": "YES",
- "quartz": "YES",
- "concrete": "YES",
- "antiDustConcrete": "YES",
- "woodenPlank": "YES",
- "antiStatic": "YES",
- "vinyl": "YES"
}, - "furnished": "PART",
- "garden": {
- "part": true,
- "private": true,
- "shared": true
}, - "gym": "YES",
- "internet": {
- "internetSpeedMbit": 100,
- "internetAvailability": {
- "opticalFiber": false,
- "dsl": true,
- "cable": false,
- "satellite": false
}, - "propertyInternetAccess": {
- "ethernet": false,
- "wireless": true
}
}, - "lighting": {
- "ceiling": "YES",
- "led": "YES",
- "window": "YES"
}, - "mezzanine": "YES",
- "propertyOrientation": "NORTH",
- "receptionist": "YES",
- "security": {
- "buildingIntercom": "YES",
- "cam": "YES",
- "custodian": "YES",
- "custodianRoom": "YES",
- "digitalLock": "YES",
- "emergencyCall": "YES",
- "fireSprinkler": "YES",
- "fireAlarm": "YES",
- "intruderAlarm": "YES",
- "reinforcedDoor": "YES",
- "safe": "YES"
}, - "wheelchairUse": "YES",
- "wineCellar": "YES",
- "residential": {
- "assistedLiving": "YES",
- "chimney": "YES",
- "flatSharePossible": "YES",
- "hammam": "YES",
- "houseCleaningService": "YES",
- "jacuzzi": "YES",
- "loggia": "YES",
- "sauna": "YES",
- "swimmingPool": "YES",
- "tennisField": "YES",
- "tv": "SAT",
- "veranda": "YES",
- "laundryRoom": "YES",
- "countrySpecific": {
- "fr": {
- "evacuation": "ALL_SEWER"
}
}
}, - "commercial": {
- "accessibleByTrucks": "YES",
- "auditorium": "YES",
- "bar": "YES",
- "buildingVentilation": "YES",
- "cafeteria": "YES",
- "coldStore": "YES",
- "companyRestaurant": "YES",
- "droppedCeiling": "YES",
- "engineGenerator": "YES",
- "exhaustHood": "YES",
- "flexibleRoomLayout": "YES",
- "heatedTerrace": "YES",
- "liftingPlatform": "YES",
- "numberOfStorageCells": 999999,
- "overheadCrane": "YES",
- "restaurantSeats": 999999,
- "restaurantSeatsOutside": 999999,
- "teaKitchen": "YES",
- "truckManeuveringArea": "YES",
- "verticalSlidingDoor": "YES",
- "wallSiding": "YES",
- "countrySpecific": {
- "fr": {
- "licenseType": "PETITE_LICENCE_RESTAURANT"
}
}
}, - "parking": {
- "chargingStation": "YES",
- "bikeParking": "YES"
}, - "plot": {
- "usageFor": {
- "futureDevelopmentLand": "YES",
- "twinhouse": "YES",
- "singleFamilyHouse": "YES",
- "terraceHouse": "YES",
- "apartmentBuilding": "YES",
- "orchard": "YES",
- "farmland": "YES",
- "parkingSpace": "YES",
- "garage": "YES",
- "noDevelopment": "YES"
}, - "developmentInfrastructure": {
- "districtHeating": "YES",
- "electric": "YES",
- "gas": "YES",
- "telco": "YES",
- "water": "YES"
}, - "shortTermConstructible": "YES",
- "brownfield": "YES",
- "buildingPermission": "YES",
- "demolitionSuggested": "YES",
- "fencedPlot": "YES",
- "isTerracedArea": true,
- "tilt": "NONE",
- "countrySpecific": {
- "de": {
- "buildingRules": "NEIGHBORHOOD_34",
- "siteDevelopmentState": "UNDEVELOPED"
}
}
}
}, - "structure": {
- "building": {
- "attic": "CONVERTED",
- "balconyDirection": "NORTH",
- "gardenOrientation": "NORTH",
- "barrierFree": "YES",
- "bath": {
- "shower": "YES",
- "bathtub": "YES",
- "window": "YES",
- "bidet": "YES",
- "urinal": "YES",
- "guestToilet": "YES",
- "separateBathAndToilet": "YES",
- "toilet": "YES",
- "bathroomSink": "YES"
}, - "cellar": "YES",
- "elevator": {
- "person": "YES",
- "freight": "NO"
}, - "kitchen": {
- "kitchenType": {
- "builtIn": true,
- "kitchenette": true,
- "open": true,
- "separated": true
}, - "kitchenEquipment": "NONE",
- "pantry": "YES",
- "singleStorey": "YES"
}, - "numberOfFloors": 1,
- "numberOfFacades": 1,
- "roomHeight": 3.2,
- "offeredFloors": 1,
- "roofStyle": "HALF_HIPPED_ROOF",
- "locationInBuilding": "GROUNDFLOOR",
- "locationAtCorner": "YES",
- "calm": "YES",
- "withView": {
- "courtyardView": true,
- "lakeView": true,
- "mountainView": true,
- "overlooking": true,
- "seaView": true,
- "skiView": true
}, - "luminous": "YES",
- "window": {
- "bayWindow": "YES",
- "blinds": "YES",
- "windowMaterial": {
- "woodenWindows": "YES",
- "aluminiumWindows": "YES",
- "muntinWindows": "YES",
- "plasticWindows": "YES",
- "insulatedGlazing": "YES"
}
}, - "shape": "L_SHAPE",
- "hasSplitFloor": true,
- "wallConstructionMaterial": [
- "MASSIVE_WOOD"
]
}, - "rooms": {
- "numberOfRooms": 2,
- "numberOfBedRooms": 1,
- "numberOfBathRooms": 1,
- "numberOfToilets": 1,
- "numberOfBalconies": 0,
- "numberOfTerraces": 1,
- "numberOfKitchens": 0,
- "numberOfUnits": 1
}, - "commercial": {
- "floorLoad": 0,
- "floorLoadUpperFloors": 0,
- "hallHeight": 2.9,
- "numberOfBeds": 1,
- "numberOfLoadingDocks": 999999,
- "numberOfDesks": 999999,
- "numberOfMeetingRooms": 999999,
- "numberOfOfficeRooms": 999999,
- "windowFront": 2.2
}, - "parkingLots": {
- "outside": 999999,
- "streetParking": 999999,
- "carport": 999999,
- "garage": 999999,
- "doubleGarage": 999999,
- "duplex": 999999,
- "garageArea": 999999,
- "parkingArea": 999999,
- "carPark": 999999,
- "underground": 999999,
- "boatDock": 999999
}
}, - "texts": {
- "headline": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "description": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "features": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "extendedInformation": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "area": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "management": {
- "isImmediatelyAvailable": true,
- "availableFrom": "2023-05-24",
- "availableUntil": "2023-05-24",
- "isForInvestment": true,
- "heritageProtected": "NOT_APPLICABLE",
- "marketStatus": "SOLD",
- "projectStatus": "BUILDING_PERMISSION",
- "marketLabel": "property of the week",
- "isRented": true,
- "useFor": "LIVING",
- "isForHolidayRental": true,
- "rent": {
- "favouredGender": "MALE",
- "minRentalTime": 1,
- "maxRentalTime": 3,
- "rentalTimeUnit": "YEAR",
- "certificateOfEligibilityNeeded": "YES",
- "maxPersons": 1,
- "nonSmoker": "NOT_APPLICABLE",
- "petsAllowed": "NOT_APPLICABLE",
- "isShortTimeRental": true
}, - "compulsoryAuction": {
- "auctionLocation": "string",
- "auctionSpace": "string",
- "cancellationDate": "2019-08-24",
- "coOwnership": "string",
- "countyCourt": "Berlin Charlottenburg",
- "dateOfAuction": "2023-05-24",
- "isDiscretionarySale": true,
- "distributionPlanNumber": "string",
- "fileReferenceAtCountyCourt": "string",
- "lastChangeDate": "2023-05-24",
- "insolvencyAdministrator": "string",
- "owner": "string",
- "recordationDate": "2019-08-24",
- "additionalDate": "2023-05-24",
- "isWithoutValueLimits": true,
- "isSplittingAuction": true
}
}, - "countrySpecific": {
- "de": { },
- "fr": {
- "business": {
- "isBusinessSold": true,
- "businessType": "LEISURE",
- "businessSubType": "BAKERY",
- "revenue": 100000,
- "revenueOneYearAgo": 100000,
- "revenueTwoYearsAgo": 100000,
- "revenueDetails": "Some information about the breakdown of the revenue",
- "netIncome": 100000,
- "netIncomeOneYearAgo": 100000,
- "netIncomeTwoYearsAgo": 100000,
- "isPartOfNetwork": true,
- "downPayment": 100000,
- "isNoNuisance": true,
- "isDivisible": false
}
}
}, - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}, - "links": {
}
}, - "metadata": {
- "source": {
- "offererMarketingKey": "HH-AH61a-WE15a-1",
- "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981",
- "offererEstateGroupId": "Group0815"
}, - "portalWebKey": "2rqww3y"
}, - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}, - "media": [
- {
- "externalMediaId": "B6A58E12-12D9-4F20-812F-AE2D6DAE8F99",
- "title": "Living room view"
}
]
}
}Updates a listing
| externalListingId required | string Example: 2592IWF02EC6 The Unique Identifier of the listing. Can be:
|
required | object (data) |
required | object (metadata) Metadata associated with the listing in the receiving platform |
Array of objects (userDefined) en=Area for extended Data, not expilitly defined. As ARRAY. Every item has name, value with a type and modus. modus can be free used i.e. for defining CRUD atrributes. ;de= Der Bereich für -User Defined Daten- z.B. zum bilateralen Austausch zwischen Partnern | |
Array of objects (mediaRequest) Array of media items to attach to the listing. | |
object (contact) |
{- "data": {
- "estateType": "HOUSE",
- "estateSubType": {
- "house": "SINGLE_FAMILY_HOUSE"
}, - "distributionType": "BUY",
- "location": {
- "postalcode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "unit": "Block C",
- "staircase": "A",
- "floorNumber": 2,
- "entrance": "123",
- "state": "Bavaria",
- "country": "DEU",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 13.405,
- 52.52
]
}, - "showAddress": true,
- "locationNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "prices": {
- "currency": "EUR",
- "buy": {
- "price": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isLeaseBuyCombi": true,
- "leasehold": {
- "isLeasehold": true,
- "amount": 120,
- "priceTimeUnit": "YEAR",
- "duration": 99,
- "endDate": "2023-05-24"
}, - "operatingCosts": {
- "priceTimeUnit": "DAY",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "rentalIncome": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "rentalIncomeExpect": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "isOperatingCostsIncluded": false,
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "yieldFactor": 12.5,
- "countrySpecific": {
- "fr": {
- "isReducedNotaryFees": true,
- "notaryFeesFor": "BUYER",
- "lifeAnnuity": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "at": {
- "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "vatCostsPerMonth": 0,
- "costsPerMonthGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "rent": {
- "baseRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "baseRentPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "totalRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "lease": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "operatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "heatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "isHeatingIncludedInOC": true,
- "isHeatingIncludedInTR": true,
- "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "pricePerSqUnitPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "priceTimeUnit": "MONTH",
- "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "depositNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "leaseRight": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "accessPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "overRegulatedRent": 225.6
}, - "at": {
- "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadVat": 0,
- "overallRentGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "rentNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "compulsoryAuction": {
- "auctionProceeds": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "biddingGuarantee": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "marketValue": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "minimumBid": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "buyAuction": {
- "minPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false
}, - "startOfferPhase": "2023-05-24",
- "endOfferPhase": "2023-05-24"
}, - "brokerageFee": {
- "isFeeIncluded": false,
- "feeFor": "BUYER_OR_TENANT",
- "feePercentage": 4.5,
- "hasFee": "YES",
- "feeNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
}, - "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "showPrice": true,
- "priceNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "taxRegime": "string",
- "residentialLeaseType": "string",
- "isPTZeligible": true,
- "taxReductionZone": "A"
}
}
}, - "spaces": {
- "spaceMeasureUnit": "SQUARE_METER",
- "buildingFront": 23,
- "kitchenSpace": 99999999,
- "overallSpace": 99999999,
- "usableFloorSpace": 99999999,
- "spaceMax": 99999999,
- "spaceMin": 99999999,
- "plotSpace": 99999999,
- "plotFront": 60,
- "additionalSpace": 99999999,
- "residential": {
- "livingSpace": 99999999,
- "livingRoomSpace": 99999999,
- "atticSpace": 99999999,
- "balconySpace": 99999999,
- "cellarSpace": 99999999,
- "gardenSpace": 99999999,
- "terraceSpace": 99999999
}, - "commercial": {
- "maxDivisible": 99999999,
- "minDivisible": 99999999,
- "commercialSpace": 99999999,
- "shopSpace": 99999999,
- "storageSpace": 99999999,
- "sellSpace": 99999999,
- "officeSpace": 99999999,
- "officePartSpace": 99999999,
- "managementSpace": 99999999,
- "restaurantSpace": 99999999,
- "countrySpecific": { }
}
}, - "conditions": {
- "buildState": "FIRST_TIME_USE",
- "ageState": "OLD",
- "lastModernisation": 2010,
- "constructionStyle": "PREFABRICATED",
- "yearOfConstruction": 2000
}, - "energy": {
- "energyType": {
- "heatMethod": "CENTRAL",
- "heatForm": {
- "air": true,
- "radiator": true,
- "stove": true,
- "underfloor": true,
- "wallCeiling": true
}, - "energySource": {
- "coal": true,
- "districtHeating": true,
- "electric": true,
- "gas": true,
- "geothermal": true,
- "liquidGas": true,
- "oil": true,
- "solarHeat": true,
- "solarPower": true,
- "wind": true,
- "wood": true,
- "woodPellet": true
}, - "energyGeneration": {
- "fossilburning": true,
- "heatpump": true,
- "combinedHeatAndPowerPlant": true
}, - "maxElectricalPower": 200
}, - "countrySpecific": {
- "de": {
- "energyCertificates": [
- {
- "nameOfCertificate": "string",
- "certificateType": "ENEV2014",
- "certificateBasedOn": "NEED",
- "isResidentialBuilding": true,
- "primaryEnergySource": "GAS",
- "efficiencyClass": "A_PLUS",
- "releaseDate": "2023-05-24",
- "validUntil": "2023-05-28",
- "yearOfConstructionBuilding": 0,
- "yearOfConstructionHeating": 0,
- "overallEnergyNeed": 0,
- "primaryEnergyNeed": 0,
- "electricityNeed": 0,
- "heatingNeed": 0,
- "overallEnergyConsumption": 0,
- "primaryEnergyConsumption": 0,
- "isWaterHeatingIncluded": true,
- "electricityConsumption": 0,
- "heatingConsumption": 0,
- "energyConsumptionIndicator": 0
}
], - "houseEnergyStandardType": "ENERGY_EFFICIENT_40",
- "primaryEnergySource": "string"
}
}
}, - "features": {
- "accessibleFromStreet": "YES",
- "aircondition": "YES",
- "entranceHall": "YES",
- "floorCovering": {
- "tiles": "YES",
- "stone": "YES",
- "carpet": "YES",
- "parquet": "YES",
- "laminate": "YES",
- "synthetic": "YES",
- "screed": "YES",
- "linoleum": "YES",
- "marble": "YES",
- "terracotta": "YES",
- "granite": "YES",
- "raisedFloor": "YES",
- "quartz": "YES",
- "concrete": "YES",
- "antiDustConcrete": "YES",
- "woodenPlank": "YES",
- "antiStatic": "YES",
- "vinyl": "YES"
}, - "furnished": "PART",
- "garden": {
- "part": true,
- "private": true,
- "shared": true
}, - "gym": "YES",
- "internet": {
- "internetSpeedMbit": 100,
- "internetAvailability": {
- "opticalFiber": false,
- "dsl": true,
- "cable": false,
- "satellite": false
}, - "propertyInternetAccess": {
- "ethernet": false,
- "wireless": true
}
}, - "lighting": {
- "ceiling": "YES",
- "led": "YES",
- "window": "YES"
}, - "mezzanine": "YES",
- "propertyOrientation": "NORTH",
- "receptionist": "YES",
- "security": {
- "buildingIntercom": "YES",
- "cam": "YES",
- "custodian": "YES",
- "custodianRoom": "YES",
- "digitalLock": "YES",
- "emergencyCall": "YES",
- "fireSprinkler": "YES",
- "fireAlarm": "YES",
- "intruderAlarm": "YES",
- "reinforcedDoor": "YES",
- "safe": "YES"
}, - "wheelchairUse": "YES",
- "wineCellar": "YES",
- "residential": {
- "assistedLiving": "YES",
- "chimney": "YES",
- "flatSharePossible": "YES",
- "hammam": "YES",
- "houseCleaningService": "YES",
- "jacuzzi": "YES",
- "loggia": "YES",
- "sauna": "YES",
- "swimmingPool": "YES",
- "tennisField": "YES",
- "tv": "SAT",
- "veranda": "YES",
- "laundryRoom": "YES",
- "countrySpecific": {
- "fr": {
- "evacuation": "ALL_SEWER"
}
}
}, - "commercial": {
- "accessibleByTrucks": "YES",
- "auditorium": "YES",
- "bar": "YES",
- "buildingVentilation": "YES",
- "cafeteria": "YES",
- "coldStore": "YES",
- "companyRestaurant": "YES",
- "droppedCeiling": "YES",
- "engineGenerator": "YES",
- "exhaustHood": "YES",
- "flexibleRoomLayout": "YES",
- "heatedTerrace": "YES",
- "liftingPlatform": "YES",
- "numberOfStorageCells": 999999,
- "overheadCrane": "YES",
- "restaurantSeats": 999999,
- "restaurantSeatsOutside": 999999,
- "teaKitchen": "YES",
- "truckManeuveringArea": "YES",
- "verticalSlidingDoor": "YES",
- "wallSiding": "YES",
- "countrySpecific": {
- "fr": {
- "licenseType": "PETITE_LICENCE_RESTAURANT"
}
}
}, - "parking": {
- "chargingStation": "YES",
- "bikeParking": "YES"
}, - "plot": {
- "usageFor": {
- "futureDevelopmentLand": "YES",
- "twinhouse": "YES",
- "singleFamilyHouse": "YES",
- "terraceHouse": "YES",
- "apartmentBuilding": "YES",
- "orchard": "YES",
- "farmland": "YES",
- "parkingSpace": "YES",
- "garage": "YES",
- "noDevelopment": "YES"
}, - "developmentInfrastructure": {
- "districtHeating": "YES",
- "electric": "YES",
- "gas": "YES",
- "telco": "YES",
- "water": "YES"
}, - "shortTermConstructible": "YES",
- "brownfield": "YES",
- "buildingPermission": "YES",
- "demolitionSuggested": "YES",
- "fencedPlot": "YES",
- "isTerracedArea": true,
- "tilt": "NONE",
- "countrySpecific": {
- "de": {
- "buildingRules": "NEIGHBORHOOD_34",
- "siteDevelopmentState": "UNDEVELOPED"
}
}
}
}, - "structure": {
- "building": {
- "attic": "CONVERTED",
- "balconyDirection": "NORTH",
- "gardenOrientation": "NORTH",
- "barrierFree": "YES",
- "bath": {
- "shower": "YES",
- "bathtub": "YES",
- "window": "YES",
- "bidet": "YES",
- "urinal": "YES",
- "guestToilet": "YES",
- "separateBathAndToilet": "YES",
- "toilet": "YES",
- "bathroomSink": "YES"
}, - "cellar": "YES",
- "elevator": {
- "person": "YES",
- "freight": "NO"
}, - "kitchen": {
- "kitchenType": {
- "builtIn": true,
- "kitchenette": true,
- "open": true,
- "separated": true
}, - "kitchenEquipment": "NONE",
- "pantry": "YES",
- "singleStorey": "YES"
}, - "numberOfFloors": 1,
- "numberOfFacades": 1,
- "roomHeight": 3.2,
- "offeredFloors": 1,
- "roofStyle": "HALF_HIPPED_ROOF",
- "locationInBuilding": "GROUNDFLOOR",
- "locationAtCorner": "YES",
- "calm": "YES",
- "withView": {
- "courtyardView": true,
- "lakeView": true,
- "mountainView": true,
- "overlooking": true,
- "seaView": true,
- "skiView": true
}, - "luminous": "YES",
- "window": {
- "bayWindow": "YES",
- "blinds": "YES",
- "windowMaterial": {
- "woodenWindows": "YES",
- "aluminiumWindows": "YES",
- "muntinWindows": "YES",
- "plasticWindows": "YES",
- "insulatedGlazing": "YES"
}
}, - "shape": "L_SHAPE",
- "hasSplitFloor": true,
- "wallConstructionMaterial": [
- "MASSIVE_WOOD"
]
}, - "rooms": {
- "numberOfRooms": 2,
- "numberOfBedRooms": 1,
- "numberOfBathRooms": 1,
- "numberOfToilets": 1,
- "numberOfBalconies": 0,
- "numberOfTerraces": 1,
- "numberOfKitchens": 0,
- "numberOfUnits": 1
}, - "commercial": {
- "floorLoad": 0,
- "floorLoadUpperFloors": 0,
- "hallHeight": 2.9,
- "numberOfBeds": 1,
- "numberOfLoadingDocks": 999999,
- "numberOfDesks": 999999,
- "numberOfMeetingRooms": 999999,
- "numberOfOfficeRooms": 999999,
- "windowFront": 2.2
}, - "parkingLots": {
- "outside": 999999,
- "streetParking": 999999,
- "carport": 999999,
- "garage": 999999,
- "doubleGarage": 999999,
- "duplex": 999999,
- "garageArea": 999999,
- "parkingArea": 999999,
- "carPark": 999999,
- "underground": 999999,
- "boatDock": 999999
}
}, - "texts": {
- "headline": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "description": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "features": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "extendedInformation": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "area": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "management": {
- "isImmediatelyAvailable": true,
- "availableFrom": "2023-05-24",
- "availableUntil": "2023-05-24",
- "isForInvestment": true,
- "heritageProtected": "NOT_APPLICABLE",
- "marketStatus": "SOLD",
- "projectStatus": "BUILDING_PERMISSION",
- "marketLabel": "property of the week",
- "isRented": true,
- "useFor": "LIVING",
- "isForHolidayRental": true,
- "rent": {
- "favouredGender": "MALE",
- "minRentalTime": 1,
- "maxRentalTime": 3,
- "rentalTimeUnit": "YEAR",
- "certificateOfEligibilityNeeded": "YES",
- "maxPersons": 1,
- "nonSmoker": "NOT_APPLICABLE",
- "petsAllowed": "NOT_APPLICABLE",
- "isShortTimeRental": true
}, - "compulsoryAuction": {
- "auctionLocation": "string",
- "auctionSpace": "string",
- "cancellationDate": "2019-08-24",
- "coOwnership": "string",
- "countyCourt": "Berlin Charlottenburg",
- "dateOfAuction": "2023-05-24",
- "isDiscretionarySale": true,
- "distributionPlanNumber": "string",
- "fileReferenceAtCountyCourt": "string",
- "lastChangeDate": "2023-05-24",
- "insolvencyAdministrator": "string",
- "owner": "string",
- "recordationDate": "2019-08-24",
- "additionalDate": "2023-05-24",
- "isWithoutValueLimits": true,
- "isSplittingAuction": true
}
}, - "countrySpecific": {
- "de": { },
- "fr": {
- "business": {
- "isBusinessSold": true,
- "businessType": "LEISURE",
- "businessSubType": "BAKERY",
- "revenue": 100000,
- "revenueOneYearAgo": 100000,
- "revenueTwoYearsAgo": 100000,
- "revenueDetails": "Some information about the breakdown of the revenue",
- "netIncome": 100000,
- "netIncomeOneYearAgo": 100000,
- "netIncomeTwoYearsAgo": 100000,
- "isPartOfNetwork": true,
- "downPayment": 100000,
- "isNoNuisance": true,
- "isDivisible": false
}
}
}, - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}, - "links": {
}
}, - "metadata": {
- "source": {
- "offererMarketingKey": "HH-AH61a-WE15a-1",
- "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981",
- "offererEstateGroupId": "Group0815"
}, - "portalWebKey": "2rqww3y"
}, - "userDefined": [
- {
- "name": "string",
- "value": "string",
- "utyp": "string",
- "modus": "readonly"
}
], - "media": [
- {
- "externalMediaId": "B6A58E12-12D9-4F20-812F-AE2D6DAE8F99",
- "title": "Living room view"
}
], - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}
}{- "requestId": "0196106c-409b-7fg4-a317-db7393a36b77",
- "listingId": "a1b2c3d4-e5f6-4789-b0a1-c2d3e4f5a6b7",
- "externalListingId": "offererEstateId123",
- "warnings": [
- {
- "type": "LOCATION_IMPRECISE",
- "message": "The location for the listing/project is not precise enough. The listing/project may not be accurately represented on the map."
}
]
}Deletes a listing
| externalListingId required | string Example: 2592IW-F02EC6 The Unique Identifier of the listing. Can be:
|
{- "requestId": "0196106c-409b-7fg4-a317-db7393a36b77",
- "listingId": "a1b2c3d4-e5f6-4789-b0a1-c2d3e4f5a6b7",
- "externalListingId": "offererEstateId123"
}Request a presigned URL to upload a media file to the system. The presigned URL is valid for 60 seconds. During this time:
If these conditions are not met, the media will be automatically deleted. Supported media types include images, videos, and other multimedia content. Note: The maximum file size allowed is 40MB.
| externalMediaId required | string non-empty The ID of the media into the software |
| fileName required | string non-empty .*\S.* The name of the media file. |
{- "externalMediaId": "media_01",
- "fileName": "my_media.jpg"
}{- "externalMediaId": "string",
}{- "type": "/components/schemas/internalServerErrorResponse",
- "status": 500,
- "title": "Internal server error",
- "detail": "Something went wrong, please try again later or if the problem persists please contact the support with the instance id",
- "instance": "00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01"
}required | object (data) |
required | object (metadata) Metadata associated with the listing in the receiving platform |
Array of objects (userDefined) en=Area for extended Data, not expilitly defined. As ARRAY. Every item has name, value with a type and modus. modus can be free used i.e. for defining CRUD atrributes. ;de= Der Bereich für -User Defined Daten- z.B. zum bilateralen Austausch zwischen Partnern | |
Array of objects (mediaRequest) Array of media items to attach to the listing. | |
object (contact) |
{- "data": {
- "estateType": "HOUSE",
- "estateSubType": {
- "house": "SINGLE_FAMILY_HOUSE"
}, - "distributionType": "BUY",
- "location": {
- "postalcode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "unit": "Block C",
- "staircase": "A",
- "floorNumber": 2,
- "entrance": "123",
- "state": "Bavaria",
- "country": "DEU",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 13.405,
- 52.52
]
}, - "showAddress": true,
- "locationNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "prices": {
- "currency": "EUR",
- "buy": {
- "price": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isLeaseBuyCombi": true,
- "leasehold": {
- "isLeasehold": true,
- "amount": 120,
- "priceTimeUnit": "YEAR",
- "duration": 99,
- "endDate": "2023-05-24"
}, - "operatingCosts": {
- "priceTimeUnit": "DAY",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "rentalIncome": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "rentalIncomeExpect": {
- "priceTimeUnit": "YEAR",
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "isOperatingCostsIncluded": false,
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "yieldFactor": 12.5,
- "countrySpecific": {
- "fr": {
- "isReducedNotaryFees": true,
- "notaryFeesFor": "BUYER",
- "lifeAnnuity": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "at": {
- "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "vatCostsPerMonth": 0,
- "costsPerMonthGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "rent": {
- "baseRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "baseRentPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "totalRent": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "lease": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "operatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "heatingCosts": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "accounting": "ADJUSTMENT"
}, - "isHeatingIncludedInOC": true,
- "isHeatingIncludedInTR": true,
- "pricePerSqUnit": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "pricePerSqUnitPerYear": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "priceTimeUnit": "MONTH",
- "isParkingPriceIncluded": true,
- "parkingPrices": [
- {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND",
- "parkingStyle": "GARAGE"
}
], - "depositNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "leaseRight": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "accessPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "overRegulatedRent": 225.6
}, - "at": {
- "heatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "miscCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "operatingCostsNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "overallLoadVat": 0,
- "overallRentGross": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "rentNet": {
- "amount": 0,
- "priceInformation": {
- "priceInformation": "PRICE_ON_DEMAND"
}
}
}
}
}, - "compulsoryAuction": {
- "auctionProceeds": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "biddingGuarantee": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "marketValue": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "minimumBid": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}
}, - "buyAuction": {
- "minPrice": {
- "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false
}, - "startOfferPhase": "2023-05-24",
- "endOfferPhase": "2023-05-24"
}, - "brokerageFee": {
- "isFeeIncluded": false,
- "feeFor": "BUYER_OR_TENANT",
- "feePercentage": 4.5,
- "hasFee": "YES",
- "feeNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
}, - "amount": 950,
- "vatValue": 1000,
- "vatPercent": 19.6,
- "isVatIncluded": false,
- "priceInformation": "PRICE_ON_DEMAND"
}, - "showPrice": true,
- "priceNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "countrySpecific": {
- "fr": {
- "taxRegime": "string",
- "residentialLeaseType": "string",
- "isPTZeligible": true,
- "taxReductionZone": "A"
}
}
}, - "spaces": {
- "spaceMeasureUnit": "SQUARE_METER",
- "buildingFront": 23,
- "kitchenSpace": 99999999,
- "overallSpace": 99999999,
- "usableFloorSpace": 99999999,
- "spaceMax": 99999999,
- "spaceMin": 99999999,
- "plotSpace": 99999999,
- "plotFront": 60,
- "additionalSpace": 99999999,
- "residential": {
- "livingSpace": 99999999,
- "livingRoomSpace": 99999999,
- "atticSpace": 99999999,
- "balconySpace": 99999999,
- "cellarSpace": 99999999,
- "gardenSpace": 99999999,
- "terraceSpace": 99999999
}, - "commercial": {
- "maxDivisible": 99999999,
- "minDivisible": 99999999,
- "commercialSpace": 99999999,
- "shopSpace": 99999999,
- "storageSpace": 99999999,
- "sellSpace": 99999999,
- "officeSpace": 99999999,
- "officePartSpace": 99999999,
- "managementSpace": 99999999,
- "restaurantSpace": 99999999,
- "countrySpecific": { }
}
}, - "conditions": {
- "buildState": "FIRST_TIME_USE",
- "ageState": "OLD",
- "lastModernisation": 2010,
- "constructionStyle": "PREFABRICATED",
- "yearOfConstruction": 2000
}, - "energy": {
- "energyType": {
- "heatMethod": "CENTRAL",
- "heatForm": {
- "air": true,
- "radiator": true,
- "stove": true,
- "underfloor": true,
- "wallCeiling": true
}, - "energySource": {
- "coal": true,
- "districtHeating": true,
- "electric": true,
- "gas": true,
- "geothermal": true,
- "liquidGas": true,
- "oil": true,
- "solarHeat": true,
- "solarPower": true,
- "wind": true,
- "wood": true,
- "woodPellet": true
}, - "energyGeneration": {
- "fossilburning": true,
- "heatpump": true,
- "combinedHeatAndPowerPlant": true
}, - "maxElectricalPower": 200
}, - "countrySpecific": {
- "de": {
- "energyCertificates": [
- {
- "nameOfCertificate": "string",
- "certificateType": "ENEV2014",
- "certificateBasedOn": "NEED",
- "isResidentialBuilding": true,
- "primaryEnergySource": "GAS",
- "efficiencyClass": "A_PLUS",
- "releaseDate": "2023-05-24",
- "validUntil": "2023-05-28",
- "yearOfConstructionBuilding": 0,
- "yearOfConstructionHeating": 0,
- "overallEnergyNeed": 0,
- "primaryEnergyNeed": 0,
- "electricityNeed": 0,
- "heatingNeed": 0,
- "overallEnergyConsumption": 0,
- "primaryEnergyConsumption": 0,
- "isWaterHeatingIncluded": true,
- "electricityConsumption": 0,
- "heatingConsumption": 0,
- "energyConsumptionIndicator": 0
}
], - "houseEnergyStandardType": "ENERGY_EFFICIENT_40",
- "primaryEnergySource": "string"
}
}
}, - "features": {
- "accessibleFromStreet": "YES",
- "aircondition": "YES",
- "entranceHall": "YES",
- "floorCovering": {
- "tiles": "YES",
- "stone": "YES",
- "carpet": "YES",
- "parquet": "YES",
- "laminate": "YES",
- "synthetic": "YES",
- "screed": "YES",
- "linoleum": "YES",
- "marble": "YES",
- "terracotta": "YES",
- "granite": "YES",
- "raisedFloor": "YES",
- "quartz": "YES",
- "concrete": "YES",
- "antiDustConcrete": "YES",
- "woodenPlank": "YES",
- "antiStatic": "YES",
- "vinyl": "YES"
}, - "furnished": "PART",
- "garden": {
- "part": true,
- "private": true,
- "shared": true
}, - "gym": "YES",
- "internet": {
- "internetSpeedMbit": 100,
- "internetAvailability": {
- "opticalFiber": false,
- "dsl": true,
- "cable": false,
- "satellite": false
}, - "propertyInternetAccess": {
- "ethernet": false,
- "wireless": true
}
}, - "lighting": {
- "ceiling": "YES",
- "led": "YES",
- "window": "YES"
}, - "mezzanine": "YES",
- "propertyOrientation": "NORTH",
- "receptionist": "YES",
- "security": {
- "buildingIntercom": "YES",
- "cam": "YES",
- "custodian": "YES",
- "custodianRoom": "YES",
- "digitalLock": "YES",
- "emergencyCall": "YES",
- "fireSprinkler": "YES",
- "fireAlarm": "YES",
- "intruderAlarm": "YES",
- "reinforcedDoor": "YES",
- "safe": "YES"
}, - "wheelchairUse": "YES",
- "wineCellar": "YES",
- "residential": {
- "assistedLiving": "YES",
- "chimney": "YES",
- "flatSharePossible": "YES",
- "hammam": "YES",
- "houseCleaningService": "YES",
- "jacuzzi": "YES",
- "loggia": "YES",
- "sauna": "YES",
- "swimmingPool": "YES",
- "tennisField": "YES",
- "tv": "SAT",
- "veranda": "YES",
- "laundryRoom": "YES",
- "countrySpecific": {
- "fr": {
- "evacuation": "ALL_SEWER"
}
}
}, - "commercial": {
- "accessibleByTrucks": "YES",
- "auditorium": "YES",
- "bar": "YES",
- "buildingVentilation": "YES",
- "cafeteria": "YES",
- "coldStore": "YES",
- "companyRestaurant": "YES",
- "droppedCeiling": "YES",
- "engineGenerator": "YES",
- "exhaustHood": "YES",
- "flexibleRoomLayout": "YES",
- "heatedTerrace": "YES",
- "liftingPlatform": "YES",
- "numberOfStorageCells": 999999,
- "overheadCrane": "YES",
- "restaurantSeats": 999999,
- "restaurantSeatsOutside": 999999,
- "teaKitchen": "YES",
- "truckManeuveringArea": "YES",
- "verticalSlidingDoor": "YES",
- "wallSiding": "YES",
- "countrySpecific": {
- "fr": {
- "licenseType": "PETITE_LICENCE_RESTAURANT"
}
}
}, - "parking": {
- "chargingStation": "YES",
- "bikeParking": "YES"
}, - "plot": {
- "usageFor": {
- "futureDevelopmentLand": "YES",
- "twinhouse": "YES",
- "singleFamilyHouse": "YES",
- "terraceHouse": "YES",
- "apartmentBuilding": "YES",
- "orchard": "YES",
- "farmland": "YES",
- "parkingSpace": "YES",
- "garage": "YES",
- "noDevelopment": "YES"
}, - "developmentInfrastructure": {
- "districtHeating": "YES",
- "electric": "YES",
- "gas": "YES",
- "telco": "YES",
- "water": "YES"
}, - "shortTermConstructible": "YES",
- "brownfield": "YES",
- "buildingPermission": "YES",
- "demolitionSuggested": "YES",
- "fencedPlot": "YES",
- "isTerracedArea": true,
- "tilt": "NONE",
- "countrySpecific": {
- "de": {
- "buildingRules": "NEIGHBORHOOD_34",
- "siteDevelopmentState": "UNDEVELOPED"
}
}
}
}, - "structure": {
- "building": {
- "attic": "CONVERTED",
- "balconyDirection": "NORTH",
- "gardenOrientation": "NORTH",
- "barrierFree": "YES",
- "bath": {
- "shower": "YES",
- "bathtub": "YES",
- "window": "YES",
- "bidet": "YES",
- "urinal": "YES",
- "guestToilet": "YES",
- "separateBathAndToilet": "YES",
- "toilet": "YES",
- "bathroomSink": "YES"
}, - "cellar": "YES",
- "elevator": {
- "person": "YES",
- "freight": "NO"
}, - "kitchen": {
- "kitchenType": {
- "builtIn": true,
- "kitchenette": true,
- "open": true,
- "separated": true
}, - "kitchenEquipment": "NONE",
- "pantry": "YES",
- "singleStorey": "YES"
}, - "numberOfFloors": 1,
- "numberOfFacades": 1,
- "roomHeight": 3.2,
- "offeredFloors": 1,
- "roofStyle": "HALF_HIPPED_ROOF",
- "locationInBuilding": "GROUNDFLOOR",
- "locationAtCorner": "YES",
- "calm": "YES",
- "withView": {
- "courtyardView": true,
- "lakeView": true,
- "mountainView": true,
- "overlooking": true,
- "seaView": true,
- "skiView": true
}, - "luminous": "YES",
- "window": {
- "bayWindow": "YES",
- "blinds": "YES",
- "windowMaterial": {
- "woodenWindows": "YES",
- "aluminiumWindows": "YES",
- "muntinWindows": "YES",
- "plasticWindows": "YES",
- "insulatedGlazing": "YES"
}
}, - "shape": "L_SHAPE",
- "hasSplitFloor": true,
- "wallConstructionMaterial": [
- "MASSIVE_WOOD"
]
}, - "rooms": {
- "numberOfRooms": 2,
- "numberOfBedRooms": 1,
- "numberOfBathRooms": 1,
- "numberOfToilets": 1,
- "numberOfBalconies": 0,
- "numberOfTerraces": 1,
- "numberOfKitchens": 0,
- "numberOfUnits": 1
}, - "commercial": {
- "floorLoad": 0,
- "floorLoadUpperFloors": 0,
- "hallHeight": 2.9,
- "numberOfBeds": 1,
- "numberOfLoadingDocks": 999999,
- "numberOfDesks": 999999,
- "numberOfMeetingRooms": 999999,
- "numberOfOfficeRooms": 999999,
- "windowFront": 2.2
}, - "parkingLots": {
- "outside": 999999,
- "streetParking": 999999,
- "carport": 999999,
- "garage": 999999,
- "doubleGarage": 999999,
- "duplex": 999999,
- "garageArea": 999999,
- "parkingArea": 999999,
- "carPark": 999999,
- "underground": 999999,
- "boatDock": 999999
}
}, - "texts": {
- "headline": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "description": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "features": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "extendedInformation": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "area": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}
}, - "management": {
- "isImmediatelyAvailable": true,
- "availableFrom": "2023-05-24",
- "availableUntil": "2023-05-24",
- "isForInvestment": true,
- "heritageProtected": "NOT_APPLICABLE",
- "marketStatus": "SOLD",
- "projectStatus": "BUILDING_PERMISSION",
- "marketLabel": "property of the week",
- "isRented": true,
- "useFor": "LIVING",
- "isForHolidayRental": true,
- "rent": {
- "favouredGender": "MALE",
- "minRentalTime": 1,
- "maxRentalTime": 3,
- "rentalTimeUnit": "YEAR",
- "certificateOfEligibilityNeeded": "YES",
- "maxPersons": 1,
- "nonSmoker": "NOT_APPLICABLE",
- "petsAllowed": "NOT_APPLICABLE",
- "isShortTimeRental": true
}, - "compulsoryAuction": {
- "auctionLocation": "string",
- "auctionSpace": "string",
- "cancellationDate": "2019-08-24",
- "coOwnership": "string",
- "countyCourt": "Berlin Charlottenburg",
- "dateOfAuction": "2023-05-24",
- "isDiscretionarySale": true,
- "distributionPlanNumber": "string",
- "fileReferenceAtCountyCourt": "string",
- "lastChangeDate": "2023-05-24",
- "insolvencyAdministrator": "string",
- "owner": "string",
- "recordationDate": "2019-08-24",
- "additionalDate": "2023-05-24",
- "isWithoutValueLimits": true,
- "isSplittingAuction": true
}
}, - "countrySpecific": {
- "de": { },
- "fr": {
- "business": {
- "isBusinessSold": true,
- "businessType": "LEISURE",
- "businessSubType": "BAKERY",
- "revenue": 100000,
- "revenueOneYearAgo": 100000,
- "revenueTwoYearsAgo": 100000,
- "revenueDetails": "Some information about the breakdown of the revenue",
- "netIncome": 100000,
- "netIncomeOneYearAgo": 100000,
- "netIncomeTwoYearsAgo": 100000,
- "isPartOfNetwork": true,
- "downPayment": 100000,
- "isNoNuisance": true,
- "isDivisible": false
}
}
}, - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}, - "links": {
}
}, - "metadata": {
- "source": {
- "offererMarketingKey": "HH-AH61a-WE15a-1",
- "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981",
- "offererEstateGroupId": "Group0815"
}, - "portalWebKey": "2rqww3y"
}, - "userDefined": [
- {
- "name": "string",
- "value": "string",
- "utyp": "string",
- "modus": "readonly"
}
], - "media": [
- {
- "externalMediaId": "B6A58E12-12D9-4F20-812F-AE2D6DAE8F99",
- "title": "Living room view"
}
], - "contact": {
- "salutation": "Mr",
- "firstName": "John",
- "lastName": "Doe",
- "name": "Mr John DOE",
- "emailAddress": "john.doe@johndoe.com",
- "phoneNumber": 4915165500000,
- "mobilePhoneNumber": 4965165500000,
- "postalCode": "22455",
- "city": "Hamburg",
- "street": "Hauptstrasse",
- "houseNumber": "10",
- "country": "DEU",
- "preferredContactType": "BY_EMAIL",
- "contactNote": {
- "de": "Hallo!",
- "en": "Hello!",
- "fr": "Bonjour!",
- "nl": "Hallo!"
}, - "displayedInformation": {
- "mainContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}, - "additionalContactPerson": {
- "name": true,
- "phone": true,
- "mobilePhone": true,
- "email": true,
- "address": true,
- "companyName": true,
- "fax": true
}
}
}
}| externalMediaId required | string non-empty The ID of the media into the software |
| fileName required | string non-empty .*\S.* The name of the media file. |
{- "externalMediaId": "media_01",
- "fileName": "my_media.jpg"
}| type required | string The URI reference that identifies the problem type. The "about:blank" URI, when used as a problem type, indicates that the problem has no additional semantics beyond that of the HTTP status code. |
| status required | number The HTTP status code generated for this occurrence of the problem |
| title required | string A human-readable summary of the problem type |
| detail required | string A human-readable explanation specific to this occurrence of the problem |
| instance required | string A URI reference that identifies the specific occurrence of the problem |
| errorSource | string The source of the error |
{- "type": "/components/schemas/validationContentTypeErrorResponse",
- "status": 400,
- "title": "Bad Request",
- "detail": "Request content type is not application/json; charset=utf-8",
- "instance": "00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01",
- "errorSource": "headers"
}