Loan Class - quandis/qbo3-Documentation GitHub Wiki

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

Loan properties

Column Type Required Description
AcceleratedPaymentProgram boolean
Active string
ActiveStatus string
AgencyID integer FK to the GSE that backs the loan (Freddie, Fannie, HUD, etc.).
AgencyLoanID string GSE loan number.
AmortizationDescription string Description of the amortization schedule (pre-payment penalties, etc.)
AmortizationTerm integer
AmortizationType string Balloon, 5/1 ARM, etc.
AssignedOrganizationID integer
AssignedPersonID integer
Assumable boolean
AssumableDate dateTime
AssumableTerm integer
Assumed boolean
AssumedDate dateTime
Batch integer
CanDelete string
CanInsert string
CanUpdate string
CapitalizedLoan boolean
ChildLoanDescription string
ChildLoanType string
CLTVCurrent double
CLTVOriginal double Combined Loan-to-value based on all liens on the property.
ContextIdentifierDescription string Detailed description of the context of the loan (pool restrictions, etc.)
ContextIdentifierLoanID string Loan number of the loan with respect to the context pool.
ContextIdentifierType string Indicates the type of Context Identifier. This is used for loans that are purchased as part of pools.
CorporateAdvanceBalance double
CreatedDate dateTime
CreatedPersonID integer
CurrentBeneficiaryID integer
CurrentNoteContactID integer
EquityDate dateTime
EquityPosition double
EscrowBalance double
Extranet string
FinalStatus string
Form string
GracePeriodDays integer
HudSFDMSID string
InDecisionID string
InImportFileID string
Insurance double
InsurerGuaranteePercentage double
InsurerID integer FK to the company that insurers the loan (PMI).
InsurerLoanID string Loan number for the PMI company.
InsurerPremiumPercentage double
Interest double
InterestCalculation string
InterestInAdvance boolean
InterestOnly boolean
InterestOnlyTerm integer
InterestPaidThrough dateTime
InterestRateCurrent double Current interest rate.
InterestRateOriginal double
InvestorID integer
InvestorLoanID string
LastPaymentReceived dateTime
LateChargeAmount double
LateChargeBalance double
LienPriorityDescription string Description of the lien position.
LienPriorityType integer Lien position; usually 1, 2, 3, etc.
LinkedFrom string
LinkedTo string
Loan string yes Loan number; serves as the primary hyperlink for search and list views.
LoanFundingDate dateTime Date the loan was funded.
LoanID integer yes Primary key for this table (identity column).
LoanMaturityDate dateTime
LoanType string User-defined characterization of a loan.
LTVCurrent double
LTVOriginal double
MERSLoanID string
MetaXml string Deprecated
MortgageDescription string
MortgageType string User-defind type of mortgage.
NationalHousingActType string
NegativeAmortization boolean
NegativeAmortizationCap double
NextPaymentDue dateTime
NotActiveClosed string
NotLinkedFrom string
NotLinkedTo string
OriginalBalance double
OriginalBeneficiaryID integer
OriginalNoteContactID integer
PaidInFull dateTime
ParentLoanID integer Primary key to a parent loan; used for loan modifications.
PaymentAmount double
PaymentHistory string
PayoffAmount double
PayoffGoodThroughDate dateTime
PerDiem double
PITI double
Principal double
Priority integer
Product string
PropertyID integer Property for which this Loan was issued.
SeniorLoanID integer
ServicerID integer FK to the company that services the loan.
ServicerLoanID string Loan number used by the servicing company.
SourceXml string Deprecated
Status string
StopCodes string StopCodes
SuspenseBalance double
Tags string
Taxes double
TotalAmountDue double
UnreadNotifications string
UPBAmount double
UpdatedDate dateTime
UpdatedPersonID integer
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
Agency qbo.Contact.OrganizationObject Foreign Key
AssignedOrganization qbo.Contact.OrganizationObject Foreign Key
AssignedPerson qbo.Security.PersonObject Foreign Key
Attachments Attachment Child
Bankruptcies Bankruptcy Child
Borrowers Borrower Child
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
CurrentBeneficiary qbo.Contact.ContactObject Foreign Key
CurrentNoteContact qbo.Contact.ContactObject Foreign Key
Decisions Decision Child
Foreclosures Foreclosure Child
Forms ImportForm Child
Insurer qbo.Contact.OrganizationObject Foreign Key
Investor qbo.Contact.OrganizationObject Foreign Key
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
OriginalBeneficiary qbo.Contact.ContactObject Foreign Key
OriginalNoteContact qbo.Contact.ContactObject Foreign Key
Property qbo.Mortgage.PropertyObject Foreign Key
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Servicer qbo.Contact.OrganizationObject Foreign Key
Valuations Valuation Child
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Loan.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 Loan.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: Loan.ashx/Search?Loan=ABC123
  • Response:
<LoanCollection>
  <LoanItem>
    <LoanID>1413995</LoanID>
    <Loan>000000000</Loan>
    <PropertyID>1203307</PropertyID>
    <LoanType>
    </LoanType>
    <ParentLoanID>
    </ParentLoanID>
    <ChildLoanType>
    </ChildLoanType>
    <ChildLoanDescription>
    </ChildLoanDescription>
    <ServicerID>
    </ServicerID>
    <ServicerLoanID>
    </ServicerLoanID>
    <AgencyID>
    </AgencyID>
    <AgencyLoanID>
    </AgencyLoanID>
    <ContextIdentifierType>
    </ContextIdentifierType>
    <ContextIdentifierDescription>
    </ContextIdentifierDescription>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <LoanFundingDate>
    </LoanFundingDate>
    <LienPriorityType>
    </LienPriorityType>
    <LienPriorityDescription>
    </LienPriorityDescription>
    <AmortizationType>
    </AmortizationType>
    <AmortizationDescription>
    </AmortizationDescription>
    <NationalHousingActType>
    </NationalHousingActType>
    <HudSFDMSID>
    </HudSFDMSID>
    <MERSLoanID>
    </MERSLoanID>
    <MortgageType>
    </MortgageType>
    <MortgageDescription>
    </MortgageDescription>
    <InterestRateCurrent>
    </InterestRateCurrent>
    <AmortizationTerm>
    </AmortizationTerm>
    <InterestInAdvance>
    </InterestInAdvance>
    <CapitalizedLoan>
    </CapitalizedLoan>
    <LoanMaturityDate>
    </LoanMaturityDate>
    <Assumable>
    </Assumable>
    <AssumableDate>
    </AssumableDate>
    <AssumableTerm>
    </AssumableTerm>
    <Assumed>
    </Assumed>
    <AssumedDate>
    </AssumedDate>
    <PaymentHistory>
    </PaymentHistory>
    <Product>
    </Product>
    <InterestOnly>
    </InterestOnly>
    <InterestOnlyTerm>
    </InterestOnlyTerm>
    <PITI>
    </PITI>
    <UPBAmount>12345.6700</UPBAmount>
    <AcceleratedPaymentProgram>
    </AcceleratedPaymentProgram>
    <NextPaymentDue>
    </NextPaymentDue>
    <LastPaymentReceived>
    </LastPaymentReceived>
    <InterestPaidThrough>
    </InterestPaidThrough>
    <InterestCalculation>
    </InterestCalculation>
    <OriginalBalance>
    </OriginalBalance>
    <PerDiem>
    </PerDiem>
    <PaymentAmount>
    </PaymentAmount>
    <PayoffAmount>
    </PayoffAmount>
    <PayoffGoodThroughDate>
    </PayoffGoodThroughDate>
    <PaidInFull>
    </PaidInFull>
    <TotalAmountDue>
    </TotalAmountDue>
    <LateChargeBalance>
    </LateChargeBalance>
    <SuspenseBalance>
    </SuspenseBalance>
    <EquityPosition>
    </EquityPosition>
    <EquityDate>
    </EquityDate>
    <InsurerID>
    </InsurerID>
    <InsurerLoanID>
    </InsurerLoanID>
    <InsurerGuaranteePercentage>
    </InsurerGuaranteePercentage>
    <InsurerPremiumPercentage>
    </InsurerPremiumPercentage>
    <InvestorID>
    </InvestorID>
    <InvestorLoanID>
    </InvestorLoanID>
    <Priority>
    </Priority>
    <SeniorLoanID>
    </SeniorLoanID>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <NegativeAmortization>
    </NegativeAmortization>
    <NegativeAmortizationCap>
    </NegativeAmortizationCap>
    <LTVOriginal>
    </LTVOriginal>
    <LTVCurrent>
    </LTVCurrent>
    <CLTVOriginal>
    </CLTVOriginal>
    <CLTVCurrent>
    </CLTVCurrent>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <GracePeriodDays>
    </GracePeriodDays>
    <CurrentBeneficiaryID>
    </CurrentBeneficiaryID>
    <OriginalBeneficiaryID>
    </OriginalBeneficiaryID>
    <CurrentNoteContactID>
    </CurrentNoteContactID>
    <OriginalNoteContactID>
    </OriginalNoteContactID>
    <InterestRateOriginal>
    </InterestRateOriginal>
    <LateChargeAmount>
    </LateChargeAmount>
    <CorporateAdvanceBalance>
    </CorporateAdvanceBalance>
    <EscrowBalance>
    </EscrowBalance>
    <StopCodes>
    </StopCodes>
    <Principal>
    </Principal>
    <Interest>
    </Interest>
    <Taxes>
    </Taxes>
    <Insurance>10.0000</Insurance>
    <Status>
    </Status>
    <CreatedPersonID>645</CreatedPersonID>
    <CreatedDate>2016-01-11T09:13:55-08:00</CreatedDate>
    <UpdatedPersonID>2117</UpdatedPersonID>
    <UpdatedDate>2018-07-09T09:17:50.457-07:00</UpdatedDate>
    <Address>123 Maple</Address>
    <City>Anywhere</City>
    <State>CA</State>
    <PostalCode>92101</PostalCode>
    <Property>Spec Test - Property ija8chpn</Property>
    <ParentLoan>
    </ParentLoan>
    <Servicer>
    </Servicer>
    <Agency>
    </Agency>
    <Insurer>
    </Insurer>
    <Investor>
    </Investor>
    <SeniorLoan>
    </SeniorLoan>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <CurrentBeneficiary>
    </CurrentBeneficiary>
    <OriginalBeneficiary>
    </OriginalBeneficiary>
    <CurrentNoteContact>
    </CurrentNoteContact>
    <OriginalNoteContact>
    </OriginalNoteContact>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>Test Agency</UpdatedPerson>
    <Borrower1>tester's</Borrower1>
    <Borrower2>
    </Borrower2>
    <RecordCount>500</RecordCount>
  </LoanItem>
  <LoanItem>
    <LoanID>1413996</LoanID>
    <Loan>000000000</Loan>
    <PropertyID>1203308</PropertyID>
    <LoanType>
    </LoanType>
    <ParentLoanID>
    </ParentLoanID>
    <ChildLoanType>
    </ChildLoanType>
    <ChildLoanDescription>
    </ChildLoanDescription>
    <ServicerID>
    </ServicerID>
    <ServicerLoanID>
    </ServicerLoanID>
    <AgencyID>8493</AgencyID>
    <AgencyLoanID>
    </AgencyLoanID>
    <ContextIdentifierType>
    </ContextIdentifierType>
    <ContextIdentifierDescription>
    </ContextIdentifierDescription>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <LoanFundingDate>
    </LoanFundingDate>
    <LienPriorityType>
    </LienPriorityType>
    <LienPriorityDescription>
    </LienPriorityDescription>
    <AmortizationType>
    </AmortizationType>
    <AmortizationDescription>
    </AmortizationDescription>
    <NationalHousingActType>
    </NationalHousingActType>
    <HudSFDMSID>
    </HudSFDMSID>
    <MERSLoanID>
    </MERSLoanID>
    <MortgageType>
    </MortgageType>
    <MortgageDescription>
    </MortgageDescription>
    <InterestRateCurrent>
    </InterestRateCurrent>
    <AmortizationTerm>
    </AmortizationTerm>
    <InterestInAdvance>
    </InterestInAdvance>
    <CapitalizedLoan>
    </CapitalizedLoan>
    <LoanMaturityDate>
    </LoanMaturityDate>
    <Assumable>
    </Assumable>
    <AssumableDate>
    </AssumableDate>
    <AssumableTerm>
    </AssumableTerm>
    <Assumed>
    </Assumed>
    <AssumedDate>
    </AssumedDate>
    <PaymentHistory>
    </PaymentHistory>
    <Product>
    </Product>
    <InterestOnly>
    </InterestOnly>
    <InterestOnlyTerm>
    </InterestOnlyTerm>
    <PITI>
    </PITI>
    <UPBAmount>12345.6700</UPBAmount>
    <AcceleratedPaymentProgram>
    </AcceleratedPaymentProgram>
    <NextPaymentDue>
    </NextPaymentDue>
    <LastPaymentReceived>
    </LastPaymentReceived>
    <InterestPaidThrough>
    </InterestPaidThrough>
    <InterestCalculation>
    </InterestCalculation>
    <OriginalBalance>
    </OriginalBalance>
    <PerDiem>
    </PerDiem>
    <PaymentAmount>
    </PaymentAmount>
    <PayoffAmount>
    </PayoffAmount>
    <PayoffGoodThroughDate>
    </PayoffGoodThroughDate>
    <PaidInFull>
    </PaidInFull>
    <TotalAmountDue>
    </TotalAmountDue>
    <LateChargeBalance>
    </LateChargeBalance>
    <SuspenseBalance>
    </SuspenseBalance>
    <EquityPosition>
    </EquityPosition>
    <EquityDate>
    </EquityDate>
    <InsurerID>
    </InsurerID>
    <InsurerLoanID>
    </InsurerLoanID>
    <InsurerGuaranteePercentage>
    </InsurerGuaranteePercentage>
    <InsurerPremiumPercentage>
    </InsurerPremiumPercentage>
    <InvestorID>
    </InvestorID>
    <InvestorLoanID>
    </InvestorLoanID>
    <Priority>
    </Priority>
    <SeniorLoanID>
    </SeniorLoanID>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <NegativeAmortization>
    </NegativeAmortization>
    <NegativeAmortizationCap>
    </NegativeAmortizationCap>
    <LTVOriginal>
    </LTVOriginal>
    <LTVCurrent>
    </LTVCurrent>
    <CLTVOriginal>
    </CLTVOriginal>
    <CLTVCurrent>
    </CLTVCurrent>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <GracePeriodDays>
    </GracePeriodDays>
    <CurrentBeneficiaryID>
    </CurrentBeneficiaryID>
    <OriginalBeneficiaryID>
    </OriginalBeneficiaryID>
    <CurrentNoteContactID>
    </CurrentNoteContactID>
    <OriginalNoteContactID>
    </OriginalNoteContactID>
    <InterestRateOriginal>
    </InterestRateOriginal>
    <LateChargeAmount>
    </LateChargeAmount>
    <CorporateAdvanceBalance>
    </CorporateAdvanceBalance>
    <EscrowBalance>
    </EscrowBalance>
    <StopCodes>
    </StopCodes>
    <Principal>
    </Principal>
    <Interest>
    </Interest>
    <Taxes>
    </Taxes>
    <Insurance>
    </Insurance>
    <Status>
    </Status>
    <CreatedPersonID>645</CreatedPersonID>
    <CreatedDate>2016-01-11T09:16:05-08:00</CreatedDate>
    <UpdatedPersonID>645</UpdatedPersonID>
    <UpdatedDate>2016-01-11T09:16:05-08:00</UpdatedDate>
    <Address>123 Maple</Address>
    <City>Anywhere</City>
    <State>CA</State>
    <PostalCode>92101</PostalCode>
    <Property>Spec Test - Property ija8fchq</Property>
    <ParentLoan>
    </ParentLoan>
    <Servicer>
    </Servicer>
    <Agency>Freddie Mac</Agency>
    <Insurer>
    </Insurer>
    <Investor>
    </Investor>
    <SeniorLoan>
    </SeniorLoan>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <CurrentBeneficiary>
    </CurrentBeneficiary>
    <OriginalBeneficiary>
    </OriginalBeneficiary>
    <CurrentNoteContact>
    </CurrentNoteContact>
    <OriginalNoteContact>
    </OriginalNoteContact>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <Borrower1>
    </Borrower1>
    <Borrower2>
    </Borrower2>
    <RecordCount>500</RecordCount>
  </LoanItem>
</LoanCollection>

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

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

Mortgage/Loan.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: Loan.ashx/ListWhere?LoanID=1,2,3
  • Response:
<LoanCollection>
  <LoanItem>
    <LoanID>2</LoanID>
    <Loan>0123456</Loan>
  </LoanItem>
  <LoanItem>
    <LoanID>3</LoanID>
    <Loan>0123459</Loan>
  </LoanItem>
  <LoanItem>
    <LoanID>1</LoanID>
    <Loan>723475987</Loan>
  </LoanItem>
</LoanCollection>
⚠️ **GitHub.com Fallback** ⚠️