The Transactions Resource is a RESTful web resource running on Microsoft's Web API allowing third parties to access transaction data.
The following actions are currently supported:
- Create a Transaction
- Retrieve a Transaction or a collection of Transactions
- Update a Transaction
- Delete a Transaction
- Finalize a Transaction
- Search for Transactions
The sections on creating and updating data in the introduction should be read before using the create and update functions of the Transactions API.
Transactions and Offices
You will see a reference to "the primary office for the transaction" used throughout this documentation: transactions are not tied directly to an office but are associated to agents.
The primary office for a transaction is the office of the agent with the largest commission. It is possible for a transaction to have agents associated to it that are in different offices. However, there will never be an instance when a transaction is tied to agents that are in different Client Codes. If you attempt to add agents from different Client Codes to the same transaction, you will receive an error.
Within a Client Code there can also be multiple Company Codes relating to brokerWOLF installations. There will never be a case where 2 agents with different Company Codes are associated to a transaction. If you attempt to add agents from different Company Codes to the same transaction, you will receive an error.
OData and the MLSAddress Property
The Transaction.MLSAddress property is used to group address properties together for a transaction. A transaction without an address is pretty meaningless. For this reason, the $expand OData parameter will have no effect on the Transaction.MLSAddress property. It will always be returned with the transaction data regardless if it is listed in the $expand OData parameter or not.