Types

RealEstateTransaction

Example

{
  "type": "RealEstateTransaction",
  "identifier": {
    "bmsTransactionId": "0000074792"
  },
  "additionalProperty": {
    "batchId": 4136,
    "transactionSequence": 1,
    "unimprovedLandFlag": true
  },
  "transactionStatus": "ClosedTransactionStatus",
  "transactionType": "ST",
  "reportingOffice": "https://{officeid}.example.com/profile/card#me",
  "listingOffice": "https://{officeid}.example.com/profile/card#me",
  "buyerOffice": "https://{officeid}.example.com/profile/card#me",
  "commissionDate": "2019-08-24T14:15:22Z",
  "closeDate": "2019-08-24T14:15:22Z",
  "purchaseContractDate": "2019-08-24T14:15:22Z",
  "closePrice": {
    "type": "MonetaryAmount",
    "value": 123456.78,
    "currency": "USD"
  },
  "totalSalesProductionGCI": {
    "type": "MonetaryAmount",
    "value": 123456.78,
    "currency": "USD"
  },
  "totalSalesProductionGCIDeduction": {
    "type": "MonetaryAmount",
    "value": 1234.56,
    "currency": "USD"
  },
  "object": {
    "type": "RealEstateProperty",
    "propertyType": "RESI",
    "addressCountry": "CA",
    "addressLocality": "Gotham City",
    "addressRegion": "NJ",
    "apn": "ABC-12345-XX-XXXX",
    "image": [
      {
        "type": "ImageObject",
        "@id": "http://example.com",
        "id": "http://user.example.com/public/logo/image.jpg",
        "name": "image.jpg",
        "encodingFormat": "image/jpeg",
        "about": "http://user.example.com/profile/card#me",
        "url": "http://user.example.com/public/profile/image.jpg"
      }
    ],
    "latitude": 40.75,
    "listingId": "string",
    "livingArea": {
      "type": "QuantitativeValue",
      "unitCode": "SqFt",
      "unitText": "Square Feet",
      "value": 1500
    },
    "longitude": 73.98,
    "lotSize": {
      "type": "QuantitativeValue",
      "unitCode": "AC",
      "unitText": "Acres",
      "value": 0.5
    },
    "numberOfBathrooms": "2",
    "numberOfBedrooms": "3",
    "numberOfRooms": 7,
    "postalCode": "10010",
    "propertySubType": "ApartmentPropertyType",
    "stories": 2,
    "streetAddress": "1007 Mountain Gate Rd",
    "yearBuilt": 1988
  },
  "referral": {
    "type": "Referral",
    "additionalProperty": {
      "isReferralYN": "Y",
      "inNetworkReferralYN": "Y"
    },
    "referredBy": {
      "type": "RealEstateOrganization",
      "id": "http://example.com"
    }
  },
  "participant": [
    {
      "type": "TransactionParticipant",
      "roleName": "Buyer",
      "position": 1,
      "givenName": "John",
      "familyName": "Smith",
      "additionalName": "Big",
      "email": "user@example.com",
      "telephone": "+15558675309",
      "affiliation": [
        "https://{agentid}.example.com/profile/card#me"
      ]
    }
  ],
  "transactionEntry": [
    {
      "type": "TransactionEntry",
      "salesProductionUnit": 0.5,
      "salesProductionGCI": {
        "type": "MonetaryAmount",
        "value": 1234.56,
        "currency": "USD"
      },
      "recipient": {
        "type": "RealEstateAgent",
        "roleName": "ListingAgent",
        "id": "https://{entityid}.example.com/profile/card#me",
        "identifier": {
          "bmsAgentId": "1657897"
        }
      }
    }
  ],
  "document": [
    {
      "type": "DigitalDocument",
      "name": "Sales Contract",
      "encodingFormat": "application/zip",
      "about": {
        "type": "Transaction",
        "identifier": {
          "guruTransactionId": "0000074792"
        }
      },
      "url": "https://example.com/path/to/document.pdf"
    }
  ]
}

Schema

