Update Transaction

PATCH /v1/transactions/{transactionId}

Path parameters

transactionId string(uuid) Required

The id of the transaction.

application/json

Body

The properties of the transaction to update.

number string | null

The number assigned to the transaction.
mlsNumber string | null

The MLS number for the listing associated to the transaction.
statusCode string | null

The code for the status of the transaction.

Values are C, D, F, O, P, or X.
addressStreetNumber string | null

The street number.
addressStreetName string | null

The street name.
addressStreetDirection string | null

The street direction.
addressUnitNumber string | null

The unit number.
addressCity string | null

The city.
addressProvinceCode string | null

The two character state or province code.
addressPostalCode string | null

The postal code. This will be unformatted.
offerDate string(date) | null

The date of the offer that started the transaction.
closeDate string(date) | null

The date the transaction closed.
entryDate string(date) | null

The date the transaction was put into the system.
firmDate string(date) | null

The date the transaction was firmed up, meaning all conditions were met and the transaction is moving forward.
finalizeDate string(date) | null

The date the transaction was finalized, meaning all the agents were paid.
legalDescription string | null

The legal description of the property related to the transaction.
closePrice number(double)

The price.
classificationId string(uuid) | null

The unique id of the classification associated with this transaction.
propertyTypeId string(uuid) | null

The unique id of the property type associated with this transaction.

Responses

200 application/json

Request succeeded.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique id.
- createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
- modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
- number string | null
  
  The number assigned to the transaction.
- mlsNumber string | null
  
  The MLS number for the listing associated to the transaction.
- statusCode string | null
  
  The code for the status of the transaction.
  
  Values are C, D, F, O, P, or X.
- addressStreetNumber string | null
  
  The street number.
- addressStreetName string | null
  
  The street name.
- addressStreetDirection string | null
  
  The street direction.
- addressUnitNumber string | null
  
  The unit number.
- addressCity string | null
  
  The city.
- addressProvinceCode string | null
  
  The two character state or province code.
- addressPostalCode string | null
  
  The postal code. This will be unformatted.
- offerDate string(date) | null
  
  The date of the offer that started the transaction.
- closeDate string(date) | null
  
  The date the transaction closed.
- entryDate string(date) | null
  
  The date the transaction was put into the system.
- firmDate string(date) | null
  
  The date the transaction was firmed up, meaning all conditions were met and the transaction is moving forward.
- finalizeDate string(date) | null
  
  The date the transaction was finalized, meaning all the agents were paid.
- legalDescription string | null
  
  The legal description of the property related to the transaction.
- closePrice number(double)
  
  The price.
- classificationId string(uuid) | null
  
  The unique id of the classification associated with this transaction.
- propertyTypeId string(uuid) | null
  
  The unique id of the property type associated with this transaction.
- classification object
  
  A read only representation of a transaction classification.
  
  Additional properties are NOT allowed.
  
  Hide classification attributes Show classification attributes object
  
  name string | null
  
  The name of the classification.
  
  code string | null
  
  The code for the classification.
  
  endCount number(double)
  
  The total number of ends or sides this classification represents. This value will be either 0, 1 or 2.
  
  Minimum value is 0, maximum value is 2.
  
  endTypeCode string | null
  
  The code representing the end or side for the classification.
  
  Values are B, D, M, S, or X.
- propertyType object
  
  A read only representation of a property type.
  
  Additional properties are NOT allowed.
  
  Hide propertyType attributes Show propertyType attributes object
  
  name string | null
  
  The name of the property type.
  
  shortName string | null
  
  The short name of the property type.
  
  code string | null
  
  The unique code of the property type.
  
  classCode string | null
  
  The code for the class of property type. This will be either "C" for commercial or "R" for residential.
  
  Values are C or R.
  
  rental boolean
  
  Indicates whether the property type is for rental property transactions.
- conditions array[object] | null
  
  A collection of all the conditions.
  
  Represents a condition on a transaction.
  
  Hide conditions attributes Show conditions attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  description string Required
  
  A description of the commission.
  
  dueDate string(date) Required
  
  The date the condition is due.
  
  completeDate string(date) | null
  
  The date the condition was completed.
