@realestate/types/RESODataDictionaryV1_7/PropertyGreenVerification.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 { GreenBuildingVerificationType } from './GreenBuildingVerificationType';
import { Property } from './Property';
import { GreenVerificationSource } from './GreenVerificationSource';
import { GreenVerificationStatus } from './GreenVerificationStatus';
import { HistoryTransactional } from './HistoryTransactional';
export interface PropertyGreenVerification {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenBuildingVerificationKey+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.
   */
  GreenBuildingVerificationKey?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenBuildingVerificationType+%28PropertyGreenVerification%29+Field}
   *
   * The name of the verification or certification awarded to a new or pre-existing residential or commercial
   * structure. For example: LEED, Energy Star, ICC-700. In cases where more than one certification have been
   * awarded, leverage multiple iterations of the green verification fields via the repeating element method.
   */
  GreenBuildingVerificationType?: GreenBuildingVerificationType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationBody+Field}
   *
   * The name of the body or group providing the verification/certification/rating named in the
   * GreenBuildingVerificationType field. There is almost always a direct correlation between bodies and
   * programs.
   */
  GreenVerificationBody?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationMetric+Field}
   *
   * A final score indicating the performance of energy efficiency design and measures in the home as tested
   * by a third-party rater. Points achieved to earn a certification in the GreenVerificationRating field do
   * not apply to this field. HERS Index is most common with new homes and runs with a lower number being
   * more efficient. A net-zero home uses zero energy and has a HERS score of 0. A home that produces more
   * energy than it uses has a negative score. Home Energy Score is a tool more common for existing homes and
   * runs with a higher number being more efficient. It takes square footage into account and caps with 10
   * as the highest number of points.
   */
  GreenVerificationMetric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationRating+Field}
   *
   * Many verifications or certifications have a rating system that provides an indication of the structure's
   * level of energy efficiency. When expressed in a numeric value, please use the GreenVerificationMetric
   * field. Verifications and Certifications can also be a name, such as Gold or Silver, which is the purpose
   * of this field.
   */
  GreenVerificationRating?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationSource+Field}
   *
   * The source of the green data. May address photovoltaic characteristics, or a verified score,
   * certification, label, etc. This may be a pick list of options showing the source. i.e. Program Sponsor,
   * Program Verifier, Public Record, Assessor, etc.
   */
  GreenVerificationSource?: GreenVerificationSource;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationStatus+Field}
   *
   * Many verification programs include a multi-step process that may begin with plans and specs, involve
   * testing and/or submission of building specifications along the way and include a final verification step.
   * When ratings are involved it is not uncommon for the final rating to be either higher or lower than the
   * target preliminary rating. Sometimes the final approval is not available until after sale and occupancy.
   * Status indicates what the target was at the time of listing and may be updated when verification is
   * complete. To limit liability concerns this field reflects information that was available at the time of
   * listing or updated later and should be confirmed by the buyer.
   */
  GreenVerificationStatus?: GreenVerificationStatus;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationURL+Field}
   *
   * Provides a link to the specific property’s high-performance rating or scoring details directly from and
   * hosted by the sponsoring body of the program. Typically provides thorough details, for example, which
   * points where achieved and how, or in the case of a score what specifically was tested and the results.
   */
  GreenVerificationURL?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationVersion+Field}
   *
   * The version of the certification or verification that was awarded. Some rating programs have a year, a
   * version, or possibly both.
   */
  GreenVerificationVersion?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/GreenVerificationYear+Field}
   *
   * The year the certification or verification was awarded.
   */
  GreenVerificationYear?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28PropertyGreenVerification%29+Field}
   *
   * This is the foreign ID relating to the Property. 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+%28PropertyGreenVerification%29+Field}
   *
   * This is the foreign key relating to the Property. 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+%28PropertyGreenVerification%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+%28PropertyGreenVerification%29+Field}
   *
   * Date/time this record was last modified.
   */
  ModificationTimestamp?: Date;

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