ValuationComparable Class - quandis/qbo3-Documentation GitHub Wiki

The Mortgage module's ValuationComparable table is based on the MISMO data dictionary standard.

ValuationComparable properties

Column Type Required Description
Active string
ActiveStatus string
Address string Address of comparable.
Adjustments double Total of monetary adjustments to property.
AmenityLedgerID integer Foreign key to ledger use to adjust comparable values.
AttachmentID integer Foreign key to attachment containing comp information.
Basement boolean Flag indicating a finished basement.
BasementFinished double Square feet associated with a finished basement.
Batch integer
BestValue boolean Flag indicating the best comparable to the Valuation.
CanDelete string
CanInsert string
CanUpdate string
Carport double Deprecated.
City string City of comparable.
Comments string Comments regarding comparable.
Concessions string Concessions given by seller for the comparable.
Condition string Brief text description of the condition of the comparable.
ConstructionQuality double Deprecated.
Cooling double Deprecated.
CreatedDate dateTime
CreatedPersonID integer
DataSource string Data source used to gather comparable data (e.g. name of an MLS).
DaysOnMarket integer Depricated; use ListingDateOriginal to calculate DOM.
Deck double Deprecated.
EnergyEfficientItems double Deprecated.
FinalStatus string
FinanceType string Financing type used for sale comparables.
Form string
FunctionalUtility double Deprecated.
Garage double Deprecated.
GrossLivingArea double Square feet of usable living area in comparable.
Heating double Deprecated.
InDecisionID string
InImportFileID string
Latitude double Latitude of comparable.
LinkedFrom string
LinkedTo string
ListingAmount double Amount the comparable is/was listed for.
ListingAmountOriginal double Original list price for the comparable.
ListingDate dateTime Date the comparable was listed (most recent list price adjustment).
ListingDateOriginal dateTime Original list date for the comparable (ListingDateOriginal - today = time on market).
ListingUrl string URL to the listing record (typically an MLS website).
Location string Brief text description of neighborhood location.
Longitude double Longitude of comparable.
LotSize double Square feet of land associated with comparable.
NotLinkedFrom string
NotLinkedTo string
Patio double Deprecated.
Porch double Deprecated.
PostalCode string Postal/zip code of comparable.
PriorSales boolean Flag indicating that prior sales of this comparable have occurred.
PropertyBuilt dateTime Date the property construction was completed.
PropertyType string Enumerated type (e.g. 'Single Family Residence'
Proximity double Distance between comparable and subject property.
RoomsBath double Number of bathrooms in the comparable.
RoomsBedroom double Number of bedrooms in the comparable.
RoomsBelowGrade double Number of rooms below grade in the comparable.
RoomsTotal double Number of livable rooms in the comparable.
SaleDate dateTime Date the comparable most recently sold.
SaleLocation string Location of the sale.
SalePrice double Price this comparable most recently sold for.
Site double Deprecated.
SiteDesign double Deprecated.
SiteView double Deprecated.
SquareFeet double Square feet of structure of comparable.
State string State of comparable.
Status string
Tags string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
ValuationComparable string yes Brief text description of the comparable (e.g. 'Listing Comp 1', 'Sale Comp 2')
ValuationComparableID integer yes Primary Key.
ValuationComparableType string Enumerated type (e.g. 'Listing', 'Sale')
ValuationID integer Foreign key to Valuation that this comparable applies to.
VerificationSource string Source used to verify comparable data.
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
Attachment qbo.Attachment.AttachmentObject Foreign Key
Attachments Attachment Child
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Decisions Decision Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Valuation qbo.Mortgage.ValuationObject Foreign Key
Worklists SmartWorklistMember Child

Method signatures

Mortgage/ValuationComparable.ashx/Search?{Parameters}

The search method will return all records matching the {Parameters} criteria. For searches, {Parameters} may include any property listed in the table above. The following standard optional parameters also apply:

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP. If omitted, XHTML is returns based on the ValuationComparable.Search.xslt template.
  • DisplaySize: determines the maximum number of rows returned. Default is 25. DisplaySize=0 will return all matching rows.
  • RecordStart: the starting record to return; defaults to 0. Used for pagination.
  • OrderBy: a series of properties to order by.
  • Request: ValuationComparable.ashx/Search?ValuationComparable=ABC123
  • Response:
<ValuationComparableCollection>
  <ValuationComparableItem>
    <ValuationComparableID>21</ValuationComparableID>
    <ValuationComparable>162 Lackawanna Ln</ValuationComparable>
    <ValuationID>327</ValuationID>
    <ValuationComparableType>
    </ValuationComparableType>
    <DataSource>www.valuationvision.com</DataSource>
    <VerificationSource>
    </VerificationSource>
    <Address>162 Lackawanna Ln</Address>
    <City>Falling Waters</City>
    <State>WV</State>
    <PostalCode>25419</PostalCode>
    <Proximity>
    </Proximity>
    <SalePrice>
    </SalePrice>
    <SquareFeet>3014.000000</SquareFeet>
    <Concessions>
    </Concessions>
    <ListingUrl>
    </ListingUrl>
    <ListingAmount>
    </ListingAmount>
    <ListingDate>
    </ListingDate>
    <ListingAmountOriginal>
    </ListingAmountOriginal>
    <ListingDateOriginal>
    </ListingDateOriginal>
    <DaysOnMarket>42</DaysOnMarket>
    <SaleDate>
    </SaleDate>
    <SaleLocation>
    </SaleLocation>
    <Site>
    </Site>
    <SiteView>
    </SiteView>
    <SiteDesign>
    </SiteDesign>
    <ConstructionQuality>
    </ConstructionQuality>
    <PropertyBuilt>2009-01-01T00:00:00-08:00</PropertyBuilt>
    <Condition>
    </Condition>
    <RoomsTotal>7.000000</RoomsTotal>
    <RoomsBedroom>4.000000</RoomsBedroom>
    <RoomsBath>2.000000</RoomsBath>
    <RoomsBelowGrade>
    </RoomsBelowGrade>
    <FunctionalUtility>
    </FunctionalUtility>
    <Heating>
    </Heating>
    <Cooling>
    </Cooling>
    <EnergyEfficientItems>
    </EnergyEfficientItems>
    <Garage>
    </Garage>
    <Carport>
    </Carport>
    <Porch>
    </Porch>
    <Patio>
    </Patio>
    <Deck>
    </Deck>
    <PriorSales>
    </PriorSales>
    <FinanceType>
    </FinanceType>
    <Basement>
    </Basement>
    <BasementFinished>
    </BasementFinished>
    <LotSize>33541.000000</LotSize>
    <GrossLivingArea>
    </GrossLivingArea>
    <Comments>
    </Comments>
    <AttachmentID>
    </AttachmentID>
    <Latitude>39.573652</Latitude>
    <Longitude>-77.862073</Longitude>
    <BestValue>
    </BestValue>
    <PropertyType>
    </PropertyType>
    <Location>
    </Location>
    <AmenityLedgerID>
    </AmenityLedgerID>
    <Adjustments>
    </Adjustments>
    <Status>
    </Status>
    <CreatedPersonID>11</CreatedPersonID>
    <CreatedDate>2018-06-27T12:29:45.51-07:00</CreatedDate>
    <UpdatedPersonID>11</UpdatedPersonID>
    <UpdatedDate>2018-06-27T12:29:45.51-07:00</UpdatedDate>
    <PropertyAddress>30 Woodlawn Avenue</PropertyAddress>
    <PropertyCity>Waltham</PropertyCity>
    <PropertyState>MA</PropertyState>
    <PropertyPostalCode>02451</PropertyPostalCode>
    <Valuation>Appraisal</Valuation>
    <Attachment>
    </Attachment>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <RecordCount>25</RecordCount>
  </ValuationComparableItem>
  <ValuationComparableItem>
    <ValuationComparableID>23</ValuationComparableID>
    <ValuationComparable>2 Loyalty Ln</ValuationComparable>
    <ValuationID>327</ValuationID>
    <ValuationComparableType>
    </ValuationComparableType>
    <DataSource>www.valuationvision.com</DataSource>
    <VerificationSource>
    </VerificationSource>
    <Address>2 Loyalty Ln</Address>
    <City>Martinsburg</City>
    <State>WV</State>
    <PostalCode>25403</PostalCode>
    <Proximity>
    </Proximity>
    <SalePrice>365000.0000</SalePrice>
    <SquareFeet>3784.000000</SquareFeet>
    <Concessions>
    </Concessions>
    <ListingUrl>
    </ListingUrl>
    <ListingAmount>
    </ListingAmount>
    <ListingDate>
    </ListingDate>
    <ListingAmountOriginal>
    </ListingAmountOriginal>
    <ListingDateOriginal>
    </ListingDateOriginal>
    <DaysOnMarket>53</DaysOnMarket>
    <SaleDate>2016-12-01T00:00:00-08:00</SaleDate>
    <SaleLocation>
    </SaleLocation>
    <Site>
    </Site>
    <SiteView>
    </SiteView>
    <SiteDesign>
    </SiteDesign>
    <ConstructionQuality>
    </ConstructionQuality>
    <PropertyBuilt>2004-01-01T00:00:00-08:00</PropertyBuilt>
    <Condition>
    </Condition>
    <RoomsTotal>7.000000</RoomsTotal>
    <RoomsBedroom>4.000000</RoomsBedroom>
    <RoomsBath>2.000000</RoomsBath>
    <RoomsBelowGrade>
    </RoomsBelowGrade>
    <FunctionalUtility>
    </FunctionalUtility>
    <Heating>
    </Heating>
    <Cooling>
    </Cooling>
    <EnergyEfficientItems>
    </EnergyEfficientItems>
    <Garage>
    </Garage>
    <Carport>
    </Carport>
    <Porch>
    </Porch>
    <Patio>
    </Patio>
    <Deck>
    </Deck>
    <PriorSales>
    </PriorSales>
    <FinanceType>
    </FinanceType>
    <Basement>
    </Basement>
    <BasementFinished>
    </BasementFinished>
    <LotSize>
    </LotSize>
    <GrossLivingArea>
    </GrossLivingArea>
    <Comments>
    </Comments>
    <AttachmentID>
    </AttachmentID>
    <Latitude>39.451553</Latitude>
    <Longitude>-78.029636</Longitude>
    <BestValue>
    </BestValue>
    <PropertyType>
    </PropertyType>
    <Location>
    </Location>
    <AmenityLedgerID>
    </AmenityLedgerID>
    <Adjustments>
    </Adjustments>
    <Status>
    </Status>
    <CreatedPersonID>11</CreatedPersonID>
    <CreatedDate>2018-06-27T12:29:45.557-07:00</CreatedDate>
    <UpdatedPersonID>11</UpdatedPersonID>
    <UpdatedDate>2018-06-27T12:29:45.557-07:00</UpdatedDate>
    <PropertyAddress>30 Woodlawn Avenue</PropertyAddress>
    <PropertyCity>Waltham</PropertyCity>
    <PropertyState>MA</PropertyState>
    <PropertyPostalCode>02451</PropertyPostalCode>
    <Valuation>Appraisal</Valuation>
    <Attachment>
    </Attachment>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <RecordCount>25</RecordCount>
  </ValuationComparableItem>
</ValuationComparableCollection>

Mortgage/ValuationComparable.ashx/Save?{Parameters}

The save method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table above along with child classes.

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
  • Response: included in the response is {Table}ID; this is the primary key of the {Table} row created
  • With the same Save method, you can also save data to related tables. By using a {Parent}_{Column} pattern, you can update the parent table's data in the same call.
  • Child records may also be updated using a {Child}_{Index}_{Column} pattern.
  • For child records that are templated, you may use the template name in lieu of an index.

Mortgage/ValuationComparable.ashx/Delete?ID={Where.IdList}

The delete method will delete all records where ID={comma-delimited list of identifiers} criteria.

Mortgage/ValuationComparable.ashx/ListWhere?{Parameters}

The ListWhere method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table.

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
  • Response: 2 columns are returned - {Table}ID and {Table} columns.
  • Request: ValuationComparable.ashx/ListWhere?ValuationComparableID=1,2,3
  • Response:
<ValuationComparableCollection>
  <ValuationComparableItem>
    <ValuationComparableID>1</ValuationComparableID>
    <ValuationComparable>abc</ValuationComparable>
  </ValuationComparableItem>
  <ValuationComparableItem>
    <ValuationComparableID>3</ValuationComparableID>
    <ValuationComparable>Listing</ValuationComparable>
  </ValuationComparableItem>
  <ValuationComparableItem>
    <ValuationComparableID>2</ValuationComparableID>
    <ValuationComparable>Sale</ValuationComparable>
  </ValuationComparableItem>
</ValuationComparableCollection>
⚠️ **GitHub.com Fallback** ⚠️