---
title: "Retrieve a Transaction"
method: GET
path: "/wolfconnect/transactions/v1/{transactionId}"
tags: ["Transactions"]
---

# Retrieve a Transaction

`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`

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

## Query parameters

- `$expand` string

## Response `200`

A Transaction object.

- Transaction
  - `Id` string: The Lone Wolf Id of the transaction. Required for updates only. It will be ignored when creating a new transaction.
  - `Number` string: 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.
  - `MLSNumber` string: The MLS number for the listing associated to the transaction.
  - `PropertyTypeId` string, required: The Lone Wolf Id of the property type. This is an Id that is retrieved from the property types resource.
  - `PropertyType` PropertyType
    - `Id` string: The Lone Wolf Id of the property type.
    - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
    - `Code` string: A code for this property type. This must be unique within an LWCompanyCode.
    - `Name` string: The name of the property type (Duplex, Townhouse, Commercial, etc).
    - `Default` boolean: True if this should be the default property type for new transactions and tiers.
    - `ClassCode` string: The code for the class. R: Residential, C: Commercial
    - `Class` string: The name of the class (Commercial, Residential).
    - `InactiveDate` string, date, nullable: The date the property type became inactive. (Nullable)
  - `ClassificationId` string, required: The Lone Wolf Id of the classification. This is an Id that is retrieved from the classifications resource.
  - `Classification` Classification
    - `Id` string: The Lone Wolf Id of the classification.
    - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
    - `Code` string: A code for this classification. This must be unique within an LWCompanyCode.
    - `Name` string: The name of the classification (Listing, Selling, Agent Double Ender, etc).
    - `EndCount` number: The end count for the classification. For instance, if this is an Agent Double Ender, the end count would be 2.0. If it's a Listing classification, the end count would be 1.0.
    - `InactiveDate` string, date, nullable: The date the classification became inactive. (Nullable)
  - `StatusCode` string: 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
  - `Status` string: The name of the status. This field is read only.
  - `EntryDate` string, 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.
  - `CloseDate` string, date, required: The date the transaction closed.
  - `OfferDate` string, date, required: The date an offer was made on the transaction.
  - `SellPrice` number, required: The final sale price.
  - `LegalDescription` string: Any legal notices for the transaction.
  - `MLSAddress` MLSAddress, required
    - `StreetNumber` string, required: The street number.
    - `StreetName` string, required: The street name.
    - `StreetDirection` string: The street direction.
    - `Unit` string: The unit or building number.
    - `City` string, required: The city.
    - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state.
    - `Province` string: The name of the province or state.
    - `PostalCode` string, required: The unformatted postal or zip code. If this is passed in to the API with formatting, the formatting will be removed before saving to the database. It will be returned unformatted.
    - `CountryCode` string, required: The two character ISO code for the country.
    - `Country` string: The name of the country.
  - `Tiers` Tier[], required: The list of different tiers for the transactions. At least 1 is required.
    - `Id` string: The Lone Wolf Id of the tier. Required for updates only. It will be ignored when creating a new tier.
    - `Name` string: The name of the tier.
    - `ClassificationId` string, required: The Lone Wolf Id of the classification. This is an Id that is retrieved from the classifications resource.
    - `Classification` Classification
      - `Id` string: The Lone Wolf Id of the classification.
      - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
      - `Code` string: A code for this classification. This must be unique within an LWCompanyCode.
      - `Name` string: The name of the classification (Listing, Selling, Agent Double Ender, etc).
      - `EndCount` number: The end count for the classification. For instance, if this is an Agent Double Ender, the end count would be 2.0. If it's a Listing classification, the end count would be 1.0.
      - `InactiveDate` string, date, nullable: The date the classification became inactive. (Nullable)
    - `StatusCode` string: The code for the status. N: Open, A: Closed, B: Fallen through because of a condition, C: Fallen through
    - `Status` string: The name of the status.
    - `SellPrice` number, required: The final sale price for the tier.
    - `CloseDate` string, date, required: The close date for the tier.
    - `SellingCommission` number: The total selling commission for the tier.
    - `BuyingCommission` number: The total buying commission for the tier.
    - `TotalCommission` number: The total commission for the tier.
    - `AgentCommissions` AgentCommission[], required: The list of commissions for the tier. At least 1 is required.
      - `Id` string: The Lone Wolf Id of the agent commission. Required for updates only. It will be ignored when creating a new agent commission.
      - `AgentId` string, required: The Lone Wolf Id of the agent to associate to this commission. This is the same Id that would be used in the Members API.
      - `TeamLeaderId` string: The Lone Wolf Id of the agent's team leader. This is the same Id that would be used in the Members API.
      - `EndCode` string, required: The code of the end or side for the commission. L: Listing, S: Selling
      - `End` string: The name of the end or side.
      - `EndCount` number, required: The end count for the tier.
      - `CommissionPercentage` number: The percentage of the total commission for the tier. This is a value between 0 and 1.
      - `Commission` number, required: The total commission for the agent for this tier.
      - `Agent` Agent
        - `Id` string: The Lone Wolf Id of the agent.
        - `OfficeId` string: The Lone Wolf Id of the office the agent belongs to.
        - `FirstName` string: The first name.
        - `MiddleName` string: The middle name.
        - `LastName` string: The last name.
      - `TeamLeader` Agent
        - `Id` string: The Lone Wolf Id of the agent.
        - `OfficeId` string: The Lone Wolf Id of the office the agent belongs to.
        - `FirstName` string: The first name.
        - `MiddleName` string: The middle name.
        - `LastName` string: The last name.
      - `CreatedTimestamp` string, date-time: The date and time the agent commission was created.
      - `ModifiedTimestamp` string, date-time: The date and time the agent commission was last modified.
      - `RowVersion` integer: The version of the record in the database.
    - `ExternalAgentCommissions` ExternalAgentCommission[]: The list of external agent commissions for the tier.
      - `Id` string: The Lone Wolf Id of the external agent commission record. Required for updates only. It will be ignored when creating a new external agent commission.
      - `ExternalAgentId` string: The Lone Wolf Id of the external agent. ExternalAgentCommission objects can only have one ExternalAgent object associated to them making the ExternalAgentId column irrelevant.
      - `EndCode` string, required: The code of the end or side for the commission. L: Listing, S: Selling
      - `End` string: The name of the end or side.
      - `Commission` number, required: The total commission for the external agent for the associated transaction tier.
      - `ExternalAgent` ExternalAgent, required
        - `Id` string: The Lone Wolf Id of the external agent for a specific transaction tier. If you have the same external agent on different transaction tiers, they will have different Id values. Please see ExternalAgentCommission.ExternalAgentId for information on why this is not required.
        - `CRMId` string: Not implemented yet.
        - `CRMCompanyContactId` string: Not implemented yet.
        - `FirstName` string: The first name.
        - `MiddleName` string: Not implemented yet.
        - `LastName` string: The last name.
        - `ContactTypeId` string, required: The Lone Wolf Id of the contact type. This is an Id that is retrieved from the contact types resource. Only ContactType objects with TypeCode E should be used.
        - `ContactType` ContactType
          - `Id` string: The Lone Wolf Id of the contact type.
          - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
          - `Code` string: A code for this contact type. This must be unique within an LWCompanyCode.
          - `Name` string: The name of the contact type (Buyer, Seller, Lawyer, Outside Broker, etc).
          - `CategoryCode` string: The category for the contact type. B: Business contact, C: Client contact, E: External agent
          - `InactiveDate` string, date, nullable: The date the contact type became inactive. (Nullable)
        - `EndCode` string, required: The code of the end or side the external agent is used on. L: Listing, S: Selling
        - `End` string: The name of the end or side.
        - `CompanyName` string: The business contact's company.
        - `Addresses` Address[]: The list of addresses for the external agent. Currently supported address types: B: Business (The agent's business address)
          - `City` string, required: The city.
          - `Confidential` boolean: True if the address is confidential.
          - `Country` string: The name of the country. This field is read only.
          - `CountryCode` string, required: The two digit ISO code for the country.
          - `Line1` string, required: The first line for the address.
          - `Line2` string: The second line for the address.
          - `Line3` string: The third line for the address.
          - `Line4` string: The fourth line for the address.
          - `PostalCode` string, required: The unformatted postal or zip code.
          - `Province` string: The name of the province or state. This field is read only.
          - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state.
          - `Type` string: The name of the type of address. This field is read only.
          - `TypeCode` string, required: The code for the type of address. P: Physical, M: Mailing, H: Home, B: Business, W: Work, O: Other
        - `PhoneNumbers` PhoneNumber[]: The list of phone numbers for the external agent. Currently supported phone number types: B: Business (The agent's office phone number), BF: Business Fax (The agent's office fax number), H: Home (The agent's home number), M: Mobile (The agent's mobile number)
          - `Confidential` boolean: True if the phone number is confidential.
          - `Extension` string: The extension for the phone number.
          - `Number` string, required: The unformatted phone number.
          - `Primary` boolean: True if this is the primary phone number.
          - `Type` string: The name of the type of phone number.
          - `TypeCode` string, required: The code for the type of phone number. A: Assistant, B: Business, BF: Business Fax, CB: Callback, C: Company, X: Extension, H: Home, HF: Home Fax, ISDN: ISDN, M: Mobile, P: Pager, R: Radio, T: Telex, TF: Toll Free, TTY: TTY/TDD, O: Other, OF: Other Fax
        - `EmailAddresses` EmailAddress[]: The list of email addresses for the external agent. Currently supported email address types: B: Business (The agent's office's email address), W: Work (The agent's work email address)
          - `Address` string, required: The email address.
          - `Confidential` boolean: True if the email address is confidential.
          - `Primary` boolean: True if this is the primary email address.
          - `Type` string: The name of the type of email address.
          - `TypeCode` string, required: The code for the type of email address. H: Home, B: Business, W: Work, S: Secondary, O: Other
        - `RowVersion` integer: The version of the record in the database.
        - `AddressTypeCode` string, required: The code for the type of email address for the external agent. B: Business
      - `CreatedTimestamp` string, date-time: The date and time the commission was created.
      - `ModifiedTimestamp` string, date-time: The date and time the commission was last modified.
      - `RowVersion` integer: The version of the record in the database.
    - `CreatedTimestamp` string, date-time: The date and time the tier was created.
    - `ModifiedTimestamp` string, date-time: The date and time the tier was last modified.
    - `RowVersion` integer: The version of the record in the database.
  - `ClientContacts` ClientContact[]: The list of client contacts for the transaction.
    - `Id` string: The Lone Wolf Id of the client contact for a specific transaction. If you have the same client contact on different transactions, they will have different Id values. Required for updates only. This should be null when creating a new client contact.
    - `CRMId` string: Not implemented yet.
    - `FirstName` string: The first name.
    - `MiddleName` string: Not implemented yet.
    - `LastName` string: The last name.
    - `ContactTypeId` string, required: The Lone Wolf Id of the contact type. This is an Id that is retrieved from the contact types resource. Only ContactType objects with TypeCode C should be used.
    - `ContactType` ContactType
      - `Id` string: The Lone Wolf Id of the contact type.
      - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
      - `Code` string: A code for this contact type. This must be unique within an LWCompanyCode.
      - `Name` string: The name of the contact type (Buyer, Seller, Lawyer, Outside Broker, etc).
      - `CategoryCode` string: The category for the contact type. B: Business contact, C: Client contact, E: External agent
      - `InactiveDate` string, date, nullable: The date the contact type became inactive. (Nullable)
    - `Title` string: Not implemented yet.
    - `Prefix` string: Not implemented yet.
    - `Suffix` string: Not implemented yet.
    - `CompanyName` string: The name of the company for the client contact.
    - `MarketingName` string: Not implemented yet.
    - `NickName` string: The nick name of the client contact.
    - `LegalName` string: Not implemented yet.
    - `FormerName` string: Not implemented yet.
    - `GenderCode` string: Not implemented yet.
    - `Gender` string: Not implemented yet.
    - `SourceOfBusinessId` string: The Lone Wolf Id of the source of business. This is an Id that is retrieved from the sources of business resource. Setting this value to NULL will not clear the source of business for the client contact. You must pass an empty string to clear the source of business.
    - `SourceOfBusiness` SourceOfBusiness
      - `Id` string: The Lone Wolf Id of the source of business.
      - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synched with brokerWOLF.
      - `Code` string: A code for this source of business. This must be unique within an LWCompanyCode.
      - `Name` string: The name of the source of business (Newspaper, Referral, Website, etc).
      - `InactiveDate` string, date, nullable: The date the source of business became inactive. (Nullable)
    - `Addresses` Address[]: The list of addresses for the client contact. Currently supported address types: H: Home (The contact's home address).
      - `City` string, required: The city.
      - `Confidential` boolean: True if the address is confidential.
      - `Country` string: The name of the country. This field is read only.
      - `CountryCode` string, required: The two digit ISO code for the country.
      - `Line1` string, required: The first line for the address.
      - `Line2` string: The second line for the address.
      - `Line3` string: The third line for the address.
      - `Line4` string: The fourth line for the address.
      - `PostalCode` string, required: The unformatted postal or zip code.
      - `Province` string: The name of the province or state. This field is read only.
      - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state.
      - `Type` string: The name of the type of address. This field is read only.
      - `TypeCode` string, required: The code for the type of address. P: Physical, M: Mailing, H: Home, B: Business, W: Work, O: Other
    - `PhoneNumbers` PhoneNumber[]: The list of phone numbers for the client contact. Currently supported phone number types: B: Business (The contact's work number), H: Home (The contact's home number), HF: Home Fax (The contact's home fax number), M: Mobile (The contact's mobile number)
      - `Confidential` boolean: True if the phone number is confidential.
      - `Extension` string: The extension for the phone number.
      - `Number` string, required: The unformatted phone number.
      - `Primary` boolean: True if this is the primary phone number.
      - `Type` string: The name of the type of phone number.
      - `TypeCode` string, required: The code for the type of phone number. A: Assistant, B: Business, BF: Business Fax, CB: Callback, C: Company, X: Extension, H: Home, HF: Home Fax, ISDN: ISDN, M: Mobile, P: Pager, R: Radio, T: Telex, TF: Toll Free, TTY: TTY/TDD, O: Other, OF: Other Fax
    - `EmailAddresses` EmailAddress[]: The list of email addresses for the client contact. Currently supported email address types: H: Home (The contact's home email address).
      - `Address` string, required: The email address.
      - `Confidential` boolean: True if the email address is confidential.
      - `Primary` boolean: True if this is the primary email address.
      - `Type` string: The name of the type of email address.
      - `TypeCode` string, required: The code for the type of email address. H: Home, B: Business, W: Work, S: Secondary, O: Other
    - `CreatedTimestamp` string, date-time: The date and time the client contact was created.
    - `ModifiedTimestamp` string, date-time: The date and time the client contact was last modified.
    - `RowVersion` integer: The version of the record in the database.
    - `SendMovingWolfEmails` boolean: The movingWOLF status of the client contact.
    - `ShouldReceiveMovingWolfEmails` boolean, nullable: The movingWOLF email subscription status of the client contact. This field is not a database field and is calculated based on different values. As such, it is not compatible with OData queries and will return an error if an attempt is made to filter on it. (Nullable)
    - `MovingWolfEmailsSendingAgentId` integer, nullable: The Agent ID of the Agent from which the movingWOLF emails will be sent. This field is not a database field and is calculated based on different values. As such, it is not compatible with OData queries and will return an error if an attempt is made to filter on it. (Nullable)
  - `BusinessContacts` BusinessContact[]: The list of business contacts for the transaction.
    - `Id` string: The Lone Wolf Id of the business contact for a specific transaction. If you have the same business contact on different transactions, they will have different Id values. Required for updates only. It will be ignored when creating a new business contact.
    - `CRMId` string: Not implemented yet.
    - `CRMCompanyContactId` string: Not implemented yet.
    - `FirstName` string: The first name.
    - `MiddleName` string: Not implemented yet.
    - `LastName` string: The last name.
    - `ContactTypeId` string, required: The Lone Wolf Id of the contact type. This is an Id that is retrieved from the contact types resource. Only ContactType objects with TypeCode B should be used.
    - `ContactType` ContactType
      - `Id` string: The Lone Wolf Id of the contact type.
      - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
      - `Code` string: A code for this contact type. This must be unique within an LWCompanyCode.
      - `Name` string: The name of the contact type (Buyer, Seller, Lawyer, Outside Broker, etc).
      - `CategoryCode` string: The category for the contact type. B: Business contact, C: Client contact, E: External agent
      - `InactiveDate` string, date, nullable: The date the contact type became inactive. (Nullable)
    - `EndCode` string, required: The code of the end or side the business contact is used on. L: Listing, S: Selling
    - `End` string: The name of the end or side.
    - `CompanyName` string: The company for the business contact.
    - `Addresses` Address[]: The list of addresses for the business contact. Currently supported address types: B: Business (The contact's business address).
      - `City` string, required: The city.
      - `Confidential` boolean: True if the address is confidential.
      - `Country` string: The name of the country. This field is read only.
      - `CountryCode` string, required: The two digit ISO code for the country.
      - `Line1` string, required: The first line for the address.
      - `Line2` string: The second line for the address.
      - `Line3` string: The third line for the address.
      - `Line4` string: The fourth line for the address.
      - `PostalCode` string, required: The unformatted postal or zip code.
      - `Province` string: The name of the province or state. This field is read only.
      - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state.
      - `Type` string: The name of the type of address. This field is read only.
      - `TypeCode` string, required: The code for the type of address. P: Physical, M: Mailing, H: Home, B: Business, W: Work, O: Other
    - `PhoneNumbers` PhoneNumber[]: The list of phone numbers for the business contact. Currently supported phone number types: B: Business (The contact's office phone number), BF: Business Fax (The contact's office fax number), H: Home (The contact's home number), M: Mobile (The contact's mobile number)
      - `Confidential` boolean: True if the phone number is confidential.
      - `Extension` string: The extension for the phone number.
      - `Number` string, required: The unformatted phone number.
      - `Primary` boolean: True if this is the primary phone number.
      - `Type` string: The name of the type of phone number.
      - `TypeCode` string, required: The code for the type of phone number. A: Assistant, B: Business, BF: Business Fax, CB: Callback, C: Company, X: Extension, H: Home, HF: Home Fax, ISDN: ISDN, M: Mobile, P: Pager, R: Radio, T: Telex, TF: Toll Free, TTY: TTY/TDD, O: Other, OF: Other Fax
    - `EmailAddresses` EmailAddress[]: The list of email addresses for the business contact. Currently supported email address types: B: Business (The contact's business's email address), W: Work (The contact's work email address)
      - `Address` string, required: The email address.
      - `Confidential` boolean: True if the email address is confidential.
      - `Primary` boolean: True if this is the primary email address.
      - `Type` string: The name of the type of email address.
      - `TypeCode` string, required: The code for the type of email address. H: Home, B: Business, W: Work, S: Secondary, O: Other
    - `CreatedTimestamp` string, date-time: The date and time the business contact was created.
    - `ModifiedTimestamp` string, date-time: The date and time the business contact was last modified.
    - `RowVersion` integer: The version of the record in the database.
  - `Conditions` TransactionCondition[]: The list of conditions for the transaction.
    - `Id` string: The Lone Wolf Id of the condition. Required for updates only. It will be ignored when creating a new condition.
    - `Description` string, required: The description of the condition.
    - `DueDate` string, date, nullable: The date the condition must be met. (Nullable)
    - `ApprovedDate` string, date, nullable: The date the condition was approved. (Nullable)
    - `CreatedTimestamp` string, date-time: The date and time the condition was created.
    - `ModifiedTimestamp` string, date-time: The date and time the condition was last modified.
    - `RowVersion` integer: The version of the record in the database.
  - `Task` Task[]: The list of tasks for the transaction.
    - `Id` string: The Lone Wolf Id of the task.
    - `LoadingDocsTaskId` string: The Lone Wolf Id of the loadingDOCS task.
    - `Title` string: The title of the task.
    - `DueDate` string, date: The date the task must be completed by.
    - `Reminder` boolean: True if a reminder has been setup for this task.
    - `ReminderSentTimestamp` string, date-time: The date and time the reminder was sent.
    - `CompletedDate` string, date: The date the task was completed.
    - `CreatedTimestamp` string, date-time: The date and time the task was created.
    - `ModifiedTimestamp` string, date-time: The date and time the task was last modified.
    - `RowVersion` integer: The version of the record in the database.
  - `CreatedTimestamp` string, date-time: The date and time the transaction was created.
  - `ModifiedTimestamp` string, date-time: The date and time the transaction was last modified.
  - `TransactionChangedTimestamp` string, 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.
  - `RowVersion` integer: The version of the record in the database.

## Other responses

- `400`: Error Code 1001: The transaction Id is invalid.
- `404`: The transaction could not be found. The primary office for the transaction must be an office with the Client Code used in the API authentication.

---

[API](https://skmtc.dev/lwolf/apis/wolfconnect-api.md) · [All operations](https://skmtc.dev/lwolf/apis/wolfconnect-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lwolf/apis/wolfconnect-api/revisions/ef84b978ad6f?raw)
