Units

The Units entity stores details about each individual unit within a property. These units can be listed separately or grouped together under the property as a whole.

*Please note that this entity is in Beta.

Fields

Field	Type	Description
id	string	Identifier of the unit
propertyId	string	Identifier of the property associated with this unit
name	string	Name of the unit
description	string	Description of the unit
status	string	Listing status of the unit
quantity	number	Number of units of the same type
startPrice	number	Starting price of the unit when listed
currency	string	Currency used for pricing
maxOccupancy	number	Maximum Occupancy of the unit
rooms.bedroom.count	number	Number of bedrooms in the unit
rooms.bedroom.rooms.id	number	Identifier of the bedroom
rooms.bedroom.rooms.name	string	Name of the bedroom
rooms.bedroom.rooms.beds.type	string	BedType information of the bedroom.
rooms.bedroom.rooms.beds.count	string	No. of beds in the bedroom
rooms.bathroom.count	number	Number of bathrooms in the unit
rooms.bathroom.rooms.id	number	Identifier of the bathroom
rooms.bathroom.rooms.name	string	Name of the bathroom
amenities.id	number	Identifier of the amenity
amenities.name	string	Name of the amenity

---

Supported fields in each source system:

Field	Direct Software
id	✅
propertyId	✅
name	✅
description	✅
status	✅
quantity	-
startPrice	✅
currency	✅
maxOccupancy	✅
rooms.bedroom.count	✅
rooms.bedroom.rooms.id	🔜
rooms.bedroom.rooms.name	✅
rooms.bedroom.rooms.beds.type	🔜
rooms.bedroom.rooms.beds.count	🔜
rooms.bathroom.count	✅
rooms.bathroom.rooms.id	🔜
rooms.bathroom.rooms.name	✅
amenities.id	-
amenities.name	✅