- deposits array[object] | null
  
  A collection of all the deposits.
  
  Represents a deposit associated to a transaction.
  
  Hide deposits attributes Show deposits attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  date string(date) Required
  
  The date the deposit was received.
  
  amount number(currency) Required
  
  The amount of the deposit.
  
  received boolean
  
  If the deposit has been received or not.
  
  interest boolean
  
  If the deposit accumulates interest.
  
  held boolean
  
  If the deposit is held or not.
  
  heldBy string | null
  
  Who the deposit is held by.
  
  direct boolean
  
  If the deposit is direct or not.
  
  reference string | null
  
  The reference number for the deposit.
- tiers array[object] | null
  
  A collection of all the tiers.
  
  Represents a sub transaction.
  
  Hide tiers attributes Show tiers attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  name string Required
  
  The name of the tier.
  
  closePrice number(double)
  
  The close price for the tier.
  
  closeDate string(date) | null
  
  The date the tier closed.
  
  statusCode string | null
  
  The code for the status of the tier.
  
  Values are C, F, O, or X.
  
  classificationId string(uuid) | null
  
  The unique id of the classification associated with this tier.
  
  sellingCommissionAmount number(currency)
  
  The total commission amount for the selling end or side of the tier.
  
  sellingCommissionPercentage number(double)
  
  The commission percentage for the selling end or side of the tier. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  sellingCommissionCalculationMethodCode string | null
  
  The code representing the method used to calculate the selling commission.
  
  Values are A or P.
  
  buyingCommissionAmount number(currency)
  
  The total commission amount for the buying end or side of the tier.
  
  buyingCommissionPercentage number(double)
  
  The commission percentage for the buying end or side of the tier. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  buyingCommissionCalculationMethodCode string | null
  
  The code representing the method used to calculate the buying commission.
  
  Values are A or P.
  
  classification object
  
  A read only representation of a transaction classification.
  
  Additional properties are NOT allowed.
  
  Hide classification attributes Show classification attributes object
  
  name string | null
  
  The name of the classification.
  
  code string | null
  
  The code for the classification.
  
  endCount number(double)
  
  The total number of ends or sides this classification represents. This value will be either 0, 1 or 2.
  
  Minimum value is 0, maximum value is 2.
  
  endTypeCode string | null
  
  The code representing the end or side for the classification.
  
  Values are B, D, M, S, or X.
  
  commissions array[object] | null
  
  A collection of commissions associated with the tier.
  
  Represents a commission for an agent on a transaction.
  
  Hide commissions attributes Show commissions attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  agentId string(uuid) Required
  
  The unique id of the agent that gets the commission.
  
  officeId string(uuid)
  
  The unique id of the office with which the agent is associated.
  
  amount number(currency)
  
  The total commission amount the agent is receiving. This includes any fees that were subtracted.
  
  percentage number(double)
  
  The percentage of the total commission for the agent. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  endCode string Required
  
  The code representing the end or side of the transaction.
  
  Values are B or S.
  
  endCount number(double) Required
  
  The total number of ends or sides this commission represents.
  
  Minimum value is 0, maximum value is 2.
  
  calculationMethodCode string | null
  
  The code representing the calculation method used for the commission. This will be "A" for amount or "P" for percentage.
  
  Values are A or P.
  
  taxAmount number(currency)
  
  The total amount in tax applied to the commission.
  
  totalFeeAmount number(currency)
  
  The total amount of fees applied to the commission.
  
  totalFeeTaxAmount number(currency)
  
  The total amount in tax applied to just the fees for the commission.
  
  fees array[object] | null
  
  The list of fees associated with the commission.
  
  Represents a fee that is related to a commission.
  
  Hide fees attributes Show fees attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  percentage number(double)
  
  The percentage of the commission. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  amount number(currency)
  
  The amount of the fee.
  
  calculationMethodCode string | null
  
  The code for the method used to calculate the fee.
  
  Values are A or P.
  
  taxAmount number(currency)
  
  The amount of tax applied to the fee.
  
  taxPercentage number(double)
  
  The tax rate applied to the fee. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  paymentMethodCode string | null
  
  The code for the method used to pay the fee.
  
  fee object
  
  A read only representation of a fee associated with a transaction.
  
  Additional properties are NOT allowed.
  
  Hide fee attributes Show fee attributes object
  
  shortName string | null
  
  The short name of the fee.
  
  name string | null
  
  The name of the fee.
  
  agent object
  
  A read only representation of an agent.
  
  Additional properties are NOT allowed.
  
  Hide agent attributes Show agent attributes object
  
  firstName string | null
  
  The first name of the agent.
  
  middleName string | null
  
  The middle name of the agent.
  
  lastName string | null
  
  The last name of the agent.
  
  office object
  
  A read only representation of an office.
  
  Additional properties are NOT allowed.
  
  Hide office attributes Show office attributes object
  
  name string | null
  
  The name of the office.
  
  code string | null
  
  The code for the office.
  
  externalCommissions array[object] | null
  
  A collection of external commissions associated with the tier.
  
  Represents a commission paid to an external agent involved in a transaction.
  
  Hide externalCommissions attributes Show externalCommissions attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  endCode string Required
  
  The code for the end or side of the transaction.
  
  Values are B or S.
  
  percentage number(double)
  
  The percentage of the commission paid to the external agent. This will be specified as a decimal. For example, 5% will be specified as 0.05.
  
  amount number(currency)
  
  The amount of the commission paid to the external agent.
  
  calculationMethodCode string | null
  
  The code for the method used to calculate the commission.
  
  Values are A or P.
  
  paymentMethodCode string | null
  
  The code for the method of payment for the commission.
  
  Values are B, N, or E.
  
  externalAgentId string(uuid) Required
  
  The unique id of the external agent associated with this commission.
  
  externalAgent object
  
  Represents an agent involved in the transaction that does not work for the brokerage.
  
  Additional properties are NOT allowed.
  
  Hide externalAgent attributes Show externalAgent attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  endCode string Required
  
  The code end or side of the transaction.
  
  Values are B or S.
  
  typeCode string Required
  
  The code for the type of external agent this is. This will be either "B" for outside broker or "R" for referral.
  
  Values are B or R.
  
  paymentMethodCode string | null
  
  The code for the method use to pay the external agent.
  
  Values are B, N, or E.
  
  firstName string Required
  
  The first name of the external agent.
  
  lastName string Required
  
  The last name of the external agent.
  
  companyName string | null
  
  The name of the company for which the external agent works.
  
  addressLine1 string | null
  
  The street address.
  
  addressLine2 string | null
  
  The address unit number.
  
  addressCity string | null
  
  The city of the address.
  
  addressPostalCode string | null
  
  The postal code of the address. This will be unformatted.
  
  addressProvinceCode string | null
  
  The two character state or province code.
  
  addressCountryCode string | null
  
  The two character country code.
  
  phoneNumberMain string | null
  
  The external agent's main phone number.
  
  phoneNumberBusiness string | null
  
  The external agent's business phone number.
  
  faxNumberMain string | null
  
  The external agent's main fax number.
  
  emailAddressMain string | null
  
  The external agent's main email address.
  
  emailAddressBusiness string | null
  
  The external agent's business email address.
