Borrower Class - quandis/qbo3-Documentation GitHub Wiki

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

Borrower properties

Column Type Required Description
Active string
ActiveStatus string
Address string
AgeAtApplication integer
Batch integer
BirthDate dateTime
Borrower string yes Label for the table.
BorrowerID integer yes Identity column and primary key for the table.
CanDelete string
CanInsert string
CanUpdate string
City string
Company string
Contact string yes
ContactID integer
ContactTemplateID integer
ContactType string
CorporateAffiliateSharing boolean
Country string
CreatedDate dateTime
CreatedPersonID integer
CreditScore integer
DeathDate dateTime
Email string
EmailSolicitation boolean
Entity string
EntityParent string
Extranet string
FinalStatus string
FirstName string
Form string
GenderType integer
HomeOwnerIntent string
InDecisionID string
InImportFileID string
IRS1098 boolean
LastName string
Latitude double
LinkedFrom string
LinkedTo string
LoanID integer
Longitude double
MaritalStatus string
MiddleName string
Nationality string
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
ParentContactID integer
Phone string
PostalCode string
Prefix string
QuanlifyingIncomeAmount double
RaceNationalityDescription string
RaceNationalityType string
SCRASource string
SCRAStatus string
SCRAStatusAsOf dateTime
Sequence integer
SpokenLanguage string
State string
Status string
Suffix string
Tag string
Tags string
TIN string
TIN4 string
Title string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
USMailSolicitation boolean
USSSN string
USSSN4 string
USSSNCertification boolean
ValidEnd dateTime
ValidStart dateTime
VerifiedConfidence integer
VerifiedDate dateTime
VerifiedSource string
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
Attachments Attachment Child
Children Contact Child
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
ContactTemplate qbo.Contact.ContactTemplateObject Foreign Key
Decisions Decision Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Loan qbo.Mortgage.LoanObject Foreign Key
Messages Message Child
Methods ContactMethod Child
ParentContact qbo.Contact.ContactObject Foreign Key
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Borrower.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 Borrower.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: Borrower.ashx/Search?Borrower=ABC123
  • Response:
<BorrowerCollection>
  <BorrowerItem>
    <BorrowerID>304</BorrowerID>
    <Borrower>AARON BELCHER</Borrower>
    <LoanID>300</LoanID>
    <ContactID>697</ContactID>
    <AgeAtApplication>
    </AgeAtApplication>
    <MaritalStatus>
    </MaritalStatus>
    <QuanlifyingIncomeAmount>
    </QuanlifyingIncomeAmount>
    <RaceNationalityType>
    </RaceNationalityType>
    <RaceNationalityDescription>
    </RaceNationalityDescription>
    <GenderType>
    </GenderType>
    <IRS1098>
    </IRS1098>
    <USSSNCertification>
    </USSSNCertification>
    <CorporateAffiliateSharing>
    </CorporateAffiliateSharing>
    <EmailSolicitation>
    </EmailSolicitation>
    <USMailSolicitation>
    </USMailSolicitation>
    <CreditScore>
    </CreditScore>
    <HomeOwnerIntent>
    </HomeOwnerIntent>
    <Contact>AARON BELCHER</Contact>
    <ParentContactID>
    </ParentContactID>
    <ContactType>
    </ContactType>
    <Company>
    </Company>
    <Title>
                  </Title>
    <Prefix>
    </Prefix>
    <FirstName>AARON</FirstName>
    <MiddleName>
    </MiddleName>
    <LastName> BELCHER</LastName>
    <Suffix>
    </Suffix>
    <Address>27 GROVE STREET </Address>
    <City>DELEVAN</City>
    <State>NY</State>
    <PostalCode>77459</PostalCode>
    <Country>
    </Country>
    <USSSN>
    </USSSN>
    <USSSN4>
    </USSSN4>
    <BirthDate>
    </BirthDate>
    <DeathDate>
    </DeathDate>
    <Nationality>
    </Nationality>
    <SpokenLanguage>
    </SpokenLanguage>
    <ValidStart>
    </ValidStart>
    <ValidEnd>
    </ValidEnd>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <ContactTemplateID>
    </ContactTemplateID>
    <TIN>
    </TIN>
    <TIN4>
    </TIN4>
    <VerifiedSource>
    </VerifiedSource>
    <VerifiedDate>
    </VerifiedDate>
    <VerifiedConfidence>
    </VerifiedConfidence>
    <SCRAStatus>
    </SCRAStatus>
    <SCRASource>
    </SCRASource>
    <SCRAStatusAsOf>
    </SCRAStatusAsOf>
    <Sequence>
    </Sequence>
    <Object>Loan</Object>
    <ObjectID>300</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>
    </CreatedPersonID>
    <CreatedDate>
    </CreatedDate>
    <UpdatedPersonID>
    </UpdatedPersonID>
    <UpdatedDate>
    </UpdatedDate>
    <ServicerID>51</ServicerID>
    <Servicer>ACME</Servicer>
    <ServicerLoanID>6191803847</ServicerLoanID>
    <AgencyID>3043</AgencyID>
    <Agency>test</Agency>
    <AgencyLoanID>
    </AgencyLoanID>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <InvestorID>60</InvestorID>
    <Investor>FNMA</Investor>
    <InvestorLoanID>
    </InvestorLoanID>
    <PropertyAddress>27 GROVE STREET </PropertyAddress>
    <PropertyCity>DELEVAN</PropertyCity>
    <PropertyState>NY</PropertyState>
    <PropertyPostalCode>77459</PropertyPostalCode>
    <Loan>0488218128</Loan>
    <ParentContact>
    </ParentContact>
    <ContactTemplate>
    </ContactTemplate>
    <CreatedPerson>
    </CreatedPerson>
    <UpdatedPerson>
    </UpdatedPerson>
    <PropertyAddress1>27 GROVE STREET </PropertyAddress1>
    <PropertyCity1>DELEVAN</PropertyCity1>
    <PropertyState1>NY</PropertyState1>
    <PropertyPostalCode1>77459</PropertyPostalCode1>
    <PropertyID>1968</PropertyID>
    <Address1>27 GROVE STREET </Address1>
    <City1>DELEVAN</City1>
    <State1>NY</State1>
    <PostalCode1>77459</PostalCode1>
    <Phone>
    </Phone>
    <Email>
    </Email>
    <RecordCount>500</RecordCount>
  </BorrowerItem>
  <BorrowerItem>
    <BorrowerID>216</BorrowerID>
    <Borrower>Abdul Mbano</Borrower>
    <LoanID>212</LoanID>
    <ContactID>609</ContactID>
    <AgeAtApplication>
    </AgeAtApplication>
    <MaritalStatus>
    </MaritalStatus>
    <QuanlifyingIncomeAmount>
    </QuanlifyingIncomeAmount>
    <RaceNationalityType>
    </RaceNationalityType>
    <RaceNationalityDescription>
    </RaceNationalityDescription>
    <GenderType>
    </GenderType>
    <IRS1098>
    </IRS1098>
    <USSSNCertification>
    </USSSNCertification>
    <CorporateAffiliateSharing>
    </CorporateAffiliateSharing>
    <EmailSolicitation>
    </EmailSolicitation>
    <USMailSolicitation>
    </USMailSolicitation>
    <CreditScore>
    </CreditScore>
    <HomeOwnerIntent>
    </HomeOwnerIntent>
    <Contact>Abdul Mbano</Contact>
    <ParentContactID>
    </ParentContactID>
    <ContactType>
    </ContactType>
    <Company>
    </Company>
    <Title>
                  </Title>
    <Prefix>
    </Prefix>
    <FirstName>Abdul</FirstName>
    <MiddleName>
    </MiddleName>
    <LastName> Mbano</LastName>
    <Suffix>
    </Suffix>
    <Address>3816 Winterwood Dr. </Address>
    <City>HOWELL</City>
    <State>MI</State>
    <PostalCode>91741</PostalCode>
    <Country>
    </Country>
    <USSSN>
    </USSSN>
    <USSSN4>
    </USSSN4>
    <BirthDate>
    </BirthDate>
    <DeathDate>
    </DeathDate>
    <Nationality>
    </Nationality>
    <SpokenLanguage>
    </SpokenLanguage>
    <ValidStart>
    </ValidStart>
    <ValidEnd>
    </ValidEnd>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <ContactTemplateID>
    </ContactTemplateID>
    <TIN>
    </TIN>
    <TIN4>
    </TIN4>
    <VerifiedSource>
    </VerifiedSource>
    <VerifiedDate>
    </VerifiedDate>
    <VerifiedConfidence>
    </VerifiedConfidence>
    <SCRAStatus>
    </SCRAStatus>
    <SCRASource>
    </SCRASource>
    <SCRAStatusAsOf>
    </SCRAStatusAsOf>
    <Sequence>
    </Sequence>
    <Object>Loan</Object>
    <ObjectID>212</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>
    </CreatedPersonID>
    <CreatedDate>
    </CreatedDate>
    <UpdatedPersonID>
    </UpdatedPersonID>
    <UpdatedDate>
    </UpdatedDate>
    <ServicerID>51</ServicerID>
    <Servicer>ACME</Servicer>
    <ServicerLoanID>
    </ServicerLoanID>
    <AgencyID>3043</AgencyID>
    <Agency>test</Agency>
    <AgencyLoanID>
    </AgencyLoanID>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <InvestorID>62</InvestorID>
    <Investor>FHLMC</Investor>
    <InvestorLoanID>
    </InvestorLoanID>
    <PropertyAddress>3816 Winterwood Dr. </PropertyAddress>
    <PropertyCity>HOWELL</PropertyCity>
    <PropertyState>MI</PropertyState>
    <PropertyPostalCode>91741</PropertyPostalCode>
    <Loan>0395137195</Loan>
    <ParentContact>
    </ParentContact>
    <ContactTemplate>
    </ContactTemplate>
    <CreatedPerson>
    </CreatedPerson>
    <UpdatedPerson>
    </UpdatedPerson>
    <PropertyAddress1>3816 Winterwood Dr. </PropertyAddress1>
    <PropertyCity1>HOWELL</PropertyCity1>
    <PropertyState1>MI</PropertyState1>
    <PropertyPostalCode1>91741</PropertyPostalCode1>
    <PropertyID>1970</PropertyID>
    <Address1>3816 Winterwood Dr. </Address1>
    <City1>HOWELL</City1>
    <State1>MI</State1>
    <PostalCode1>91741</PostalCode1>
    <Phone>
    </Phone>
    <Email>
    </Email>
    <RecordCount>500</RecordCount>
  </BorrowerItem>
</BorrowerCollection>

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

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

Mortgage/Borrower.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: Borrower.ashx/ListWhere?BorrowerID=1,2,3
  • Response:
<BorrowerCollection>
  <BorrowerItem>
    <BorrowerID>20</BorrowerID>
    <Borrower>Brose, Kevin</Borrower>
  </BorrowerItem>
  <BorrowerItem>
    <BorrowerID>21</BorrowerID>
    <Borrower>Garcia, Danny</Borrower>
  </BorrowerItem>
</BorrowerCollection>
⚠️ **GitHub.com Fallback** ⚠️