franchise#transactionreport

Message

Franchise transaction report of transaction for sales production reporting.

Payload Example(s) (generated)

{
  "topic": "realestate/franchise#transactionreport",
  "data": {
    "type": "UpdateAction",
    "instrument": {
      "type": "SoftwareApplication",
      "name": "Guru"
    },
    "object": {
      "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
      },
      # case 1
      "referral": {
        "type": "Referral",
        "additionalProperty": {
          "isReferralYN": "Y",
          "bhssInNetworkReferralYN": "Y"
        },
        "referredBy": {
          "type": "RealEstateOrganization",
          "id": "http://example.com"  # required and should be valid companyId
        }
      },
      # case 2
      "referral": {
        "type": "Referral",
        "additionalProperty": {
          "isReferralYN": "Y",
          "referralChannel": " Out-of-Network Brokerage |
                               Listing Aggregator |
                               Corporate Relocation |
                               Affinity Relationship "
        }
      },
       # case 3
      "referral": {
        "type": "Referral",
        "additionalProperty": {
          "isReferralYN": "Y",
          "referralChannel": "In-Network Brokerage"
        },
        "referredBy": {
          "type": "RealEstateOrganization",
          "id": "http://example.com" # required and should be valid companyId
        }
      },
       # case 4
      "referral": {
        "type": "Referral",
        "additionalProperty": {
          "isReferralYN": "N",
        }
      },
      "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"
        }
      ]
    }
  }
}

Payload

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

Headers

NameTypeDescription
(root)object-
timestringdate & time the event was produced format (date-time)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)
instrumentstringthe app or service that produced the event on behalf of the agent/user format (uri)
sourcestringa copy of the event was sent to the source(s). format (uri)
originalRecipientstringthe originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri)
idstringthe Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idstringformat (uri)

Tools

Next
Getting started