- externalAgents array[object] | null
  
  A collection of all the external agents.
  
  Represents an agent involved in the transaction that does not work for the brokerage.
  
  Hide externalAgents attributes Show externalAgents attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  endCode string Required
  
  The code end or side of the transaction.
  
  Values are B or S.
  
  typeCode string Required
  
  The code for the type of external agent this is. This will be either "B" for outside broker or "R" for referral.
  
  Values are B or R.
  
  paymentMethodCode string | null
  
  The code for the method use to pay the external agent.
  
  Values are B, N, or E.
  
  firstName string Required
  
  The first name of the external agent.
  
  lastName string Required
  
  The last name of the external agent.
  
  companyName string | null
  
  The name of the company for which the external agent works.
  
  addressLine1 string | null
  
  The street address.
  
  addressLine2 string | null
  
  The address unit number.
  
  addressCity string | null
  
  The city of the address.
  
  addressPostalCode string | null
  
  The postal code of the address. This will be unformatted.
  
  addressProvinceCode string | null
  
  The two character state or province code.
  
  addressCountryCode string | null
  
  The two character country code.
  
  phoneNumberMain string | null
  
  The external agent's main phone number.
  
  phoneNumberBusiness string | null
  
  The external agent's business phone number.
  
  faxNumberMain string | null
  
  The external agent's main fax number.
  
  emailAddressMain string | null
  
  The external agent's main email address.
  
  emailAddressBusiness string | null
  
  The external agent's business email address.
