Property Class - quandis/qbo3-Documentation GitHub Wiki

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

Property properties

Column Type Required Description
Active string
ActiveStatus string
Address string Street address of property.
Amenities string
AssignedOrganizationID integer
AssignedPersonID integer
BasementFinished integer
Batch integer
CanDelete string
CanInsert string
CanUpdate string
CategoryDescription string
CategoryType string
CensusTractID string
City string City the property is located in.
CommunityReinvestmentAct boolean
Condition string
CountyID integer FK to the County view representing the county the property is located in.
CreatedDate dateTime
CreatedPersonID integer
EarthquakeInsuranceRequired boolean
Extranet string
FinalStatus string
Form string
HOACompanyID integer
HOAPaymentAmount double
HOAPaymentFrequency integer
InDecisionID string
InImportFileID string
LastInspectionDate dateTime
Latitude double
LegalDescription string Description of property from deed or other legal document.
LegalSummary string
LinkedFrom string
LinkedTo string
Longitude double
LotSize integer
MSAID string
NotLinkedFrom string
NotLinkedTo string
OccupancyType string Used-defined values; e.g. 'Owner Occupied'
Parking boolean
PlannedUnitDevelopment boolean
PostalCode string Postal (zip) code the property is located in.
Property string yes Short description of the Property; usually street address.
PropertyBlock string Block as defined in the legal description of the property.
PropertyBuilt dateTime Year the property was built.
PropertyID integer yes Primary key for this table (identity column). This column is indexed.
PropertyLot string Lot as defined in the legal description of the property.
PropertyRights string
PropertySection string Section as defined in the legal description of the property.
PropertyType string User-defined values, from ObjectType table.
PropertyUnits integer
RoomsBath double
RoomsBedroom double
RoomsTotal double
SquareFeet integer
State string State the property is located in.
Status string
Subdivision string Subdivision
Tags string
TaxParcelID string
UnitsFinanced integer
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
UsageCurrentType string
VacancyStatus string
ViewAsRole string
WindstormInsuranceRequired boolean
Worklist string

Related modules

Related Objects Module Relationship
Access Child
AssignedOrganization qbo.Contact.OrganizationObject Foreign Key
AssignedPerson qbo.Security.PersonObject Foreign Key
Attachments Attachment Child
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Decisions Decision Child
Forms ImportForm Child
HOACompany qbo.Contact.OrganizationObject Foreign Key
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Property.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 Property.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: Property.ashx/Search?Property=ABC123
  • Response:
