ArmTerm Class - quandis/qbo3-Documentation GitHub Wiki

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

ArmTerm properties

Column Type Required Description
Active string
ActiveStatus string
AmountMoney double
ArmTerm string yes Label for the table.
ArmTermID integer yes Identity column and primary key for the table.
BaseRate double
Batch integer
CanDelete string
CanInsert string
CanUpdate string
ChangeFrequency integer
CreatedDate dateTime
CreatedPersonID integer
Extranet string
FinalStatus string
FirstChange integer
Form string
HighestPossibleRate double
InDecisionID string
IndexName string
IndexRate integer
InImportFileID string
InterestChangeCeilingRate double
InterestChangeFloorRate double
LinkedFrom string
LinkedTo string
LoanID integer
LowestPossibleRate double
Margin double
MaxInitialDecrease double
MaxInitialIncrease double
MaxSubsequentDecrease double
MaxSubsequentIncrease double
NextChangeDate dateTime
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
RoundingRule string
StartDate dateTime
Status string
Tags string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
ViewAsRole string
Worklist string

Related modules

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

Method signatures

Mortgage/ArmTerm.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 ArmTerm.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: ArmTerm.ashx/Search?ArmTerm=ABC123
  • Response:
<ArmTermCollection>
  <ArmTermItem>
    <ArmTermID>28</ArmTermID>
    <ArmTerm>225680</ArmTerm>
    <LoanID>626</LoanID>
    <BaseRate>2.250000</BaseRate>
    <AmountMoney>
    </AmountMoney>
    <LowestPossibleRate>
    </LowestPossibleRate>
    <HighestPossibleRate>
    </HighestPossibleRate>
    <ChangeFrequency>12</ChangeFrequency>
    <MaxInitialIncrease>
    </MaxInitialIncrease>
    <MaxInitialDecrease>
    </MaxInitialDecrease>
    <RoundingRule>
    </RoundingRule>
    <MaxSubsequentIncrease>2.000000</MaxSubsequentIncrease>
    <MaxSubsequentDecrease>
    </MaxSubsequentDecrease>
    <StartDate>2015-03-01T00:00:00-08:00</StartDate>
    <NextChangeDate>
    </NextChangeDate>
    <IndexName>
    </IndexName>
    <Margin>2.250000</Margin>
    <InterestChangeFloorRate>2.250000</InterestChangeFloorRate>
    <InterestChangeCeilingRate>11.750000</InterestChangeCeilingRate>
    <IndexRate>
    </IndexRate>
    <FirstChange>37</FirstChange>
    <Object>
    </Object>
    <ObjectID>
    </ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>1</CreatedPersonID>
    <CreatedDate>2015-01-08T12:09:37.647-08:00</CreatedDate>
    <UpdatedPersonID>
    </UpdatedPersonID>
    <UpdatedDate>
    </UpdatedDate>
    <ServicerID>1</ServicerID>
    <Servicer>Demo Servicer</Servicer>
    <ServicerLoanID>10225680</ServicerLoanID>
    <AgencyID>334</AgencyID>
    <Agency>Unkn</Agency>
    <AgencyLoanID>1706083846</AgencyLoanID>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <InvestorID>131</InvestorID>
    <Investor>CTX Mortgage Company LLC</Investor>
    <InvestorLoanID>1706083846</InvestorLoanID>
    <Address>5765 CUSTER AVENUE #232</Address>
    <City>JERSEY CITY</City>
    <State>FL</State>
    <PostalCode>33321</PostalCode>
    <Loan>10225680</Loan>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>
    </UpdatedPerson>
    <ParentLabel>
    </ParentLabel>
    <Grandparent>
    </Grandparent>
    <GrandparentID>
    </GrandparentID>
    <RecordCount>7</RecordCount>
  </ArmTermItem>
  <ArmTermItem>
    <ArmTermID>29</ArmTermID>
    <ArmTerm>229618</ArmTerm>
    <LoanID>632</LoanID>
    <BaseRate>6.268000</BaseRate>
    <AmountMoney>
    </AmountMoney>
    <LowestPossibleRate>
    </LowestPossibleRate>
    <HighestPossibleRate>
    </HighestPossibleRate>
    <ChangeFrequency>6</ChangeFrequency>
    <MaxInitialIncrease>
    </MaxInitialIncrease>
    <MaxInitialDecrease>
    </MaxInitialDecrease>
    <RoundingRule>
    </RoundingRule>
    <MaxSubsequentIncrease>1.000000</MaxSubsequentIncrease>
    <MaxSubsequentDecrease>
    </MaxSubsequentDecrease>
    <StartDate>2015-08-01T00:00:00-07:00</StartDate>
    <NextChangeDate>
    </NextChangeDate>
    <IndexName>0.328</IndexName>
    <Margin>5.940000</Margin>
    <InterestChangeFloorRate>10.040000</InterestChangeFloorRate>
    <InterestChangeCeilingRate>17.040000</InterestChangeCeilingRate>
    <IndexRate>
    </IndexRate>
    <FirstChange>43</FirstChange>
    <Object>
    </Object>
    <ObjectID>
    </ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>1</CreatedPersonID>
    <CreatedDate>2015-01-08T12:09:37.65-08:00</CreatedDate>
    <UpdatedPersonID>
    </UpdatedPersonID>
    <UpdatedDate>
    </UpdatedDate>
    <ServicerID>1</ServicerID>
    <Servicer>Demo Servicer</Servicer>
    <ServicerLoanID>10229698</ServicerLoanID>
    <AgencyID>334</AgencyID>
    <Agency>Unkn</Agency>
    <AgencyLoanID>1361005</AgencyLoanID>
    <ContextIdentifierLoanID>
    </ContextIdentifierLoanID>
    <InvestorID>124</InvestorID>
    <Investor>GLAV FUND III TRUST</Investor>
    <InvestorLoanID>1361005</InvestorLoanID>
    <Address>1496 KEYSTONE ST</Address>
    <City>MEYERSDALE</City>
    <State>NJ</State>
    <PostalCode>08103</PostalCode>
    <Loan>10229698</Loan>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>
    </UpdatedPerson>
    <ParentLabel>
    </ParentLabel>
    <Grandparent>
    </Grandparent>
    <GrandparentID>
    </GrandparentID>
    <RecordCount>7</RecordCount>
  </ArmTermItem>
</ArmTermCollection>

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

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

Mortgage/ArmTerm.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: ArmTerm.ashx/ListWhere?ArmTermID=1,2,3
  • Response:
<ArmTermCollection>
  <ArmTermItem>
    <ArmTermID>28</ArmTermID>
    <ArmTerm>225680</ArmTerm>
  </ArmTermItem>
  <ArmTermItem>
    <ArmTermID>29</ArmTermID>
    <ArmTerm>229618</ArmTerm>
  </ArmTermItem>
</ArmTermCollection>
⚠️ **GitHub.com Fallback** ⚠️