NameTypeDescription
(root)objectdescribes a sale, purchase and transfer of a real estate property.
typestringconst ("RealEstateTransaction")
identifierobjectthe data producer's id for the transaction.
identifier.bmsTransactionIdstring<= 12 characters
additionalPropertyobjectvendor/context specific custom properties
additionalProperty.batchIdintegeridentifies the batch for the current transaction
additionalProperty.transactionSequenceintegerthe sequentail order of this transaction report relative to previous reports of the the same RealEstateTransaction >= 0
additionalProperty.unimprovedLandFlagbooleantrue if the transaction subject property is an unimproved lot.
transactionStatusstringallowed ("PendingTransactionStatus", "ClosedTransactionStatus", "CanceledTransactionStatus") transaction status
transactionTypestringallowed ("ST", "LS", "OI", "PM", "RF") transaction type
reportingOfficestringthe reporting office format (uri)
listingOfficestringthe office representing the seller format (uri)
buyerOfficestringthe office representing the buyer format (uri)
commissionDatestringdate the purchase offer was presented format (date-time)
closeDatestringWith purchase the date the purchase agreement was fulfilled. With lease, the date the requirements were fulfilled, such as contract and/or deposit. format (date-time)
purchaseContractDatestringdate of purchase agreement execution (aka sale date) format (date-time)
closePriceobjectthe final sale price of the subject
closePrice.typestringallowed ("MonetaryAmount") MonetaryAmount
closePrice.minValuenumberthe lower limit of the range
closePrice.maxValuenumberthe upper limit of the range
closePrice.valuenumberthe actual or expected value
closePrice.currencystringuse ISO4217 country codes <= 3 characters
totalSalesProductionGCIobjectthe total gci of the transaction
totalSalesProductionGCI.typestringallowed ("MonetaryAmount") MonetaryAmount
totalSalesProductionGCI.minValuenumberthe lower limit of the range
totalSalesProductionGCI.maxValuenumberthe upper limit of the range
totalSalesProductionGCI.valuenumberthe actual or expected value
totalSalesProductionGCI.currencystringuse ISO4217 country codes <= 3 characters
totalSalesProductionGCIDeductionobjecttotal gci deductions for the transaction
totalSalesProductionGCIDeduction.typestringallowed ("MonetaryAmount") MonetaryAmount
totalSalesProductionGCIDeduction.minValuenumberthe lower limit of the range
totalSalesProductionGCIDeduction.maxValuenumberthe upper limit of the range
totalSalesProductionGCIDeduction.valuenumberthe actual or expected value
totalSalesProductionGCIDeduction.currencystringuse ISO4217 country codes <= 3 characters
objectobjecta property in the real estate transaction context
object.typestringallowed ("RealEstateProperty") "RealEstateProperty"
object.propertyTypestringallowed ("RESI", "RLSE", "RINC", "LAND", "MOBI", "FARM", "COMS", "COML", "BUSO") RESO property type (see range for allowed values) 4 characters
object.addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
object.addressLocalitystringCity, Township. <= 50 characters
object.addressRegionstringabbreviated state or province
object.apnstringAssessors Parcel Number
object.imagetuple<object allOf, ...optional<any>>an ImageObject or URI reference to an image on the web.
object.image.0 (index)object allOf-
object.image.0.0 (allOf item)allOfan image, video or document availble for download
object.image.0.0.0 (allOf item)object-
object.image.0.0.0.typestringThe item type (Linked-Data @type) pattern (^[A-Z][a-zA-Z0-9]+$)
object.image.0.0.0.@idstringthe liked data uri for the Thing format (uri)
object.image.0.0.0 (property names)-pattern (^[a-z@$][a-zA-Z0-9-_]+$)
object.image.0.0.1 (allOf item)--
object.image.0.0.1.typestringallowed ("MediaObject", "ImageObject", "DigitalDocument")
object.image.0.0.1.idstringthe URL to access the item. format (uri)
object.image.0.0.1.namestringthe file name of the object.
object.image.0.0.1.encodingFormatstringMIME type
object.image.0.0.1.aboutstringURI to the subject of the image or logo format (uri)
object.image.0.0.1.urlstringURL of the image content format (uri)
object.image.0.1 (allOf item)--
object.image.0.1.typestringallowed ("ImageObject")
object.image.0.1.idany-
object.image.0.1.nameany-
object.image.0.1.encodingFormatany-
object.latitudenumberThe latitude of a location.
object.listingIdstringthe local identifier for the listing (MLS #)
object.livingAreaobjectproperty indoor space
object.longitudenumberThe longitude of a location.
object.lotSizeobjectoutdoor space minValue, maxValue
object.numberOfBathroomsstringthe number of bathrooms
object.numberOfBedroomsstringthe number of bedrooms
object.numberOfRoomsstringthe total number of rooms in the building
object.postalCodestringZip/Post Code <= 12 characters
object.propertySubTypestringallowed ("ApartmentPropertyType", "BoatSlipPropertyType", "CabinPropertyType", "CondominiumPropertyType", "DeededParkingPropertyType", "DuplexPropertyType", "FarmPropertyType", "ManufacturedHomePropertyType", "ManufacturedOnLandPropertyType", "MobileHomePropertyType", "OwnYourOwnPropertyType", "QuadruplexPropertyType", "RanchPropertyType", "SingleFamilyPropertyType", "StockCooperativePropertyType", "TimesharePropertyType", "TownhousePropertyType", "TriplexPropertyType", "AgriculturePropertyType", "BusinessPropertyType", "HotelMotelPropertyType", "IndustrialPropertyType", "MixedUsePropertyType", "MultiFamilyPropertyType", "OfficePropertyType", "RetailPropertyType", "UnimprovedLandPropertyType", "WarehousePropertyType") RESO property sub-type (see range for allowed values)
object.storiesnumberhe number of floors in the property
object.streetAddressstringthe street address <= 75 characters
object.yearBuiltnumberthe year the structure was created
referralobjectreferring agent details
referral.typestringallowed ("Referral") The item type (Linked-Data @type)
referral.additionalPropertyobjectcontext specific custom properties
referral.additionalProperty.isReferralYNstringallowed ("Y", "N") Y if transaction was a referral
referral.additionalProperty.inNetworkReferralYNstringallowed ("Y", "N") Y if transaction was referred by an in network agent
referral.referredByobjectthe referring entity
referral.referredBy.typestringallowed ("RealEstateOrganization", "RealEstateAgent", "RealEstateOffice", "Organization", "Person") the referring entity type i.e RealEstateOrganization, RealEstateAgent
referral.referredBy.idstringLinked-Data URI (@id) format (uri)
participantarray<object>parties with a direct or indirect interest or role in the transaction
participant.typestringconst ("TransactionParticipant")
participant.roleNamestringthe role of the participant in the transaction
participant.positionnumbernumeric position for the participant/roleName.
participant.givenNamestringFirst Name of a person
participant.familyNamestringLast Name of a person. Family Name <= 50 characters
participant.additionalNamestringmiddleName or alternate name of the Person
participant.emailstringa valid email address format (email)
participant.telephonestringPrimary phone number.
participant.affiliationarray<string>person or organization associated with the participant
participant.affiliation (single item)stringformat (uri)
transactionEntryarray<object>commissions and unit entries
transactionEntry.typestringallowed ("TransactionEntry") TransactionEntry
transactionEntry.salesProductionUnitnumberthe sales production units credited to the recipient [ 0.0001 .. 1 ]
transactionEntry.salesProductionGCIobjectgross commission income credited to the recipient
transactionEntry.salesProductionGCI.typestringallowed ("MonetaryAmount") MonetaryAmount
transactionEntry.salesProductionGCI.minValuenumberthe lower limit of the range
transactionEntry.salesProductionGCI.maxValuenumberthe upper limit of the range
transactionEntry.salesProductionGCI.valuenumberthe actual or expected value
transactionEntry.salesProductionGCI.currencystringuse ISO4217 country codes <= 3 characters
transactionEntry.recipientobjectthe agent credited with the sales production and who receives the value
transactionEntry.recipient.typestringtypically a RealEstateAgent
transactionEntry.recipient.roleNamestringallowed ("ListingAgent", "BuyerAgent") enum: ListingAgent,BuyerAgent
transactionEntry.recipient.idstringLinked-Data URI (@id) format (uri)
transactionEntry.recipient.identifierobjectunique identifier of the recipient from the data producer
transactionEntry.recipient.identifier.bmsAgentIdstring<= 12 characters
documentarray<object>any documents, images, etc... related to the transaction.
document (single item)object-
Previous
RealEstateTeamMembership
Next
RealEstateWebsite