<PropertyCollection>
  <PropertyItem>
    <PropertyID>827453</PropertyID>
    <Property>"6240 N 63RD AVE, 108"</Property>
    <PropertyType>
    </PropertyType>
    <Address>"6240 N 63RD AVE, 108"</Address>
    <City>GLENDALE</City>
    <State>AZ</State>
    <PostalCode>85301</PostalCode>
    <CountyID>
    </CountyID>
    <PropertyBlock>
    </PropertyBlock>
    <PropertyLot>
    </PropertyLot>
    <PropertySection>
    </PropertySection>
    <Subdivision>
    </Subdivision>
    <PropertyBuilt>
    </PropertyBuilt>
    <Condition>
    </Condition>
    <Parking>
    </Parking>
    <Amenities>
    </Amenities>
    <RoomsTotal>
    </RoomsTotal>
    <RoomsBedroom>
    </RoomsBedroom>
    <RoomsBath>
    </RoomsBath>
    <SquareFeet>
    </SquareFeet>
    <LotSize>
    </LotSize>
    <BasementFinished>
    </BasementFinished>
    <VacancyStatus>
    </VacancyStatus>
    <UsageCurrentType>
    </UsageCurrentType>
    <OccupancyType>
    </OccupancyType>
    <MSAID>
    </MSAID>
    <CommunityReinvestmentAct>
    </CommunityReinvestmentAct>
    <LegalDescription>
    </LegalDescription>
    <LegalSummary>
    </LegalSummary>
    <CensusTractID>
    </CensusTractID>
    <UnitsFinanced>
    </UnitsFinanced>
    <CategoryType>
    </CategoryType>
    <CategoryDescription>
    </CategoryDescription>
    <PropertyRights>
    </PropertyRights>
    <PlannedUnitDevelopment>
    </PlannedUnitDevelopment>
    <EarthquakeInsuranceRequired>
    </EarthquakeInsuranceRequired>
    <WindstormInsuranceRequired>
    </WindstormInsuranceRequired>
    <TaxParcelID>
    </TaxParcelID>
    <LastInspectionDate>
    </LastInspectionDate>
    <PropertyUnits>1</PropertyUnits>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <HOACompanyID>
    </HOACompanyID>
    <HOAPaymentAmount>
    </HOAPaymentAmount>
    <HOAPaymentFrequency>
    </HOAPaymentFrequency>
    <Status>
    </Status>
    <CreatedPersonID>1</CreatedPersonID>
    <CreatedDate>2013-03-26T08:46:40.193-07:00</CreatedDate>
    <UpdatedPersonID>1</UpdatedPersonID>
    <UpdatedDate>2013-03-26T08:46:40.193-07:00</UpdatedDate>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <HOACompany>
    </HOACompany>
    <CreatedPerson>DEPRECATED - Administrator</CreatedPerson>
    <UpdatedPerson>DEPRECATED - Administrator</UpdatedPerson>
    <RecordCount>500</RecordCount>
  </PropertyItem>
  <PropertyItem>
    <PropertyID>812276</PropertyID>
    <Property>#1 WOODRUFF DRIVE</Property>
    <PropertyType>
    </PropertyType>
    <Address>#1 WOODRUFF DRIVE</Address>
    <City>BLOOMINGTON</City>
    <State>IL</State>
    <PostalCode>61701</PostalCode>
    <CountyID>
    </CountyID>
    <PropertyBlock>
    </PropertyBlock>
    <PropertyLot>
    </PropertyLot>
    <PropertySection>
    </PropertySection>
    <Subdivision>
    </Subdivision>
    <PropertyBuilt>
    </PropertyBuilt>
    <Condition>GOOD</Condition>
    <Parking>
    </Parking>
    <Amenities>
    </Amenities>
    <RoomsTotal>
    </RoomsTotal>
    <RoomsBedroom>
    </RoomsBedroom>
    <RoomsBath>
    </RoomsBath>
    <SquareFeet>
    </SquareFeet>
    <LotSize>
    </LotSize>
    <BasementFinished>
    </BasementFinished>
    <VacancyStatus>
    </VacancyStatus>
    <UsageCurrentType>
    </UsageCurrentType>
    <OccupancyType>OCCUPIED BY UNKNOWN</OccupancyType>
    <MSAID>
    </MSAID>
    <CommunityReinvestmentAct>
    </CommunityReinvestmentAct>
    <LegalDescription>
    </LegalDescription>
    <LegalSummary>
    </LegalSummary>
    <CensusTractID>
    </CensusTractID>
    <UnitsFinanced>
    </UnitsFinanced>
    <CategoryType>
    </CategoryType>
    <CategoryDescription>
    </CategoryDescription>
    <PropertyRights>
    </PropertyRights>
    <PlannedUnitDevelopment>
    </PlannedUnitDevelopment>
    <EarthquakeInsuranceRequired>
    </EarthquakeInsuranceRequired>
    <WindstormInsuranceRequired>
    </WindstormInsuranceRequired>
    <TaxParcelID>
    </TaxParcelID>
    <LastInspectionDate>
    </LastInspectionDate>
    <PropertyUnits>1</PropertyUnits>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <HOACompanyID>
    </HOACompanyID>
    <HOAPaymentAmount>
    </HOAPaymentAmount>
    <HOAPaymentFrequency>
    </HOAPaymentFrequency>
    <Status>
    </Status>
    <CreatedPersonID>1</CreatedPersonID>
    <CreatedDate>2013-03-26T08:44:28.87-07:00</CreatedDate>
    <UpdatedPersonID>1</UpdatedPersonID>
    <UpdatedDate>2013-03-26T08:44:28.87-07:00</UpdatedDate>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <HOACompany>
    </HOACompany>
    <CreatedPerson>DEPRECATED - Administrator</CreatedPerson>
    <UpdatedPerson>DEPRECATED - Administrator</UpdatedPerson>
    <RecordCount>500</RecordCount>
  </PropertyItem>
</PropertyCollection>

Mortgage/Property.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/Property.ashx/Delete?ID={Where.IdList}

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

Mortgage/Property.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: Property.ashx/ListWhere?PropertyID=1,2,3
  • Response:
<PropertyCollection>
  <PropertyItem>
    <PropertyID>1</PropertyID>
    <Property>165 E. Edna Pl.</Property>
  </PropertyItem>
</PropertyCollection>
⚠️ **GitHub.com Fallback** ⚠️