- clientContacts array[object] | null
  
  A collection of all the client contacts.
  
  Represents a buyer or seller on a transaction. For companies or business contacts, see Business Contact.
  
  Hide clientContacts attributes Show clientContacts attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  contactTypeId string(uuid) Required
  
  The unique id of the contact type.
  
  endCode string Required
  
  The end or side of the transaction with which the contact is associated.
  
  Values are B or S.
  
  prefix string | null
  
  The prefix for the contact, such as Mr., Mrs., Ms., Dr., etc.
  
  firstName string Required
  
  The first name of the contact.
  
  lastName string Required
  
  The last name of the contact.
  
  companyName string | null
  
  The name of the company if the buyer or seller is a company and not an individual.
  
  addressLine1 string | null
  
  The full street address for the company of the contact.
  
  addressLine2 string | null
  
  The second line of the street address, if applicable (e.g., suite number).
  
  addressCity string | null
  
  The city of the contact's address.
  
  addressPostalCode string | null
  
  The postal code of the contact's address. This will be unformatted.
  
  addressProvinceCode string | null
  
  The two character code for the province or state.
  
  addressCountryCode string | null
  
  The two character code for the country of the contact's address.
  
  phoneNumberMain string | null
  
  The main phone number for the contact. This will be unformatted.
  
  phoneNumberBusiness string | null
  
  The phone number of the business for the contact. This will be unformatted.
  
  phoneNumberMobile string | null
  
  The mobile or cell phone number for the contact. This will be unformatted.
  
  faxNumberMain string | null
  
  The main fax number for the contact. This will be unformatted.
  
  emailAddressMain string | null
  
  The main email address of the contact.
  
  emailAddressWork string | null
  
  The main email address of the contact.
  
  contactType object
  
  A read only representation of a contact type.
  
  Additional properties are NOT allowed.
  
  Hide contactType attributes Show contactType attributes object
  
  name string | null
  
  The name of the contact type.
  
  code string | null
  
  The unique code for the contact type.
- businessContacts array[object] | null
  
  A collection of all the business contacts.
  
  Represents a company or business contact like a Lawyer or Title Company. See client contacts for buyers and sellers.
  
  Hide businessContacts attributes Show businessContacts attributes object
  
  id string(uuid)
  
  The unique id.
  
  createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
  
  modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
  
  contactTypeId string(uuid) Required
  
  The unique id of the contact type.
  
  endCode string Required
  
  The end or side of the transaction with which the contact is associated.
  
  Values are B or S.
  
  prefix string | null
  
  The prefix for the contact, such as Mr., Mrs., Ms., Dr., etc.
  
  firstName string Required
  
  The first name of the contact.
  
  lastName string Required
  
  The last name of the contact.
  
  companyName string | null
  
  The name of the company.
  
  addressLine1 string | null
  
  The full street address for the company of the contact.
  
  addressLine2 string | null
  
  The second line of the street address, if applicable (e.g., suite number).
  
  addressCity string | null
  
  The city of the contact's address.
  
  addressPostalCode string | null
  
  The postal code of the contact's address. This will be unformatted.
  
  addressProvinceCode string | null
  
  The two character code for the province or state.
  
  addressCountryCode string | null
  
  The two character code for the country of the contact's address.
  
  phoneNumberMain string | null
  
  The main phone number for the contact. This will be unformatted.
  
  phoneNumberBusiness string | null
  
  The phone number of the business for the contact. This will be unformatted.
  
  phoneNumberMobile string | null
  
  The mobile or cell phone number for the contact. This will be unformatted.
  
  faxNumberMain string | null
  
  The main fax number for the contact. This will be unformatted.
  
  emailAddressMain string | null
  
  The main email address of the contact.
  
  emailAddressWork string | null
  
  The main email address of the contact.
  
  contactType object
  
  A read only representation of a contact type.
  
  Additional properties are NOT allowed.
  
  Hide contactType attributes Show contactType attributes object
  
  name string | null
  
  The name of the contact type.
  
  code string | null
  
  The unique code for the contact type.
