@realestate/types/RESODataDictionaryV1_7/PropertyUnitTypes.d.ts

Types for real estate

/**
 * Copyright (c) 2023 ListBird. All Rights Reserved.
 *
 * This software product includes software or other works developed by RESO,
 * subject to the RESO End User License published at www.reso.org.
 *
 * Any modifications, derivative works, or redistributions of this source must
 * maintain this copyright notice. See the RESO EULA for more information.
 */
import { HistoryTransactional } from './HistoryTransactional';
import { UnitTypeFurnished } from './UnitTypeFurnished';
import { UnitTypeType } from './UnitTypeType';
import { Property } from './Property';
export interface PropertyUnitTypes {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28PropertyUnitTypes%29+Field}
   *
   * 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.
   */
  ListingId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKey+%28PropertyUnitTypes%29+Field}
   *
   * 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.
   */
  ListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKeyNumeric+%28PropertyUnitTypes%29+Field}
   *
   * 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.
   */
  ListingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28PropertyUnitTypes%29+Field}
   *
   * Date/time this record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeActualRent+Field}
   *
   * The actual rent per month being collected for a given type of unit.
   */
  UnitTypeActualRent?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeBathsTotal+Field}
   *
   * The total number of baths for a given type of unit.
   */
  UnitTypeBathsTotal?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeBedsTotal+Field}
   *
   * The total number of bedrooms for a given type of unit.
   */
  UnitTypeBedsTotal?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeDescription+Field}
   *
   * A textual description of a given type of unit.
   */
  UnitTypeDescription?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeFurnished+Field}
   *
   * The level of furnishing for a given type of unit. i.e. furnished, partial or unfurnished.
   */
  UnitTypeFurnished?: UnitTypeFurnished;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeGarageAttachedYN+Field}
   *
   * Does the given type of unit have an attached garage? Yes/No.
   */
  UnitTypeGarageAttachedYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeGarageSpaces+Field}
   *
   * The number of garage spaces included with the given type of unit.
   */
  UnitTypeGarageSpaces?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeKey+Field}
   *
   * 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.
   */
  UnitTypeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeKeyNumeric+Field}
   *
   * 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.
   */
  UnitTypeKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeProForma+Field}
   *
   * 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.
   */
  UnitTypeProForma?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeTotalRent+Field}
   *
   * 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.
   */
  UnitTypeTotalRent?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeType+%28PropertyUnitTypes%29+Field}
   *
   * A list of possible Unit Types. i.e. 1, 2, 3 or 2 Bed, Studio, Special Loft, etc.
   */
  UnitTypeType?: UnitTypeType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/UnitTypeUnitsTotal+Field}
   *
   * The total number of units of the given type.
   */
  UnitTypeUnitsTotal?: number;

  Listing?: Property;
  HistoryTransactional?: HistoryTransactional[];
}