@realestate/types
Version:
Types for real estate
1,357 lines (1,207 loc) • 171 kB
TypeScript
/**
* 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 { CoBuyerAgentDesignation } from './CoBuyerAgentDesignation';
import { Basement } from './Basement';
import { PropertyCondition } from './PropertyCondition';
import { BusinessType } from './BusinessType';
import { ChangeType } from './ChangeType';
import { ShowingDays } from './ShowingDays';
import { StructureType } from './StructureType';
import { BodyType } from './BodyType';
import { Roof } from './Roof';
import { DevelopmentStatus } from './DevelopmentStatus';
import { LaundryFeatures } from './LaundryFeatures';
import { Vegetation } from './Vegetation';
import { CoListAgentDesignation } from './CoListAgentDesignation';
import { RoadSurfaceType } from './RoadSurfaceType';
import { OUID } from './OUID';
import { MLSAreaMinor } from './MLSAreaMinor';
import { Levels } from './Levels';
import { OtherStructures } from './OtherStructures';
import { IrrigationSource } from './IrrigationSource';
import { OwnershipType } from './OwnershipType';
import { Sewer } from './Sewer';
import { Skirt } from './Skirt';
import { ListingTerms } from './ListingTerms';
import { GreenEnergyGeneration } from './GreenEnergyGeneration';
import { YearBuiltSource } from './YearBuiltSource';
import { LotSizeSource } from './LotSizeSource';
import { CurrentFinancing } from './CurrentFinancing';
import { SecurityFeatures } from './SecurityFeatures';
import { ListAgentDesignation } from './ListAgentDesignation';
import { MiddleOrJuniorSchool } from './MiddleOrJuniorSchool';
import { Possession } from './Possession';
import { PatioAndPorchFeatures } from './PatioAndPorchFeatures';
import { PoolFeatures } from './PoolFeatures';
import { FinancialDataSource } from './FinancialDataSource';
import { SocialMedia } from './SocialMedia';
import { PossibleUse } from './PossibleUse';
import { DoorFeatures } from './DoorFeatures';
import { Concessions } from './Concessions';
import { TenantPays } from './TenantPays';
import { View } from './View';
import { ElementarySchool } from './ElementarySchool';
import { UnitTypeType } from './UnitTypeType';
import { HoursDaysOfOperation } from './HoursDaysOfOperation';
import { WindowFeatures } from './WindowFeatures';
import { City } from './City';
import { LotDimensionsSource } from './LotDimensionsSource';
import { Appliances } from './Appliances';
import { ListingService } from './ListingService';
import { GreenWaterConservation } from './GreenWaterConservation';
import { HorseAmenities } from './HorseAmenities';
import { FrontageType } from './FrontageType';
import { ExistingLeaseType } from './ExistingLeaseType';
import { LeaseTerm } from './LeaseTerm';
import { Office } from './Office';
import { CompensationType } from './CompensationType';
import { AreaUnits } from './AreaUnits';
import { FeeFrequency } from './FeeFrequency';
import { LotFeatures } from './LotFeatures';
import { RoomType } from './RoomType';
import { OpenHouse } from './OpenHouse';
import { SpaFeatures } from './SpaFeatures';
import { TaxStatusCurrent } from './TaxStatusCurrent';
import { IncomeIncludes } from './IncomeIncludes';
import { ParkingFeatures } from './ParkingFeatures';
import { FireplaceFeatures } from './FireplaceFeatures';
import { RoadFrontageType } from './RoadFrontageType';
import { StandardStatus } from './StandardStatus';
import { Cooling } from './Cooling';
import { StreetSuffix } from './StreetSuffix';
import { Member } from './Member';
import { BuildingFeatures } from './BuildingFeatures';
import { SpecialListingConditions } from './SpecialListingConditions';
import { LinearUnits } from './LinearUnits';
import { CommonInterest } from './CommonInterest';
import { GreenEnergyEfficient } from './GreenEnergyEfficient';
import { AOR } from './AOR';
import { CommunityFeatures } from './CommunityFeatures';
import { DirectionFaces } from './DirectionFaces';
import { CurrentUse } from './CurrentUse';
import { LotSizeUnits } from './LotSizeUnits';
import { AccessibilityFeatures } from './AccessibilityFeatures';
import { Flooring } from './Flooring';
import { InteriorOrRoomFeatures } from './InteriorOrRoomFeatures';
import { CommonWalls } from './CommonWalls';
import { PetsAllowed } from './PetsAllowed';
import { GreenSustainability } from './GreenSustainability';
import { MiddleOrJuniorSchoolDistrict } from './MiddleOrJuniorSchoolDistrict';
import { MlsStatus } from './MlsStatus';
import { ListingAgreement } from './ListingAgreement';
import { Electric } from './Electric';
import { Utilities } from './Utilities';
import { PropertyType } from './PropertyType';
import { UnitsFurnished } from './UnitsFurnished';
import { AssociationAmenities } from './AssociationAmenities';
import { StateOrProvince } from './StateOrProvince';
import { RoadResponsibility } from './RoadResponsibility';
import { Media } from './Media';
import { RentIncludes } from './RentIncludes';
import { ConstructionMaterials } from './ConstructionMaterials';
import { CountyOrParish } from './CountyOrParish';
import { GreenLocation } from './GreenLocation';
import { Fencing } from './Fencing';
import { StreetDirection } from './StreetDirection';
import { LockBoxType } from './LockBoxType';
import { BuyerAgentDesignation } from './BuyerAgentDesignation';
import { GreenBuildingVerificationType } from './GreenBuildingVerificationType';
import { SyndicateTo } from './SyndicateTo';
import { PropertySubType } from './PropertySubType';
import { HighSchool } from './HighSchool';
import { PowerProductionType } from './PowerProductionType';
import { WaterfrontFeatures } from './WaterfrontFeatures';
import { HistoryTransactional } from './HistoryTransactional';
import { HighSchoolDistrict } from './HighSchoolDistrict';
import { Heating } from './Heating';
import { LeaseRenewalCompensation } from './LeaseRenewalCompensation';
import { MLSAreaMajor } from './MLSAreaMajor';
import { OperatingExpenseIncludes } from './OperatingExpenseIncludes';
import { Country } from './Country';
import { SpecialLicenses } from './SpecialLicenses';
import { AreaSource } from './AreaSource';
import { ElementarySchoolDistrict } from './ElementarySchoolDistrict';
import { Furnished } from './Furnished';
import { ArchitecturalStyle } from './ArchitecturalStyle';
import { FoundationDetails } from './FoundationDetails';
import { LaborInformation } from './LaborInformation';
import { PostalCity } from './PostalCity';
import { Teams } from './Teams';
import { ExteriorFeatures } from './ExteriorFeatures';
import { BuyerFinancing } from './BuyerFinancing';
import { GreenIndoorAirQuality } from './GreenIndoorAirQuality';
import { Disclosures } from './Disclosures';
import { ShowingContactType } from './ShowingContactType';
import { OccupantType } from './OccupantType';
import { WaterSource } from './WaterSource';
import { DocumentsAvailable } from './DocumentsAvailable';
import { OwnerPays } from './OwnerPays';
import { ShowingRequirements } from './ShowingRequirements';
import { AssociationFeeIncludes } from './AssociationFeeIncludes';
import { OtherEquipment } from './OtherEquipment';
export interface Property {
/**
* {@link https://ddwiki.reso.org/display/DDW17/AboveGradeFinishedArea+Field}
*
* Finished area within the structure that is at or above the surface of the ground.
*/
AboveGradeFinishedArea?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AboveGradeFinishedAreaSource+Field}
*
* The source of the measurements. This is a pick list of options showing the source of the measurement.
* i.e. Agent, Assessor, Estimate, etc.
*/
AboveGradeFinishedAreaSource?: AreaSource;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AboveGradeFinishedAreaUnits+Field}
*
* A pick list of the unit of measurement for the area. i.e. Square Feet, Square Meters, Acres, etc.
*/
AboveGradeFinishedAreaUnits?: AreaUnits;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AccessCode+Field}
*
* If the property is located behind an unmanned security gate such as in a Gated Community, what is the
* code to gain access through the secured gate.
*/
AccessCode?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AccessibilityFeatures+Field}
*
* A list or description of the accessibility features included in the sale/lease.
*/
AccessibilityFeatures?: AccessibilityFeatures[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/AdditionalParcelsDescription+Field}
*
* If additional parcels are included in the sale, a list of those parcel's IDs separated by commas. Do not
* include the first or primary parcel number, that should be located in the Parcel Number field.
*/
AdditionalParcelsDescription?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AdditionalParcelsYN+Field}
*
* Are there more than one parcel or lot included in the sale?
*/
AdditionalParcelsYN?: boolean;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AnchorsCoTenants+Field}
*
* The main or most notable tenants as well as other tenants of the shopping center or mall in which the
* commercial property is located.
*/
AnchorsCoTenants?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/Appliances+Field}
*
* A list of the appliances that will be included in the sale/lease of the property.
*/
Appliances?: Appliances[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/ArchitecturalStyle+Field}
*
* A list describing the style of the structure. For example, Victorian, Ranch, Craftsman, etc.
*/
ArchitecturalStyle?: ArchitecturalStyle[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationAmenities+Field}
*
* Amenities provided by the Home Owners Association, Mobile Park or Complex. For example Pool, Clubhouse,
* etc.
*/
AssociationAmenities?: AssociationAmenities[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationFee+Field}
*
* A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common
* area, neighborhood or other association related benefits.
*/
AssociationFee?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationFee2+Field}
*
* A fee paid by the homeowner to the second of two Home Owners Associations, which is used for the upkeep
* of the common area, neighborhood or other association related benefits.
*/
AssociationFee2?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationFee2Frequency+Field}
*
* The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time,
* etc.
*/
AssociationFee2Frequency?: FeeFrequency;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationFeeFrequency+Field}
*
* The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time,
* etc.
*/
AssociationFeeFrequency?: FeeFrequency;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationFeeIncludes+Field}
*
* Services included with the association fee. For example Landscaping, Trash, Water, etc.
*/
AssociationFeeIncludes?: AssociationFeeIncludes[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationName+Field}
*
* The name of the Home Owners Association.
*/
AssociationName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationName2+Field}
*
* The name of the second of two Home Owners Association.
*/
AssociationName2?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationPhone+Field}
*
* The phone number of the Home Owners Association. North American 10 digit phone numbers should be in the
* format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.
* International numbers should be preceded by a plus symbol.
*/
AssociationPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationPhone2+Field}
*
* The phone number of the second of two Home Owners Association. North American 10 digit phone numbers
* should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common
* local standard. International numbers should be preceded by a plus symbol.
*/
AssociationPhone2?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AssociationYN+Field}
*
* Is there a Home Owners Association. A separate Y/N field is needed because not all associations have
* dues.
*/
AssociationYN?: boolean;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AttachedGarageYN+Field}
*
* A flag indicating that the garage attached to the dwelling.
*/
AttachedGarageYN?: boolean;
/**
* {@link https://ddwiki.reso.org/display/DDW17/AvailabilityDate+Field}
*
* The date the property will be available for possession/occupation.
*/
AvailabilityDate?: Date;
/**
* {@link https://ddwiki.reso.org/display/DDW17/Basement+Field}
*
* A list of information and features about the basement. i.e. None/Slab, Finished, Partially Finished,
* Crawl Space, Dirt, Outside Entrance, Radon Mitigation
*/
Basement?: Basement[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BasementYN+Field}
*
* Does the property have a basement?
*/
BasementYN?: boolean;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field}
*
* A room containing all 4 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower
* Head. A Full Bath will typically contain four elements; Sink, Toilet, Tub and Shower Head (in tub or
* stall). However, some may considered a Sink, Toilet and Tub (without a shower) a Full Bath, others
* consider this to be a Three Quarter Bath. In the event that BathroomsThreeQuarter is not in use, this
* field may represent the sum of all Full and Three Quarter bathrooms.
*/
BathroomsFull?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsHalf+Field}
*
* A room containing 2 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower
* Head. A Half Bath will typically contain a Sink and Toilet.
*/
BathroomsHalf?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsOneQuarter+Field}
*
* A room containing 1 of the 4 elements constituting a bath which are; Toilet, Sink, Bathtub or Shower
* Head. Examples are a vanity with a sink or a WC (Water Closet, which is a room with only a toilet).
*/
BathroomsOneQuarter?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field}
*
* The number of partial bathrooms in the property being sold/leased. When used in combination with the
* BathroomsFull field, this replaces (or is the sum of) all Half and One Quarter bathrooms; and in the
* event BathroomsThreeQuarter is not used, BathroomsFull replaces (or is the sum of) all Full and Three
* Quarter baths. This field should not be used in combination with the BathroomsOneQuarter or the
* BathroomsHalf.
*/
BathroomsPartial?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsThreeQuarter+Field}
*
* A room containing 3 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower
* Head. A typical Three Quarter Bath will contain Sink, Toilet and Shower. Some may considered a Sink,
* Toilet and Tub (without a shower) a Three Quarter Bath, others consider this to be a Full Bath.
*/
BathroomsThreeQuarter?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field}
*
* The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one
* Half Bathroom, the Bathrooms Total Integer will be 3. Expressing this example as 2.5, you will need to
* use a non-standard field name. Decimal based bathrooms are not recommended but possible via the
* Dictionary's extensibility.
*/
BathroomsTotalInteger?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BedroomsPossible+Field}
*
* The sum of BedroomsTotal plus other rooms that may be used as a bedroom but are not defined as bedroom
* per local policy.
*/
BedroomsPossible?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BedroomsTotal+Field}
*
* The total number of bedrooms in the dwelling.
*/
BedroomsTotal?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BelowGradeFinishedArea+Field}
*
* Finished area within the structure that is below ground.
*/
BelowGradeFinishedArea?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BelowGradeFinishedAreaSource+Field}
*
* The source of the measurements. This is a pick list of options showing the source of the measurement.
* i.e. Agent, Assessor, Estimate, etc.
*/
BelowGradeFinishedAreaSource?: AreaSource;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BelowGradeFinishedAreaUnits+Field}
*
* A pick list of the unit of measurement for the area. i.e. Square Feet, Square Meters, Acres, etc.
*/
BelowGradeFinishedAreaUnits?: AreaUnits;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BodyType+Field}
*
* Type of mobile home.
*/
BodyType?: BodyType[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuilderModel+Field}
*
* The builders model name or number for the property.
*/
BuilderModel?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuilderName+Field}
*
* Name of the builder of the property or builder's tract.
*/
BuilderName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuildingAreaSource+Field}
*
* The source of the measurements. This is a pick list of options showing the source of the measurement.
* i.e. Agent, Assessor, Estimate, etc.
*/
BuildingAreaSource?: AreaSource;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuildingAreaTotal+Field}
*
* Total area of the structure. Includes both finished and unfinished areas.
*/
BuildingAreaTotal?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuildingAreaUnits+Field}
*
* A pick list of the unit of measurement for the area. i.e. Square Feet, Square Meters, Acres, etc.
*/
BuildingAreaUnits?: AreaUnits;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuildingFeatures+Field}
*
* Features or amenities of the building or business park.
*/
BuildingFeatures?: BuildingFeatures[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuildingName+Field}
*
* Name of the building or business park.
*/
BuildingName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BusinessName+Field}
*
* Name of the business being sold.
*/
BusinessName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BusinessType+Field}
*
* The type of business being sold. Retail, Wholesale, Grocery, Food & Bev, etc.
*/
BusinessType?: BusinessType[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgencyCompensation+Field}
*
* The total commission to be paid for this sale, expressed as either a percentage or a constant currency
* amount.
*/
BuyerAgencyCompensation?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgencyCompensationType+Field}
*
* A list of types to clarify the value entered in the BuyerAgencyCompensation field. For example $, % or
* some other clarification of the BuyerAgencyCompensation.
*/
BuyerAgencyCompensationType?: CompensationType;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentAOR+Field}
*
* The Buyer's Agent's Board or Association of REALTORS.
*/
BuyerAgentAOR?: AOR;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentDesignation+Field}
*
* Designations and certifications acknowledging experience and expertise in various real estate sectors are
* awarded by NAR and each affiliated group upon completion of required courses.
*/
BuyerAgentDesignation?: BuyerAgentDesignation[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentDirectPhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentDirectPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentEmail+Field}
*
* The email address of the Buyer's Agent.
*/
BuyerAgentEmail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentFax+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentFax?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentFirstName+Field}
*
* The first name of the buyer's agent.
*/
BuyerAgentFirstName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentFullName+Field}
*
* The full name of the buyer's agent. (First Middle Last)
*/
BuyerAgentFullName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentHomePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentHomePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey.
*/
BuyerAgentKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey. This is the numeric only key and used as an alternative to the BuyerAgentKey
* field.
*/
BuyerAgentKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentLastName+Field}
*
* The last name of the buyer's agent.
*/
BuyerAgentLastName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentMiddleName+Field}
*
* The middle name of the buyer's agent.
*/
BuyerAgentMiddleName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentMlsId+Field}
*
* The local, well-known identifier. This value may not be unique, specifically in the case of aggregation
* systems, this value should be the identifier from the original system.
*/
BuyerAgentMlsId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentMobilePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentMobilePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentNamePrefix+Field}
*
* Prefix to the name (e.g. Dr. Mr. Ms. etc.)
*/
BuyerAgentNamePrefix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentNameSuffix+Field}
*
* Suffix to the BuyerAgentLastName (e.g. Esq., Jr., III etc.)
*/
BuyerAgentNameSuffix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentOfficePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentOfficePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentOfficePhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
BuyerAgentOfficePhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentPager+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentPager?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentPreferredPhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentPreferredPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentPreferredPhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
BuyerAgentPreferredPhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentStateLicense+Field}
*
* The license of the buyers agent. Separate multiple licenses with a comma and space.
*/
BuyerAgentStateLicense?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentTollFreePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentTollFreePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentURL+Field}
*
* The website URI of the buyers agent.
*/
BuyerAgentURL?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentVoiceMail+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerAgentVoiceMail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerAgentVoiceMailExt+Field}
*
* The extension of the given phone number (if applicable).
*/
BuyerAgentVoiceMailExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerFinancing+Field}
*
* A list of options that describe the type of financing used. This field is used when setting a listing to
* Closed. i.e. cash, FHA loan, etc.
*/
BuyerFinancing?: BuyerFinancing[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeAOR+Field}
*
* The Buyer's Office's Board or Association of REALTORS.
*/
BuyerOfficeAOR?: AOR;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeEmail+Field}
*
* The email address of the Buyer's Office.
*/
BuyerOfficeEmail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeFax+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerOfficeFax?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Office resource's OfficeKey.
*/
BuyerOfficeKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Office resource's OfficeKey. This is the numeric only key and used as an alternative to the
* BuyerOfficeKey field.
*/
BuyerOfficeKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeMlsId+Field}
*
* The local, well-known identifier. This value may not be unique, specifically in the case of aggregation
* systems, this value should be the identifier from the original system.
*/
BuyerOfficeMlsId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeName+Field}
*
* The legal name of the brokerage representing the buyer.
*/
BuyerOfficeName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
BuyerOfficePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficePhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
BuyerOfficePhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerOfficeURL+Field}
*
* The website URI for the buyers office.
*/
BuyerOfficeURL?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerTeamKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Teams resource's TeamKey.
*/
BuyerTeamKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerTeamKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Teams resource's TeamKey. This is the numeric only key and used as an alternative to the BuyerTeamKey
* field.
*/
BuyerTeamKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/BuyerTeamName+Field}
*
* The name of the team representing the buyer.
*/
BuyerTeamName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CableTvExpense+Field}
*
* The annual expense that is not paid directly by the tenant and is included in the Operating Expense
* calculations.
*/
CableTvExpense?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CancellationDate+Field}
*
* Date the listing contract between the seller and listing agent was cancelled. This is the date entered by
* the agent reflecting when the change occurred contractually, not a timestamp of when the change was made
* in the MLS.
*/
CancellationDate?: Date;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CapRate+Field}
*
* Cap Rate is equivalent to the return on investment you would receive if you pay cash for a property. The
* ratio between the net operating income produced by an asset and its capital cost (the original price paid
* to buy the asset) or alternatively its current market value.
*/
CapRate?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CarportSpaces+Field}
*
* The number of carport spaces included in the sale.
*/
CarportSpaces?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CarportYN+Field}
*
* A flag indicating that the listing has a car port. This flag may be T/F, Y/N or other true, false or
* unknown indicator. As with all flags, the field may be null.
*/
CarportYN?: boolean;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CarrierRoute+Field}
*
* The group of addresses to which the USPS assigns the same code to aid in mail delivery. For the USPS,
* these codes are 9 digits: 5 numbers for the ZIP Code, one letter for the carrier route type, and 3
* numbers for the carrier route number.
*/
CarrierRoute?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/City+Field}
*
* The city in listing address.
*/
City?: City;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CityRegion+Field}
*
* A sub-section or area of a defined city. Examples would be SOHO in New York, NY, Ironbound in Newark, NJ
* or Inside the Beltway.
*/
CityRegion?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CloseDate+Field}
*
* With for-sale listings, the date the purchase agreement was fulfilled. With lease listings, the date the
* requirements were fulfilled, such as contract and/or deposit. This is the date entered by the agent
* reflecting when the change occurred contractually, not a timestamp of when the change was made in the
* MLS.
*/
CloseDate?: Date;
/**
* {@link https://ddwiki.reso.org/display/DDW17/ClosePrice+Field}
*
* The amount of money paid by the purchaser to the seller for the property under the agreement.
*/
ClosePrice?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentAOR+Field}
*
* The Co Buyer's Agent's Board or Association of REALTORS.
*/
CoBuyerAgentAOR?: AOR;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentDesignation+Field}
*
* Designations and certifications acknowledging experience and expertise in various real estate sectors are
* awarded by NAR and each affiliated group upon completion of required courses.
*/
CoBuyerAgentDesignation?: CoBuyerAgentDesignation[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentDirectPhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentDirectPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentEmail+Field}
*
* The email address of the Buyer's Co Agent.
*/
CoBuyerAgentEmail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentFax+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentFax?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentFirstName+Field}
*
* The first name of the buyer's co-agent.
*/
CoBuyerAgentFirstName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentFullName+Field}
*
* The full name of the buyer's co-agent. (First Middle Last)
*/
CoBuyerAgentFullName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentHomePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentHomePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey.
*/
CoBuyerAgentKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey. This is the numeric only key and used as an alternative to the
* CoBuyerAgentKey field.
*/
CoBuyerAgentKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentLastName+Field}
*
* The last name of the buyer's co-agent.
*/
CoBuyerAgentLastName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentMiddleName+Field}
*
* The middle name of the buyer's co-agent.
*/
CoBuyerAgentMiddleName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentMlsId+Field}
*
* The local, well-known identifier. This value may not be unique, specifically in the case of aggregation
* systems, this value should be the identifier from the original system.
*/
CoBuyerAgentMlsId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentMobilePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentMobilePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentNamePrefix+Field}
*
* Prefix to the name (e.g. Dr. Mr. Ms. etc.)
*/
CoBuyerAgentNamePrefix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentNameSuffix+Field}
*
* Suffix to the CoBuyerAgentLastName (e.g. Esq., Jr., III etc.)
*/
CoBuyerAgentNameSuffix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentOfficePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentOfficePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentOfficePhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
CoBuyerAgentOfficePhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentPager+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentPager?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentPreferredPhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentPreferredPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentPreferredPhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
CoBuyerAgentPreferredPhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentStateLicense+Field}
*
* The license of the co-buyers agent. Separate multiple licenses with a comma and space.
*/
CoBuyerAgentStateLicense?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentTollFreePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentTollFreePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentURL+Field}
*
* The website URI of the co-buyers agent.
*/
CoBuyerAgentURL?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentVoiceMail+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerAgentVoiceMail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerAgentVoiceMailExt+Field}
*
* The extension of the given phone number (if applicable).
*/
CoBuyerAgentVoiceMailExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeAOR+Field}
*
* The Co Buyer's Office's Board or Association of REALTORS.
*/
CoBuyerOfficeAOR?: AOR;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeEmail+Field}
*
* The email address of the Buyer's Co Office.
*/
CoBuyerOfficeEmail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeFax+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerOfficeFax?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Office resource's OfficeKey.
*/
CoBuyerOfficeKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Office resource's OfficeKey. This is the numeric only key and used as an alternative to the
* CoBuyerOfficeKey field.
*/
CoBuyerOfficeKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeMlsId+Field}
*
* The local, well-known identifier. This value may not be unique, specifically in the case of aggregation
* systems, this value should be the identifier from the original system.
*/
CoBuyerOfficeMlsId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeName+Field}
*
* The legal name of the brokerage co-representing the buyer.
*/
CoBuyerOfficeName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoBuyerOfficePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficePhoneExt+Field}
*
* The extension of the given phone number (if applicable).
*/
CoBuyerOfficePhoneExt?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoBuyerOfficeURL+Field}
*
* The website URI for the co-buyers office.
*/
CoBuyerOfficeURL?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentAOR+Field}
*
* The Co Listing Agent's Board or Association of REALTORS.
*/
CoListAgentAOR?: AOR;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentDesignation+Field}
*
* Designations and certifications acknowledging experience and expertise in various real estate sectors are
* awarded by NAR and each affiliated group upon completion of required courses.
*/
CoListAgentDesignation?: CoListAgentDesignation[];
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentDirectPhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoListAgentDirectPhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentEmail+Field}
*
* The email address of the Co Listing Agent.
*/
CoListAgentEmail?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentFax+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoListAgentFax?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentFirstName+Field}
*
* The first name of the co-listing agent.
*/
CoListAgentFirstName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentFullName+Field}
*
* The full name of the co-listing agent. (First Middle Last)
*/
CoListAgentFullName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentHomePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoListAgentHomePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentKey+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey.
*/
CoListAgentKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentKeyNumeric+Field}
*
* A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
* from the system that the record was just retrieved. This may be identical to the related xxxId
* identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the
* Member resource's MemberKey. This is the numeric only key and used as an alternative to the
* CoListAgentKey field.
*/
CoListAgentKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentLastName+Field}
*
* The last name of the co-listing agent.
*/
CoListAgentLastName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentMiddleName+Field}
*
* The middle name of the co-listing agent.
*/
CoListAgentMiddleName?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentMlsId+Field}
*
* The local, well-known identifier. This value may not be unique, specifically in the case of aggregation
* systems, this value should be the identifier from the original system.
*/
CoListAgentMlsId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentMobilePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoListAgentMobilePhone?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentNamePrefix+Field}
*
* Prefix to the name (e.g. Dr. Mr. Ms. etc.)
*/
CoListAgentNamePrefix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentNameSuffix+Field}
*
* Suffix to the CoListAgentLastName (e.g. Esq., Jr., III etc.)
*/
CoListAgentNameSuffix?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/CoListAgentOfficePhone+Field}
*
* North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
* Other conventions should use the common local standard. International numbers should be preceded by a
* plus symbol.
*/
CoListAgentOffice