Foreclosure Class - quandis/qbo3-Documentation GitHub Wiki
The Mortgage module's Foreclosure table is based on the MISMO data dictionary standard.
Column | Type | Required | Description |
---|---|---|---|
Active | string | ||
ActiveStatus | string | ||
ActiveWorkflow | string | ||
AssignedOrganizationID | integer | ||
AssignedPersonID | integer | ||
AuctionContactID | integer | ||
Batch | integer | ||
BecamePastStandard | string | ||
CanDelete | string | ||
CanInsert | string | ||
CanUpdate | string | ||
ClientID | integer | ||
ClientPersonID | integer | ||
Closed | string | ||
ClosedReason | string | ||
CostLedgerID | integer | ||
CourtID | integer | ||
CreatedDate | dateTime | ||
CreatedPersonID | integer | ||
CurrentDecisionID | integer | ||
DateClosed | dateTime | ||
DateDue | dateTime | ||
DateOpened | dateTime | ||
DecisionStep | string | ||
DecisionTemplate | string | ||
Defendent | string | ||
DeficiencyStatus | string | ||
Description | string | ||
Entity | string | ||
EntityParent | string | ||
ExcludePendingSteps | string | ||
Extranet | string | ||
FCCaseNumber | string | ||
FinalStatus | string | ||
Foreclosure | string | yes | Label for the table. |
ForeclosureID | integer | yes | Identity column and primary key for the table. |
ForeclosureInTheNameOf | string | ||
Form | string | ||
InDecisionID | string | ||
InImportFileID | string | ||
JudgeContactID | integer | ||
LinkedFrom | string | ||
LinkedTo | string | ||
LitigationDelays | string | ||
LoanID | integer | ||
LoanState | string | ||
MessageTemplatePriority | string | ||
MetaXml | string | Deprecated | |
NonCompliant | string | ||
NotLinkedFrom | string | ||
NotLinkedTo | string | ||
Object | string | ||
ObjectID | integer | ||
OnHold | string | ||
Open | string | ||
OpenAsOf | string | ||
OpenedReason | string | ||
OpeningBidAmount | double | ||
OtherDelays | string | ||
PastStandardInflow | string | ||
PastStandardOutflow | string | ||
Plaintiff | string | ||
Postponed | string | ||
Priority | integer | ||
Process | string | ||
ProcessID | integer | ||
ProcessSiblingList | string | ||
ProcessTemplateID | integer | ||
ProcessType | string | ||
PropertyID | integer | ||
PropertyState | string | ||
RedemptionAmount | double | ||
RedemptionDate | dateTime | ||
REOSales | string | ||
Restarted | string | ||
SaleAmount | double | ||
SaleDateStatus | string | ||
SaleDateType | string | ||
SaleLocationContactID | integer | ||
SalesScheduled | string | ||
ScheduledSaleDate | dateTime | ||
ServicerID | string | ||
Sibling | string | ||
SiblingID | integer | ||
SoldToName | string | ||
SourceXml | string | Deprecated | |
State | string | ||
Status | string | ||
Step | string | ||
StepExists | string | ||
SubTrusteeID | integer | ||
SurplusFunds | double | ||
Tags | string | ||
ThirdPartyContactID | integer | ||
ThirdPartySales | string | ||
TimeSpan | string | ||
TotalDebtLedgerID | integer | ||
TrusteeSaleGuaranteeNumber | string | ||
UnreadNotifications | string | ||
UpdatedDate | dateTime | ||
UpdatedPersonID | integer | ||
VendorID | integer | ||
VendorPersonID | integer | ||
ViewAsRole | string | ||
Worklist | string |
Related Objects | Module | Relationship |
---|---|---|
Access | Child | |
AssignedOrganization | qbo.Contact.OrganizationObject | Foreign Key |
AssignedPerson | qbo.Security.PersonObject | Foreign Key |
Attachments | Attachment | Child |
AuctionContact | qbo.Contact.ContactObject | Foreign Key |
BidAtSales | BidAtSale | Child |
Borrowers | Borrower | 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 |
Court | qbo.Contact.CourtObject | Foreign Key |
CurrentDecision | qbo.Decision.DecisionObject | Foreign Key |
Decisions | Decision | Child |
Delays | DecisionDelay | Child |
Forms | ImportForm | Child |
JudgeContact | qbo.Contact.ContactObject | Foreign Key |
Labels | CollectionMember | Child |
Ledgers | Ledger | Child |
Loan | qbo.Mortgage.LoanObject | Foreign Key |
Messages | Message | Child |
ProcessTemplate | qbo.Process.ProcessTemplateObject | Foreign Key |
Property | qbo.Mortgage.PropertyObject | Foreign Key |
Regions | Geography | Child |
SaleLocationContact | qbo.Contact.ContactObject | Foreign Key |
Scores | Score | Child |
SearchIndexes | SearchIndex | Child |
SubTrustee | qbo.Contact.OrganizationObject | Foreign Key |
ThirdPartyContact | qbo.Contact.ContactObject | Foreign Key |
TotalDebtLedger | qbo.Accounting.LedgerObject | Foreign Key |
Vendor | qbo.Contact.OrganizationObject | Foreign Key |
VendorPerson | qbo.Security.PersonObject | Foreign Key |
Worklists | SmartWorklistMember | Child |
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 theForeclosure.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:
Foreclosure.ashx/Search?Foreclosure=ABC123
- Response:
<ForeclosureCollection>
<ForeclosureItem>
<ForeclosureID>1233</ForeclosureID>
<Foreclosure>
<<Auto>>
</Foreclosure>
<LoanID>726123</LoanID>
<PropertyID>805432</PropertyID>
<ProcessID>1751</ProcessID>
<CourtID>
</CourtID>
<JudgeContactID>
</JudgeContactID>
<FCCaseNumber>
</FCCaseNumber>
<Description>
</Description>
<Plaintiff>
</Plaintiff>
<Defendent>
</Defendent>
<ScheduledSaleDate>
</ScheduledSaleDate>
<SaleDateType>
</SaleDateType>
<SaleDateStatus>
</SaleDateStatus>
<SaleAmount>
</SaleAmount>
<SoldToName>
</SoldToName>
<ThirdPartyContactID>
</ThirdPartyContactID>
<AuctionContactID>
</AuctionContactID>
<SaleLocationContactID>
</SaleLocationContactID>
<OpeningBidAmount>
</OpeningBidAmount>
<SurplusFunds>
</SurplusFunds>
<RedemptionDate>
</RedemptionDate>
<RedemptionAmount>
</RedemptionAmount>
<TotalDebtLedgerID>
</TotalDebtLedgerID>
<SubTrusteeID>
</SubTrusteeID>
<TrusteeSaleGuaranteeNumber>
</TrusteeSaleGuaranteeNumber>
<DeficiencyStatus>Waived</DeficiencyStatus>
<ForeclosureInTheNameOf>
</ForeclosureInTheNameOf>
<Process>
<<Auto>>
</Process>
<ProcessTemplateID>1</ProcessTemplateID>
<Sibling>Foreclosure</Sibling>
<SiblingID>1233</SiblingID>
<ProcessType>Judicial</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>5</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2013-04-01T00:00:00-07:00</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>2014-04-01T00:00:00-07:00</DateClosed>
<ClosedReason>Paid Off</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>316</CostLedgerID>
<CurrentDecisionID>277</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>
</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>Loan</Object>
<ObjectID>726123</ObjectID>
<Status>Closed</Status>
<CreatedPersonID>465</CreatedPersonID>
<CreatedDate>2013-04-01T14:29:45.537-07:00</CreatedDate>
<UpdatedPersonID>486</UpdatedPersonID>
<UpdatedDate>2014-04-07T13:24:02.897-07:00</UpdatedDate>
<ServicerID>8436</ServicerID>
<Servicer>WELLS FARGO BANK, N.A.</Servicer>
<ServicerLoanID>117679</ServicerLoanID>
<AgencyID>3043</AgencyID>
<Agency>test</Agency>
<AgencyLoanID>070285721</AgencyLoanID>
<ContextIdentifierLoanID>
</ContextIdentifierLoanID>
<InvestorID>
</InvestorID>
<Investor>
</Investor>
<InvestorLoanID>
</InvestorLoanID>
<Address>8633 S BALI COURT</Address>
<City>ELLICOTT CITY</City>
<State>MD</State>
<PostalCode>21043</PostalCode>
<Loan>070285721</Loan>
<Property>8633 S BALI COURT</Property>
<Court>
</Court>
<JudgeContact>
</JudgeContact>
<ThirdPartyContact>
</ThirdPartyContact>
<AuctionContact>
</AuctionContact>
<SaleLocationContact>
</SaleLocationContact>
<TotalDebtLedger>
</TotalDebtLedger>
<SubTrustee>
</SubTrustee>
<ProcessTemplate>Foreclosure</ProcessTemplate>
<AssignedOrganization>a</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>Total Debt</CostLedger>
<CurrentDecision>Freddie MD Judicial Foreclosure</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<Borrower1>
</Borrower1>
<Borrower2>
</Borrower2>
<AssignedOrganizationAddress>bb</AssignedOrganizationAddress>
<AssignedOrganizationCity>c</AssignedOrganizationCity>
<AssignedOrganizationState>AK</AssignedOrganizationState>
<AssignedOrganizationPostalCode>11111</AssignedOrganizationPostalCode>
<AssignedOrganizationPhone>
</AssignedOrganizationPhone>
<AssignedOrganizationEmail>
</AssignedOrganizationEmail>
<RecordCount>348</RecordCount>
</ForeclosureItem>
<ForeclosureItem>
<ForeclosureID>1234</ForeclosureID>
<Foreclosure>
<<Auto>>
</Foreclosure>
<LoanID>725587</LoanID>
<PropertyID>804653</PropertyID>
<ProcessID>1752</ProcessID>
<CourtID>
</CourtID>
<JudgeContactID>
</JudgeContactID>
<FCCaseNumber>
</FCCaseNumber>
<Description>
</Description>
<Plaintiff>
</Plaintiff>
<Defendent>
</Defendent>
<ScheduledSaleDate>
</ScheduledSaleDate>
<SaleDateType>
</SaleDateType>
<SaleDateStatus>
</SaleDateStatus>
<SaleAmount>109000.0000</SaleAmount>
<SoldToName>Reverted to Senior</SoldToName>
<ThirdPartyContactID>
</ThirdPartyContactID>
<AuctionContactID>
</AuctionContactID>
<SaleLocationContactID>8246</SaleLocationContactID>
<OpeningBidAmount>100.0000</OpeningBidAmount>
<SurplusFunds>
</SurplusFunds>
<RedemptionDate>
</RedemptionDate>
<RedemptionAmount>
</RedemptionAmount>
<TotalDebtLedgerID>443</TotalDebtLedgerID>
<SubTrusteeID>
</SubTrusteeID>
<TrusteeSaleGuaranteeNumber>
</TrusteeSaleGuaranteeNumber>
<DeficiencyStatus>Waived</DeficiencyStatus>
<ForeclosureInTheNameOf>
</ForeclosureInTheNameOf>
<Process>
<<Auto>>
</Process>
<ProcessTemplateID>1</ProcessTemplateID>
<Sibling>Foreclosure</Sibling>
<SiblingID>1234</SiblingID>
<ProcessType>Judicial</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>21</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2013-04-01T00:00:00-07:00</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>2014-04-01T00:00:00-07:00</DateClosed>
<ClosedReason>Paid Off</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>320</CostLedgerID>
<CurrentDecisionID>1508</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>
</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>Loan</Object>
<ObjectID>725587</ObjectID>
<Status>Closed</Status>
<CreatedPersonID>465</CreatedPersonID>
<CreatedDate>2013-04-01T14:45:31.55-07:00</CreatedDate>
<UpdatedPersonID>486</UpdatedPersonID>
<UpdatedDate>2014-04-07T13:24:02.897-07:00</UpdatedDate>
<ServicerID>8436</ServicerID>
<Servicer>WELLS FARGO BANK, N.A.</Servicer>
<ServicerLoanID>135538</ServicerLoanID>
<AgencyID>3043</AgencyID>
<Agency>test</Agency>
<AgencyLoanID>007663668</AgencyLoanID>
<ContextIdentifierLoanID>
</ContextIdentifierLoanID>
<InvestorID>
</InvestorID>
<Investor>
</Investor>
<InvestorLoanID>
</InvestorLoanID>
<Address>6936 W TURQUOISE AVE</Address>
<City>PEORIA</City>
<State>AZ</State>
<PostalCode>85345</PostalCode>
<Loan>007663668</Loan>
<Property>6936 W TURQUOISE AVE</Property>
<Court>
</Court>
<JudgeContact>
</JudgeContact>
<ThirdPartyContact>
</ThirdPartyContact>
<AuctionContact>
</AuctionContact>
<SaleLocationContact>Sale Location</SaleLocationContact>
<TotalDebtLedger>Total Debt</TotalDebtLedger>
<SubTrustee>
</SubTrustee>
<ProcessTemplate>Foreclosure</ProcessTemplate>
<AssignedOrganization>Dewey Chetham Howe</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>Total Debt</CostLedger>
<CurrentDecision>Freddie AZ Judicial Foreclosure</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<Borrower1>
</Borrower1>
<Borrower2>
</Borrower2>
<AssignedOrganizationAddress>123 Main St</AssignedOrganizationAddress>
<AssignedOrganizationCity>Covina</AssignedOrganizationCity>
<AssignedOrganizationState>CA</AssignedOrganizationState>
<AssignedOrganizationPostalCode>91722</AssignedOrganizationPostalCode>
<AssignedOrganizationPhone>
</AssignedOrganizationPhone>
<AssignedOrganizationEmail>
</AssignedOrganizationEmail>
<RecordCount>348</RecordCount>
</ForeclosureItem>
</ForeclosureCollection>
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.
The delete method will delete all records where ID={comma-delimited list of identifiers}
criteria.
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:
Foreclosure.ashx/ListWhere?ForeclosureID=1,2,3
- Response:
<ForeclosureCollection>
<ForeclosureItem>
<ForeclosureID>1320</ForeclosureID>
<Foreclosure>10000000</Foreclosure>
</ForeclosureItem>
<ForeclosureItem>
<ForeclosureID>1239</ForeclosureID>
<Foreclosure>1000001</Foreclosure>
</ForeclosureItem>
</ForeclosureCollection>