Offer Class - quandis/qbo3-Documentation GitHub Wiki

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

Offer properties

Column Type Required Description
AcceptedAmount double
AcceptedDate dateTime
AcceptedPersonID integer
Active string
ActiveStatus string
ApprovedDate dateTime
ApprovedPersonID integer
Batch integer
BuyerAgentID integer
BuyerID integer
CanDelete string
CanInsert string
CanUpdate string
ClosingEstimated dateTime
CreatedDate dateTime
CreatedPersonID integer
CreditAmount double
CurrentOfferID integer
DepositAmount double
EnteredPersonID integer
Extranet string
FinalStatus string
Form string
InDecisionID string
InImportFileID string
LinkedFrom string
LinkedTo string
MetaXML string
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
Offer string yes Label for the table.
OfferAmount double
OfferDate dateTime
OfferExpires dateTime
OfferID integer yes Identity column and primary key for the table.
OfferLedgerID integer
OfferType string Enumerated values; set by power user in ObjectType table.
ParentOfferID integer
PropertyID integer
ReviewedDate dateTime
ReviewedPersonID integer
SellerAgentID integer
SellerID integer
SourceXml string Deprecated
Status string
Tags string
Terms string
TransactionDate dateTime
TransactionType string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
ViewAsRole string
WithdrawnDate dateTime
WithdrawnPersonID integer
Worklist string

Related modules

Related Objects Module Relationship
AcceptedPerson qbo.Security.PersonObject Foreign Key
Access Child
ApprovedPerson qbo.Security.PersonObject Foreign Key
Attachments Attachment Child
Buyer qbo.Contact.ContactObject Foreign Key
BuyerAgent qbo.Contact.ContactObject Foreign Key
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Decisions Decision Child
EnteredPerson qbo.Security.PersonObject Foreign Key
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
OfferLedger qbo.Accounting.LedgerObject Foreign Key
Property qbo.Mortgage.PropertyObject Foreign Key
Regions Geography Child
ReviewedPerson qbo.Security.PersonObject Foreign Key
Scores Score Child
SearchIndexes SearchIndex Child
Seller qbo.Contact.ContactObject Foreign Key
SellerAgent qbo.Contact.ContactObject Foreign Key
WithdrawnPerson qbo.Security.PersonObject Foreign Key
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Offer.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 Offer.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: Offer.ashx/Search?Offer=ABC123
  • Response:


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


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


Mortgage/Offer.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: Offer.ashx/ListWhere?OfferID=1,2,3

    • 

  • Response:
    • 



<OfferCollection>
  <OfferItem>
    <OfferID>19</OfferID>
    <Offer>12-90543256</Offer>
  </OfferItem>
</OfferCollection>


              


           
⚠️ **GitHub.com Fallback** ⚠️