BidAtSale Class - quandis/qbo3-Documentation GitHub Wiki

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

BidAtSale properties

Column Type Required Description
Active string
ActiveStatus string
ActiveWorkflow string
AssignedOrganizationID integer
AssignedPersonID integer
Batch integer
BidAmountReceived double
BidAmountSent double
BidAtSale string yes Label for the table.
BidAtSaleID integer yes Identity column and primary key for the table.
BidDue dateTime
BidExpired dateTime
BidIncrement double
BidMax double
BidOpening double
BidRiskApproval string
CanDelete string
CanInsert string
CanUpdate string
ClientID integer
ClientPersonID integer
Closed string
ClosedReason string
CostLedgerID integer
CreatedDate dateTime
CreatedPersonID integer
CurrentDecisionID integer
DateClosed dateTime
DateDue dateTime
DateOpened dateTime
DecisionStep string
DefaultAmount double
DisbursingAttorneyID integer
DisbursingContactID integer
Entity string
EntityParent string
Extranet string
FinalStatus string
Form string
FundsReceived dateTime
FundsRequired dateTime
InDecisionID string
InImportFileID string
Instructions string
LedgerID integer
LinkedFrom string
LinkedTo string
MetaXml string Deprecated
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
OnHold string
Open string
OpenAsOf string
OpenedReason string
ParentBidID integer
PendingHazardInsuranceClaim string
Priority integer
Process string
ProcessID integer
ProcessTemplateID integer
ProcessType string
PropertyID integer
SaleDate dateTime
SaleLocation string
SalePrice double
SaleTime string
SeniorLienHolder boolean
Sibling string
SiblingID integer
SourceXml string Deprecated
Status string
Tags string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
ValuationID integer
VendorID integer
VendorPersonID integer
VestingContactID integer
ViewAsRole string
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
Client qbo.Contact.OrganizationObject Foreign Key
ClientPerson qbo.Security.PersonObject Foreign Key
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
CostLedger qbo.Accounting.LedgerObject Foreign Key
CurrentDecision qbo.Decision.DecisionObject Foreign Key
Decisions Decision Child
Delays DecisionDelay Child
DisbursingAttorney qbo.Contact.OrganizationObject Foreign Key
DisbursingContact qbo.Contact.ContactObject Foreign Key
Forms ImportForm Child
Labels CollectionMember Child
Ledger qbo.Accounting.LedgerObject Foreign Key
Ledgers Ledger Child
Messages Message Child
ProcessTemplate qbo.Process.ProcessTemplateObject Foreign Key
Property qbo.Mortgage.PropertyObject Foreign Key
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Valuation qbo.Mortgage.ValuationObject Foreign Key
Vendor qbo.Contact.OrganizationObject Foreign Key
VendorPerson qbo.Security.PersonObject Foreign Key
VestingContact qbo.Contact.ContactObject Foreign Key
Worklists SmartWorklistMember Child

Method signatures

Mortgage/BidAtSale.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 BidAtSale.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: BidAtSale.ashx/Search?BidAtSale=ABC123
  • Response:
<BidAtSaleCollection>
  <BidAtSaleItem>
    <BidAtSaleID>46</BidAtSaleID>
    <BidAtSale>
      <<Auto>>
    </BidAtSale>
    <PropertyID>634</PropertyID>
    <ProcessID>500</ProcessID>
    <ParentBidID>
    </ParentBidID>
    <SaleDate>2015-02-01T00:00:00-08:00</SaleDate>
    <SaleTime>
    </SaleTime>
    <SaleLocation>
    </SaleLocation>
    <BidExpired>
    </BidExpired>
    <Instructions>Bid increments for this file are in 20,000 increments.</Instructions>
    <VestingContactID>
    </VestingContactID>
    <SeniorLienHolder>
    </SeniorLienHolder>
    <DisbursingAttorneyID>
    </DisbursingAttorneyID>
    <DisbursingContactID>
    </DisbursingContactID>
    <FundsRequired>
    </FundsRequired>
    <FundsReceived>
    </FundsReceived>
    <BidMax>340000.0000</BidMax>
    <DefaultAmount>
    </DefaultAmount>
    <BidOpening>239000.0000</BidOpening>
    <SalePrice>
    </SalePrice>
    <BidAmountReceived>
    </BidAmountReceived>
    <BidAmountSent>
    </BidAmountSent>
    <BidDue>2015-01-23T00:00:00-08:00</BidDue>
    <BidIncrement>
    </BidIncrement>
    <ValuationID>288</ValuationID>
    <LedgerID>
    </LedgerID>
    <PendingHazardInsuranceClaim>None on this file</PendingHazardInsuranceClaim>
    <BidRiskApproval>None</BidRiskApproval>
    <Process>
      <<Auto>>
    </Process>
    <ProcessTemplateID>3</ProcessTemplateID>
    <Sibling>BidAtSale</Sibling>
    <SiblingID>46</SiblingID>
    <ProcessType>Specified</ProcessType>
    <Priority>
    </Priority>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <VendorID>
    </VendorID>
    <VendorPersonID>
    </VendorPersonID>
    <DateOpened>
    </DateOpened>
    <OpenedReason>
    </OpenedReason>
    <DateClosed>
    </DateClosed>
    <ClosedReason>
    </ClosedReason>
    <DateDue>
    </DateDue>
    <CostLedgerID>1544</CostLedgerID>
    <CurrentDecisionID>
    </CurrentDecisionID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <ClientID>
    </ClientID>
    <ClientPersonID>
    </ClientPersonID>
    <Object>Loan</Object>
    <ObjectID>644</ObjectID>
    <Status>Requested</Status>
    <CreatedPersonID>2</CreatedPersonID>
    <CreatedDate>2015-01-23T14:13:10.477-08:00</CreatedDate>
    <UpdatedPersonID>2</UpdatedPersonID>
    <UpdatedDate>2015-01-23T14:16:49.003-08:00</UpdatedDate>
    <Address>57 W LIBERTY ST</Address>
    <City>ALLENTOWN</City>
    <State>NJ</State>
    <PostalCode>08880</PostalCode>
    <Property>57 W LIBERTY ST</Property>
    <ParentBid>
    </ParentBid>
    <VestingContact>
    </VestingContact>
    <DisbursingAttorney>
    </DisbursingAttorney>
    <DisbursingContact>
    </DisbursingContact>
    <Valuation>230839</Valuation>
    <Ledger>
    </Ledger>
    <ProcessTemplate>Bid At Sale</ProcessTemplate>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <Vendor>
    </Vendor>
    <VendorPerson>
    </VendorPerson>
    <CostLedger>Foreclosure Bid</CostLedger>
    <CurrentDecision>
    </CurrentDecision>
    <Client>
    </Client>
    <ClientPerson>
    </ClientPerson>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <ParentLabel>10230839</ParentLabel>
    <Grandparent>Property</Grandparent>
    <GrandparentID>634</GrandparentID>
    <RecordCount>180</RecordCount>
  </BidAtSaleItem>
  <BidAtSaleItem>
    <BidAtSaleID>49</BidAtSaleID>
    <BidAtSale>
      <<Auto>>
    </BidAtSale>
    <PropertyID>634</PropertyID>
    <ProcessID>503</ProcessID>
    <ParentBidID>
    </ParentBidID>
    <SaleDate>2015-02-01T00:00:00-08:00</SaleDate>
    <SaleTime>
    </SaleTime>
    <SaleLocation>
    </SaleLocation>
    <BidExpired>
    </BidExpired>
    <Instructions>
    </Instructions>
    <VestingContactID>
    </VestingContactID>
    <SeniorLienHolder>
    </SeniorLienHolder>
    <DisbursingAttorneyID>
    </DisbursingAttorneyID>
    <DisbursingContactID>
    </DisbursingContactID>
    <FundsRequired>
    </FundsRequired>
    <FundsReceived>
    </FundsReceived>
    <BidMax>
    </BidMax>
    <DefaultAmount>
    </DefaultAmount>
    <BidOpening>
    </BidOpening>
    <SalePrice>
    </SalePrice>
    <BidAmountReceived>
    </BidAmountReceived>
    <BidAmountSent>
    </BidAmountSent>
    <BidDue>
    </BidDue>
    <BidIncrement>
    </BidIncrement>
    <ValuationID>
    </ValuationID>
    <LedgerID>
    </LedgerID>
    <PendingHazardInsuranceClaim>
    </PendingHazardInsuranceClaim>
    <BidRiskApproval>
    </BidRiskApproval>
    <Process>
      <<Auto>>
    </Process>
    <ProcessTemplateID>3</ProcessTemplateID>
    <Sibling>BidAtSale</Sibling>
    <SiblingID>49</SiblingID>
    <ProcessType>
    </ProcessType>
    <Priority>
    </Priority>
    <AssignedOrganizationID>242</AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <VendorID>
    </VendorID>
    <VendorPersonID>
    </VendorPersonID>
    <DateOpened>
    </DateOpened>
    <OpenedReason>
    </OpenedReason>
    <DateClosed>
    </DateClosed>
    <ClosedReason>
    </ClosedReason>
    <DateDue>
    </DateDue>
    <CostLedgerID>1548</CostLedgerID>
    <CurrentDecisionID>
    </CurrentDecisionID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <ClientID>
    </ClientID>
    <ClientPersonID>
    </ClientPersonID>
    <Object>Loan</Object>
    <ObjectID>644</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>2</CreatedPersonID>
    <CreatedDate>2015-04-17T09:25:09.9-07:00</CreatedDate>
    <UpdatedPersonID>2</UpdatedPersonID>
    <UpdatedDate>2015-04-17T09:25:11.863-07:00</UpdatedDate>
    <Address>57 W LIBERTY ST</Address>
    <City>ALLENTOWN</City>
    <State>NJ</State>
    <PostalCode>08880</PostalCode>
    <Property>57 W LIBERTY ST</Property>
    <ParentBid>
    </ParentBid>
    <VestingContact>
    </VestingContact>
    <DisbursingAttorney>
    </DisbursingAttorney>
    <DisbursingContact>
    </DisbursingContact>
    <Valuation>
    </Valuation>
    <Ledger>
    </Ledger>
    <ProcessTemplate>Bid At Sale</ProcessTemplate>
    <AssignedOrganization>Scott, Joe, Wes & Kevin, PC - NJ</AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <Vendor>
    </Vendor>
    <VendorPerson>
    </VendorPerson>
    <CostLedger>Foreclosure Bid</CostLedger>
    <CurrentDecision>
    </CurrentDecision>
    <Client>
    </Client>
    <ClientPerson>
    </ClientPerson>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <ParentLabel>10230839</ParentLabel>
    <Grandparent>Property</Grandparent>
    <GrandparentID>634</GrandparentID>
    <RecordCount>180</RecordCount>
  </BidAtSaleItem>
</BidAtSaleCollection>

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

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

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