Collapse Drawer
    Expand Drawer

    PropertyUnitTypes

    GET

    /trestle/odata/PropertyUnitTypes

    GET

    /trestle/rets/search?SearchType=PropertyUnitTypes&Class=PropertyUnitTypes

    info icon

    UnitTypeKey is the primary key and uniquely identifies records in the PropertyUnitTypes resource.

    info icon

    The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time: ListingId, ListingKey, ModificationTimestamp, UnitTypeKey.

    Fields

    Field Type Size Description
    HumanModifiedYN Boolean
    ListAgentKey String 255
    ListOfficeKey String
    ListingId InKey String 255 This is the foreign ID relating to the Property Resource. The well known identifier for the listing. The value may be identical to that of the Listing Key, but the Listing ID is intended to be the value used by a human to retrieve the information about a specific listing. In a multiple originating system or a merged system, this value may not be unique and may require the use of the provider system to create a synthetic unique value.
    ListingKey InKey String 255 This is the foreign key relating to the Property Resource. A unique identifier for this record from the immediate source. This is a string that can include URI or other forms. Alternatively use the ListingKeyNumeric for a numeric only key field. This is the local key of the system. When records are received from other systems, a local key is commonly applied. If conveying the original keys from the source or originating systems, see SourceSystemKey and OriginatingSystemKey.
    ListingKeyNumeric Int32 255 This is the foreign key relating to the property resource. A unique identifier for this record from the immediate source. This is the numeric only key and used as an alternative to the ListingKey fields. This is the local key of the system. When records are received from other systems, a local key is commonly applied. If conveying the original keys from the source or originating systems, see SourceSystemKey and OriginatingSystemKey.
    ModificationTimestamp InKey DateTimeOffset 27 Date/time this record was last modified.
    OriginatingSystemName String 255
    OriginatingSystemSubName String 255
    Permission Permission Enum
    PermissionPrivate String 255
    UnitTypeActualRent Decimal 14.2 The actual rent per month being collected for a given type of unit.
    UnitTypeActualRentRange String 50
    UnitTypeArea Decimal 14.2
    UnitTypeBathsTotal Int32 3 The total number of baths for a given type of unit.
    UnitTypeBedsTotal Int32 3 The total number of bedrooms for a given type of unit.
    UnitTypeDeposit Decimal 14.2
    UnitTypeDescription String 1024 A textual description of a given type of unit.
    UnitTypeFireplaceYN Boolean
    UnitTypeFurnished Furnished Enum The level of furnishing for a given type of unit. i.e. furnished, partial or unfurnished.
    UnitTypeGarageAttachedYN Boolean Does the given type of unit have an attached garage? Yes/No.
    UnitTypeGarageSpaces Decimal 14.2 The number of garage spaces included with the given type of unit.
    UnitTypeKey Key InKey String 255 A unique identifier for this record. This is a string that can include URI or other forms. Alternatively use the "...KeyNumeric" for a numeric only key field. This is the local key of the system.
    UnitTypeKeyNumeric Int32 255 A unique identifier for this record. This is the numeric only key and used as an alternative to the string Key field. This is the local key of the system.
    UnitTypeLeaseExpires Date 10
    UnitTypeLeasedYN Boolean
    UnitTypeMonthToMonthYN Boolean
    UnitTypeNumFullBaths Int32
    UnitTypeNumHalfBaths Int32
    UnitTypeOccupantType UnitTypeOccupantType Enum
    UnitTypePetDeposit Decimal 14.2
    UnitTypePetDepositPerPetYN Boolean
    UnitTypeProForma Int32 6 The pro forma rent, or the expected rental income from the given type of unit. This may vary from actual rent which can be affected by factors other than current market value.
    UnitTypeTotalRent Decimal 14.2 The total actual rent is the sum of all rent being collected for all units of the given type. For example if you had 5 units of a particular type each collecting $1000, the total actual rent would be $5000.
    UnitTypeType UnitTypeType Enum A list of possible Unit Types. i.e. 1, 2, 3 or 2 Bed, Studio, Special Loft, etc.
    UnitTypeUnitNum String 255
    UnitTypeUnitsTotal Int32 3 The total number of units of the given type.

    Expands

    Name Target Description
    Property Property