Types

TransactionEntry

Example

{
  "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"
    }
  }
}

Schema

NameTypeDescription
(root)objectdescribes a unit of sales credit in unit or commission value relative to a parent transaction
typestringallowed ("TransactionEntry") TransactionEntry
salesProductionUnitnumberthe sales production units credited to the recipient [ 0.0001 .. 1 ]
salesProductionGCIobjectgross commission income credited to the recipient
salesProductionGCI.typestringallowed ("MonetaryAmount") MonetaryAmount
salesProductionGCI.minValuenumberthe lower limit of the range
salesProductionGCI.maxValuenumberthe upper limit of the range
salesProductionGCI.valuenumberthe actual or expected value
salesProductionGCI.currencystringuse ISO4217 country codes <= 3 characters
recipientobjectthe agent credited with the sales production and who receives the value
recipient.typestringtypically a RealEstateAgent
recipient.roleNamestringallowed ("ListingAgent", "BuyerAgent") enum: ListingAgent,BuyerAgent
recipient.idstringLinked-Data URI (@id) format (uri)
recipient.identifierobjectunique identifier of the recipient from the data producer
recipient.identifier.bmsAgentIdstring<= 12 characters
Previous
Thing