Transactions

Retrieve a Transaction

Retrieves a transaction. The data in the response will contain all of the data to which you have read access. Properties with values of NULL typically mean that you do not have read access to that property. Please see the Permissions section of the introduction for more information.

OData Support: $expand

get/wolfconnect/transactions/v1/{transactionId}

Request

  • Base URL: https://api.globalwolfweb.com
  • URL: https://api.globalwolfweb.com/wolfconnect/transactions/v1/{transactionId}
  • 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.

Response

A Transaction object.

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.