400 application/json

Invalid request. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
401 application/json

Unauthorized. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
403 application/json

Permission denied. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
404 application/json

Not found. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
422 application/json

Validation failed. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.

PATCH /v1/transactions/{transactionId}

curl \
 --request PATCH 'https://api.lwolf.com/backoffice/v1/transactions/{transactionId}' \
 --header "Content-Type: application/json" \
 --data '{"number":"string","firmDate":"string","closeDate":"string","entryDate":"string","mlsNumber":"string","offerDate":"string","closePrice":0,"statusCode":"C","addressCity":"string","finalizeDate":"string","propertyTypeId":"string","classificationId":"string","legalDescription":"string","addressPostalCode":"string","addressStreetName":"string","addressUnitNumber":"string","addressProvinceCode":"string","addressStreetNumber":"string","addressStreetDirection":"string"}'

Request example

{
  "number": "string",
  "firmDate": "string",
  "closeDate": "string",
  "entryDate": "string",
  "mlsNumber": "string",
  "offerDate": "string",
  "closePrice": 0,
  "statusCode": "C",
  "addressCity": "string",
  "finalizeDate": "string",
  "propertyTypeId": "string",
  "classificationId": "string",
  "legalDescription": "string",
  "addressPostalCode": "string",
  "addressStreetName": "string",
  "addressUnitNumber": "string",
  "addressProvinceCode": "string",
  "addressStreetNumber": "string",
  "addressStreetDirection": "string"
}

Response examples (200)

