Transactions

Retrieve a Collection of Transactions

Retrieves a collection of transactions within the current client code. OData can be used to filter, order and page through the list.

OData Support: $expand, $filter, $orderby, $skip, $top

Common OData Queries

Find all transactions for a given office:

$filter=Tiers/any(x:x/AgentCommissions/any(y:y/OfficeId eq '[Lone Wolf Office Id]'))

Find all transactions for a given agent:

$filter=Tiers/any(x:x/AgentCommissions/any(y:y/AgentId eq '[Lone Wolf Member Id]'))

Find all transactions modified after January 1st, 2015 at 4:00 PM EST:

$filter=TransactionChangedTimestamp lt datetimeoffset'2015-01-01T21:00:00.0000000%2B00:00'

Note the time was changed to UTC time. Also, the plus sign separating the time zone has been changed to the URL encoded version of %2B. This is a requirement when specifying datetimeoffset OData values.

Find all contingent transactions (any conditions that have an approved date of null):

$filter=Conditions/any(x:x/ApprovedDate eq null)

Find all firm transactions (no conditions or all the conditions have a valid approved date):

$filter=Conditions/any() eq false or Conditions/all(x:x/ApprovedDate ne null) eq true
get/wolfconnect/transactions/v1

Request

  • Base URL: https://api.globalwolfweb.com
  • URL: https://api.globalwolfweb.com/wolfconnect/transactions/v1
  • Auth: API key in header Authorization

Query parameters

$expandstring

Instructs the API to include a child object or collection in the response. If omitted, ALL child objects and collections are returned. Pass $expand= (empty) to return only the root object. See the OData Support section of the introduction.

$filterstring

Filters data on properties related to the resource. Only Logical, Arithmetic and Grouping operators are currently supported. No Canonical functions are currently supported (contains, endswith, startswith, etc.).

$orderbystring

Orders the objects returned in the response by a property related to the resource.

$skipinteger

Skips the specified number of records before returning the results. $orderby must be specified for $skip to be used.

$topinteger

Returns the specified top number of records for the given query. $orderby must be specified for $top to be used. The maximum number of objects returned from any resource is 1,000. If not passed, $top=1000 is assumed.

Response

A collection of Transaction objects.

Idstring

The Lone Wolf Id of the transaction. Required for updates only. It will be ignored when creating a new transaction.

Numberstring

The transaction number. In most cases, the transaction number will be automatically generated. This is only required if the primary office for the trade allows manual transaction number entry and it has not setup a sequence for transaction numbers.

MLSNumberstring

The MLS number for the listing associated to the transaction.

PropertyTypeIdstring required

The Lone Wolf Id of the property type. This is an Id that is retrieved from the property types resource.

ClassificationIdstring required

The Lone Wolf Id of the classification. This is an Id that is retrieved from the classifications resource.

StatusCodestring

The code for the status. N: Open, A: Closed, P: Partially closed (not all but at least one tier has been finalized), B: Fallen through because of a condition, C: Fallen through

Statusstring

The name of the status. This field is read only.

EntryDatestring date

The date the transaction was entered. This is not the date that the transaction record was created (though in most cases, it will be the same value). This is a client specified date. If not specified, then the current date is used.

CloseDatestring date required

The date the transaction closed.

OfferDatestring date required

The date an offer was made on the transaction.

SellPricenumber required

The final sale price.

LegalDescriptionstring

Any legal notices for the transaction.

CreatedTimestampstring date-time

The date and time the transaction was created.

ModifiedTimestampstring date-time

The date and time the transaction was last modified.

TransactionChangedTimestampstring date-time

The date and time the transaction or any of its associated objects were last changed. For instance, if a commission was added to a tier, the TransactionChangedTimestamp would hold the time that the commission was added. Any change to any object associated to the transaction will update this field. It is very useful when querying for transactions that have been modified since a particular date and time.

RowVersioninteger

The version of the record in the database.

Changes

No recorded changes to this operation across all 1 revision of this API.