Path parameters

• transactionId string Required

  The Lone Wolf Id of the transaction. This will be the value in the Transaction.Id property when the transaction was created.

Query parameters

• $expand string

  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.

Responses

• 200 application/json

  A Transaction object holding all the updated data.

  Hide response attributes Show response attributes object

  • Id string

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

    Maximum length is 50.

  • 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.

    Maximum length is 15.

  • MLSNumber string

    The MLS number for the listing associated to the transaction.

    Maximum length is 15.

  • PropertyTypeId string Required

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

    Maximum length is 50.

  • PropertyType object

    The property type. See the Property Types API section for the object definition.

    Hide PropertyType attributes Show PropertyType attributes object

    • 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) | null

      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.

    Maximum length is 50.

  • Classification object

    The classification. See the Classifications API section for the object definition.

    Hide Classification attributes Show Classification attributes object

    • 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) | null

      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.

    Maximum length is 100.

  • MLSAddress object Required

    The MLS style address for the transaction. The $expand OData parameter will have no effect on this property; it will always be returned with the transaction data.

    Hide MLSAddress attributes Show MLSAddress attributes object

    • StreetNumber string Required

      The street number.

      Maximum length is 12.

    • StreetName string Required

      The street name.

      Maximum length is 50.

    • StreetDirection string

      The street direction.

      Maximum length is 20.

    • Unit string

      The unit or building number.

      Maximum length is 50.

    • City string Required

      The city.

      Maximum length is 50.

    • ProvinceCode string Required

      The province code or postal abbreviation of the province or state.

      Maximum length is 20.

    • 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.

      Maximum length is 15.

    • CountryCode string Required

      The two character ISO code for the country.

      Maximum length is 2.

    • Country string

      The name of the country.

  • Tiers array[object] Required

    The list of different tiers for the transactions. At least 1 is required.

    Hide Tiers attributes Show Tiers attributes object

    • Id string

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

      Maximum length is 50.

    • Name string

      The name of the tier.

      Maximum length is 1.

    • ClassificationId string Required

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

      Maximum length is 50.

    • Classification object

      The classification. See the Classifications API section for the object definition.

      Hide Classification attributes Show Classification attributes object

      • 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) | null

        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 array[object] Required

      The list of commissions for the tier. At least 1 is required.

      Hide AgentCommissions attributes Show AgentCommissions attributes object

      • Id string

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

        Maximum length is 50.

      • 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.

        Maximum length is 50.

      • 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.

        Maximum length is 50.

      • EndCode string Required

        The code of the end or side for the commission. L: Listing, S: Selling

        Maximum length is 1.

      • 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 object

        The agent getting this commission.

        Hide Agent attributes Show Agent attributes object

        • 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 object

        The team leader for this commission record.

        Hide TeamLeader attributes Show TeamLeader attributes object

        • 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(int64)

        The version of the record in the database.

    • ExternalAgentCommissions array[object]

      The list of external agent commissions for the tier.

      Hide ExternalAgentCommissions attributes Show ExternalAgentCommissions attributes object

      • 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.

        Maximum length is 50.

      • 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.

        Maximum length is 50.

      • 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 object Required

        The external agent getting this commission. The ExternalAgent property is required when creating a new external agent commission. If changes need to be made to the external agent associated to the external agent commission, then include the ExternalAgent property when updating the ExternalAgentCommission object. If you do not need to update the external agent leave the ExternalAgent property NULL as you normally would.

        Hide ExternalAgent attributes Show ExternalAgent attributes object

        • 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.

          Maximum length is 50.

        • CRMId string

          Not implemented yet.

          Maximum length is 50.

        • CRMCompanyContactId string

          Not implemented yet.

          Maximum length is 50.

        • FirstName string

          The first name.

          Maximum length is 200.

        • MiddleName string

          Not implemented yet.

          Maximum length is 200.

        • LastName string

          The last name.

          Maximum length is 200.

        • 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.

          Maximum length is 50.

        • ContactType object

          The contact type. See the Contact Types API section for the object definition.

          Hide ContactType attributes Show ContactType attributes object

          • 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) | null

            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

          Maximum length is 1.

        • End string

          The name of the end or side.

        • CompanyName string

          The business contact's company.

          Maximum length is 200.

        • Addresses array[object]

          The list of addresses for the external agent. Currently supported address types: B: Business (The agent's business address)

          Hide Addresses attributes Show Addresses attributes object

          • City string Required

            The city.

            Maximum length is 50.

          • 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.

            Maximum length is 2.

          • Line1 string Required

            The first line for the address.

            Maximum length is 200.

          • Line2 string

            The second line for the address.

            Maximum length is 200.

          • Line3 string

            The third line for the address.

            Maximum length is 200.

          • Line4 string

            The fourth line for the address.

            Maximum length is 200.

          • PostalCode string Required

            The unformatted postal or zip code.

            Maximum length is 20.

          • 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.

            Maximum length is 20.

          • 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

            Maximum length is 1.

        • PhoneNumbers array[object]

          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)

          Hide PhoneNumbers attributes Show PhoneNumbers attributes object

          • Confidential boolean

            True if the phone number is confidential.

          • Extension string

            The extension for the phone number.

            Maximum length is 5.

          • Number string Required

            The unformatted phone number.

            Maximum length is 20.

          • 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

            Maximum length is 1.

        • EmailAddresses array[object]

          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)

          Hide EmailAddresses attributes Show EmailAddresses attributes object

          • Address string Required

            The email address.

            Maximum length is 100.

          • 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

            Maximum length is 1.

        • RowVersion integer(int64)

          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

          Maximum length is 1.

      • 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(int64)

        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(int64)

      The version of the record in the database.

  • ClientContacts array[object]

    The list of client contacts for the transaction.

    Hide ClientContacts attributes Show ClientContacts attributes object

    • 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.

      Maximum length is 50.

    • CRMId string

      Not implemented yet.

      Maximum length is 50.

    • FirstName string

      The first name.

      Maximum length is 200.

    • MiddleName string

      Not implemented yet.

      Maximum length is 200.

    • LastName string

      The last name.

      Maximum length is 200.

    • 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.

      Maximum length is 50.

    • ContactType object

      The contact type. See the Contact Types API section for the object definition.

      Hide ContactType attributes Show ContactType attributes object

      • 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) | null

        The date the contact type became inactive. (Nullable)

    • Title string

      Not implemented yet.

      Maximum length is 100.

    • Prefix string

      Not implemented yet.

      Maximum length is 20.

    • Suffix string

      Not implemented yet.

      Maximum length is 20.

    • CompanyName string

      The name of the company for the client contact.

      Maximum length is 40.

    • MarketingName string

      Not implemented yet.

      Maximum length is 200.

    • NickName string

      The nick name of the client contact.

      Maximum length is 50.

    • LegalName string

      Not implemented yet.

      Maximum length is 200.

    • FormerName string

      Not implemented yet.

      Maximum length is 200.

    • GenderCode string

      Not implemented yet.

      Maximum length is 1.

    • 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.

      Maximum length is 50.

    • SourceOfBusiness object

      The source of business. See the Sources of Business API section for the object definition.

      Hide SourceOfBusiness attributes Show SourceOfBusiness attributes object

      • 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) | null

        The date the source of business became inactive. (Nullable)

    • Addresses array[object]

      The list of addresses for the client contact. Currently supported address types: H: Home (The contact's home address).

      Hide Addresses attributes Show Addresses attributes object

      • City string Required

        The city.

        Maximum length is 50.

      • 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.

        Maximum length is 2.

      • Line1 string Required

        The first line for the address.

        Maximum length is 200.

      • Line2 string

        The second line for the address.

        Maximum length is 200.

      • Line3 string

        The third line for the address.

        Maximum length is 200.

      • Line4 string

        The fourth line for the address.

        Maximum length is 200.

      • PostalCode string Required

        The unformatted postal or zip code.

        Maximum length is 20.

      • 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.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • PhoneNumbers array[object]

      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)

      Hide PhoneNumbers attributes Show PhoneNumbers attributes object

      • Confidential boolean

        True if the phone number is confidential.

      • Extension string

        The extension for the phone number.

        Maximum length is 5.

      • Number string Required

        The unformatted phone number.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • EmailAddresses array[object]

      The list of email addresses for the client contact. Currently supported email address types: H: Home (The contact's home email address).

      Hide EmailAddresses attributes Show EmailAddresses attributes object

      • Address string Required

        The email address.

        Maximum length is 100.

      • 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

        Maximum length is 1.

    • 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(int64)

      The version of the record in the database.

    • SendMovingWolfEmails boolean

      The movingWOLF status of the client contact.

    • ShouldReceiveMovingWolfEmails boolean | null

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

      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 array[object]

    The list of business contacts for the transaction.

    Hide BusinessContacts attributes Show BusinessContacts attributes object

    • 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.

      Maximum length is 50.

    • CRMId string

      Not implemented yet.

      Maximum length is 50.

    • CRMCompanyContactId string

      Not implemented yet.

      Maximum length is 50.

    • FirstName string

      The first name.

      Maximum length is 200.

    • MiddleName string

      Not implemented yet.

      Maximum length is 200.

    • LastName string

      The last name.

      Maximum length is 200.

    • 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.

      Maximum length is 50.

    • ContactType object

      The contact type. See the Contact Types API section for the object definition.

      Hide ContactType attributes Show ContactType attributes object

      • 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) | null

        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

      Maximum length is 1.

    • End string

      The name of the end or side.

    • CompanyName string

      The company for the business contact.

      Maximum length is 200.

    • Addresses array[object]

      The list of addresses for the business contact. Currently supported address types: B: Business (The contact's business address).

      Hide Addresses attributes Show Addresses attributes object

      • City string Required

        The city.

        Maximum length is 50.

      • 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.

        Maximum length is 2.

      • Line1 string Required

        The first line for the address.

        Maximum length is 200.

      • Line2 string

        The second line for the address.

        Maximum length is 200.

      • Line3 string

        The third line for the address.

        Maximum length is 200.

      • Line4 string

        The fourth line for the address.

        Maximum length is 200.

      • PostalCode string Required

        The unformatted postal or zip code.

        Maximum length is 20.

      • 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.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • PhoneNumbers array[object]

      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)

      Hide PhoneNumbers attributes Show PhoneNumbers attributes object

      • Confidential boolean

        True if the phone number is confidential.

      • Extension string

        The extension for the phone number.

        Maximum length is 5.

      • Number string Required

        The unformatted phone number.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • EmailAddresses array[object]

      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)

      Hide EmailAddresses attributes Show EmailAddresses attributes object

      • Address string Required

        The email address.

        Maximum length is 100.

      • 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

        Maximum length is 1.

    • 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(int64)

      The version of the record in the database.

  • Conditions array[object]

    The list of conditions for the transaction.

    Hide Conditions attributes Show Conditions attributes object

    A condition attached to a transaction. Note: this differs from the Condition lookup object returned by the Conditions API.

    Please see the Creating and Updating Data section of the introduction for more information on how to handle the DueDate and ApprovedDate properties.

    • 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) | null

      The date the condition must be met. (Nullable)

    • ApprovedDate string(date) | null

      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(int64)

      The version of the record in the database.

  • Task array[object]

    The list of tasks for the transaction.

    Hide Task attributes Show Task attributes object

    Tasks cannot currently be updated by the Transactions API. They will be ignored in any resource call to create or update a 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(int64)

      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(int64)

    The version of the record in the database.

• 400 application/json

  Error Code 1006: Validation failed. See the Details property of the response for information on why the validation failed. Error Code 1008: Invalid operation. This occurs when attempting to update or create an object without the required permission. For instance, if you don't have create permission for Conditions but you pass through a list of Conditions in the Transaction.Conditions property or if you attempt to update the Transaction.CloseDate but do not have edit permissions for that field. See the Details property of the response for more information.

  Hide response attributes Show response attributes object

  • Code integer

    The Lone Wolf Error Code. See the Error Codes section of the introduction.

  • Message string

    The message that corresponds to the Code value.

  • Details string

    The exact problem that occurred to give this error response.

• 404 application/json

  Either the transaction or a child object was not found. For instance, if you attempt to set the classification of a transaction with a ClassificationId that does not exist. The primary office for the transaction must be an office with the Client Code used in the API authentication.

  Hide response attributes Show response attributes object

  • Code integer

    The Lone Wolf Error Code. See the Error Codes section of the introduction.

  • Message string

    The message that corresponds to the Code value.

  • Details string

    The exact problem that occurred to give this error response.