{
  "id": "string",
  "tiers": [
    {
      "id": "string",
      "name": "string",
      "closeDate": "string",
      "closePrice": 0,
      "statusCode": "C",
      "commissions": [
        {
          "id": "string",
          "fees": [
            {
              "id": "string",
              "fee": {
                "name": "string",
                "shortName": "string"
              },
              "amount": 0,
              "taxAmount": 0,
              "percentage": 0,
              "taxPercentage": 0,
              "createdTimestamp": "string",
              "modifiedTimestamp": "string",
              "paymentMethodCode": "string",
              "calculationMethodCode": "A"
            }
          ],
          "agent": {
            "lastName": "string",
            "firstName": "string",
            "middleName": "string"
          },
          "amount": 0,
          "office": {
            "code": "string",
            "name": "string"
          },
          "agentId": "string",
          "endCode": "B",
          "endCount": 0,
          "officeId": "string",
          "taxAmount": 0,
          "percentage": 0,
          "totalFeeAmount": 0,
          "createdTimestamp": "string",
          "modifiedTimestamp": "string",
          "totalFeeTaxAmount": 0,
          "calculationMethodCode": "A"
        }
      ],
      "classification": {
        "code": "string",
        "name": "string",
        "endCount": 0,
        "endTypeCode": "B"
      },
      "classificationId": "string",
      "createdTimestamp": "string",
      "modifiedTimestamp": "string",
      "externalCommissions": [
        {
          "id": "string",
          "amount": 0,
          "endCode": "B",
          "percentage": 0,
          "externalAgent": {
            "id": "string",
            "endCode": "B",
            "lastName": "string",
            "typeCode": "B",
            "firstName": "string",
            "addressCity": "string",
            "companyName": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "faxNumberMain": "string",
            "phoneNumberMain": "string",
            "createdTimestamp": "string",
            "emailAddressMain": "string",
            "addressPostalCode": "string",
            "modifiedTimestamp": "string",
            "paymentMethodCode": "B",
            "addressCountryCode": "string",
            "addressProvinceCode": "string",
            "phoneNumberBusiness": "string",
            "emailAddressBusiness": "string"
          },
          "externalAgentId": "string",
          "createdTimestamp": "string",
          "modifiedTimestamp": "string",
          "paymentMethodCode": "B",
          "calculationMethodCode": "A"
        }
      ],
      "buyingCommissionAmount": 0,
      "sellingCommissionAmount": 0,
      "buyingCommissionPercentage": 0,
      "sellingCommissionPercentage": 0,
      "buyingCommissionCalculationMethodCode": "A",
      "sellingCommissionCalculationMethodCode": "A"
    }
  ],
  "number": "string",
  "deposits": [
    {
      "id": "string",
      "date": "string",
      "held": true,
      "amount": 0,
      "direct": true,
      "heldBy": "string",
      "interest": true,
      "received": true,
      "reference": "string",
      "createdTimestamp": "string",
      "modifiedTimestamp": "string"
    }
  ],
  "firmDate": "string",
  "closeDate": "string",
  "entryDate": "string",
  "mlsNumber": "string",
  "offerDate": "string",
  "closePrice": 0,
  "conditions": [
    {
      "id": "string",
      "dueDate": "string",
      "description": "string",
      "completeDate": "string",
      "createdTimestamp": "string",
      "modifiedTimestamp": "string"
    }
  ],
  "statusCode": "C",
  "addressCity": "string",
  "finalizeDate": "string",
  "propertyType": {
    "code": "string",
    "name": "string",
    "rental": true,
    "classCode": "C",
    "shortName": "string"
  },
  "classification": {
    "code": "string",
    "name": "string",
    "endCount": 0,
    "endTypeCode": "B"
  },
  "clientContacts": [
    {
      "id": "string",
      "prefix": "string",
      "endCode": "B",
      "lastName": "string",
      "firstName": "string",
      "addressCity": "string",
      "companyName": "string",
      "contactType": {
        "code": "string",
        "name": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "contactTypeId": "string",
      "faxNumberMain": "string",
      "phoneNumberMain": "string",
      "createdTimestamp": "string",
      "emailAddressMain": "string",
      "emailAddressWork": "string",
      "addressPostalCode": "string",
      "modifiedTimestamp": "string",
      "phoneNumberMobile": "string",
      "addressCountryCode": "string",
      "addressProvinceCode": "string",
      "phoneNumberBusiness": "string"
    }
  ],
  "externalAgents": [
    {
      "id": "string",
      "endCode": "B",
      "lastName": "string",
      "typeCode": "B",
      "firstName": "string",
      "addressCity": "string",
      "companyName": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "faxNumberMain": "string",
      "phoneNumberMain": "string",
      "createdTimestamp": "string",
      "emailAddressMain": "string",
      "addressPostalCode": "string",
      "modifiedTimestamp": "string",
      "paymentMethodCode": "B",
      "addressCountryCode": "string",
      "addressProvinceCode": "string",
      "phoneNumberBusiness": "string",
      "emailAddressBusiness": "string"
    }
  ],
  "propertyTypeId": "string",
  "businessContacts": [
    {
      "id": "string",
      "prefix": "string",
      "endCode": "B",
      "lastName": "string",
      "firstName": "string",
      "addressCity": "string",
      "companyName": "string",
      "contactType": {
        "code": "string",
        "name": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "contactTypeId": "string",
      "faxNumberMain": "string",
      "phoneNumberMain": "string",
      "createdTimestamp": "string",
      "emailAddressMain": "string",
      "emailAddressWork": "string",
      "addressPostalCode": "string",
      "modifiedTimestamp": "string",
      "phoneNumberMobile": "string",
      "addressCountryCode": "string",
      "addressProvinceCode": "string",
      "phoneNumberBusiness": "string"
    }
  ],
  "classificationId": "string",
  "createdTimestamp": "string",
  "legalDescription": "string",
  "addressPostalCode": "string",
  "addressStreetName": "string",
  "addressUnitNumber": "string",
  "modifiedTimestamp": "string",
  "addressProvinceCode": "string",
  "addressStreetNumber": "string",
  "addressStreetDirection": "string"
}

Response examples (400)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (401)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (403)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (404)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (422)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}