Bankruptcy Class - quandis/qbo3-Documentation GitHub Wiki
The Mortgage module's Bankruptcy table is based on the MISMO data dictionary standard.
Column | Type | Required | Description |
---|---|---|---|
Active | string | ||
ActiveStatus | string | ||
ActiveWorkflow | string | ||
Asset | boolean | ||
AssignedOrganizationID | integer | ||
AssignedPersonID | integer | ||
Bankruptcy | string | yes | Label for the table. |
BankruptcyID | integer | yes | Identity column and primary key for the table. |
BarDate | dateTime | ||
Batch | integer | ||
BecamePastStandard | string | ||
BKCaseNo | string | ||
CanDelete | string | ||
CanInsert | string | ||
CanUpdate | string | ||
Chapter | string | ||
ClientID | integer | ||
ClientPersonID | integer | ||
Closed | string | ||
ClosedReason | string | ||
CoDebtorContactID | integer | ||
CostLedgerID | integer | ||
CourtID | integer | ||
Cramdown | boolean | ||
CreatedDate | dateTime | ||
CreatedPersonID | integer | ||
CurrentDecisionID | integer | ||
DateClosed | dateTime | ||
DateDue | dateTime | ||
DateOpened | dateTime | ||
DebtorAttorneyContactID | integer | ||
DebtorContactID | integer | ||
DecisionStep | string | ||
DecisionTemplate | string | ||
Entity | string | ||
EntityParent | string | ||
ExcludePendingSteps | string | ||
Extranet | string | ||
FilingDate | dateTime | ||
FinalStatus | string | ||
Form | string | ||
InDecisionID | string | ||
InImportFileID | string | ||
LinkedFrom | string | ||
LinkedTo | string | ||
LitigationDelays | string | ||
LoanState | string | ||
MetaXml | string | Deprecated | |
NonCompliant | string | ||
NotLinkedFrom | string | ||
NotLinkedTo | string | ||
Object | string | ||
ObjectID | integer | ||
OnHold | string | ||
Open | string | ||
OpenAsOf | string | ||
OpenedReason | string | ||
OtherDelays | string | ||
ParentID | integer | ||
PastStandardInflow | string | ||
PastStandardOutflow | string | ||
POCFiledDate | dateTime | ||
POCLedgerID | integer | ||
PostPetitionDate | dateTime | ||
PrePostPetitionLedgerID | integer | ||
Priority | integer | ||
Process | string | ||
ProcessID | integer | ||
ProcessSiblingList | string | ||
ProcessTemplateID | integer | ||
ProcessType | string | ||
PropertyState | string | ||
ServicerID | string | ||
Sibling | string | ||
SiblingID | integer | ||
SourceXml | string | Deprecated | |
State | string | ||
StateOfFiling | string | ||
Status | string | ||
Step | string | ||
StepExists | string | ||
Tags | string | ||
TimeSpan | string | ||
TrusteeContactID | integer | ||
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 |
Client | qbo.Contact.OrganizationObject | Foreign Key |
ClientPerson | qbo.Security.PersonObject | Foreign Key |
CoDebtorContact | qbo.Contact.ContactObject | 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 |
DebtorAttorneyContact | qbo.Contact.ContactObject | Foreign Key |
DebtorContact | qbo.Contact.ContactObject | Foreign Key |
Decisions | Decision | Child |
Delays | DecisionDelay | Child |
Forms | ImportForm | Child |
Labels | CollectionMember | Child |
Ledgers | Ledger | Child |
Messages | Message | Child |
POCLedger | qbo.Accounting.LedgerObject | Foreign Key |
PrePostPetitionLedger | qbo.Accounting.LedgerObject | Foreign Key |
ProcessTemplate | qbo.Process.ProcessTemplateObject | Foreign Key |
Regions | Geography | Child |
Scores | Score | Child |
SearchIndexes | SearchIndex | Child |
TrusteeContact | qbo.Contact.ContactObject | 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 theBankruptcy.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:
Bankruptcy.ashx/Search?Bankruptcy=ABC123
- Response:
<BankruptcyCollection>
<BankruptcyItem>
<BankruptcyID>464</BankruptcyID>
<Bankruptcy>
<<Auto>>
</Bankruptcy>
<DebtorAttorneyContactID>
</DebtorAttorneyContactID>
<Chapter>
</Chapter>
<FilingDate>
</FilingDate>
<BarDate>
</BarDate>
<PostPetitionDate>
</PostPetitionDate>
<POCFiledDate>
</POCFiledDate>
<StateOfFiling>
</StateOfFiling>
<BKCaseNo>
</BKCaseNo>
<CourtID>
</CourtID>
<ProcessID>1773</ProcessID>
<TrusteeContactID>
</TrusteeContactID>
<ParentID>
</ParentID>
<Asset>
</Asset>
<DebtorContactID>
</DebtorContactID>
<CoDebtorContactID>
</CoDebtorContactID>
<POCLedgerID>
</POCLedgerID>
<PrePostPetitionLedgerID>
</PrePostPetitionLedgerID>
<Cramdown>
</Cramdown>
<Process>
<<Auto>>
</Process>
<ProcessTemplateID>115</ProcessTemplateID>
<Sibling>Bankruptcy</Sibling>
<SiblingID>464</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>
</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>
</DateClosed>
<ClosedReason>
</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>
</CostLedgerID>
<CurrentDecisionID>
</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>
</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>
</Object>
<ObjectID>
</ObjectID>
<Status>
</Status>
<CreatedPersonID>470</CreatedPersonID>
<CreatedDate>2013-04-03T17:38:02.537-07:00</CreatedDate>
<UpdatedPersonID>470</UpdatedPersonID>
<UpdatedDate>2013-04-03T17:38:03.073-07:00</UpdatedDate>
<DebtorAttorneyContact>
</DebtorAttorneyContact>
<Court>
</Court>
<TrusteeContact>
</TrusteeContact>
<DebtorContact>
</DebtorContact>
<CoDebtorContact>
</CoDebtorContact>
<POCLedger>
</POCLedger>
<PrePostPetitionLedger>
</PrePostPetitionLedger>
<ProcessTemplate>Motion For Relief</ProcessTemplate>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<AssignedOrganizationAddress>
</AssignedOrganizationAddress>
<AssignedOrganizationCity>
</AssignedOrganizationCity>
<AssignedOrganizationState>
</AssignedOrganizationState>
<AssignedOrganizationPostalCode>
</AssignedOrganizationPostalCode>
<AssignedOrganizationPhone>
</AssignedOrganizationPhone>
<AssignedOrganizationEmail>
</AssignedOrganizationEmail>
<Loan>
</Loan>
<ServicerLoanID>
</ServicerLoanID>
<ServicerID>
</ServicerID>
<AgencyLoanID>
</AgencyLoanID>
<AgencyID>
</AgencyID>
<Servicer>
</Servicer>
<Agency>
</Agency>
<RecordCount>388</RecordCount>
</BankruptcyItem>
<BankruptcyItem>
<BankruptcyID>465</BankruptcyID>
<Bankruptcy>
<<Auto>>
</Bankruptcy>
<DebtorAttorneyContactID>
</DebtorAttorneyContactID>
<Chapter>
</Chapter>
<FilingDate>
</FilingDate>
<BarDate>
</BarDate>
<PostPetitionDate>
</PostPetitionDate>
<POCFiledDate>
</POCFiledDate>
<StateOfFiling>
</StateOfFiling>
<BKCaseNo>
</BKCaseNo>
<CourtID>
</CourtID>
<ProcessID>1774</ProcessID>
<TrusteeContactID>
</TrusteeContactID>
<ParentID>
</ParentID>
<Asset>
</Asset>
<DebtorContactID>
</DebtorContactID>
<CoDebtorContactID>
</CoDebtorContactID>
<POCLedgerID>
</POCLedgerID>
<PrePostPetitionLedgerID>
</PrePostPetitionLedgerID>
<Cramdown>
</Cramdown>
<Process>
<<Auto>>
</Process>
<ProcessTemplateID>115</ProcessTemplateID>
<Sibling>Bankruptcy</Sibling>
<SiblingID>465</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>
</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>
</DateClosed>
<ClosedReason>
</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>
</CostLedgerID>
<CurrentDecisionID>
</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>
</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>
</Object>
<ObjectID>
</ObjectID>
<Status>
</Status>
<CreatedPersonID>470</CreatedPersonID>
<CreatedDate>2013-04-03T17:39:05.887-07:00</CreatedDate>
<UpdatedPersonID>470</UpdatedPersonID>
<UpdatedDate>2013-04-03T17:39:05.98-07:00</UpdatedDate>
<DebtorAttorneyContact>
</DebtorAttorneyContact>
<Court>
</Court>
<TrusteeContact>
</TrusteeContact>
<DebtorContact>
</DebtorContact>
<CoDebtorContact>
</CoDebtorContact>
<POCLedger>
</POCLedger>
<PrePostPetitionLedger>
</PrePostPetitionLedger>
<ProcessTemplate>Motion For Relief</ProcessTemplate>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<AssignedOrganizationAddress>
</AssignedOrganizationAddress>
<AssignedOrganizationCity>
</AssignedOrganizationCity>
<AssignedOrganizationState>
</AssignedOrganizationState>
<AssignedOrganizationPostalCode>
</AssignedOrganizationPostalCode>
<AssignedOrganizationPhone>
</AssignedOrganizationPhone>
<AssignedOrganizationEmail>
</AssignedOrganizationEmail>
<Loan>
</Loan>
<ServicerLoanID>
</ServicerLoanID>
<ServicerID>
</ServicerID>
<AgencyLoanID>
</AgencyLoanID>
<AgencyID>
</AgencyID>
<Servicer>
</Servicer>
<Agency>
</Agency>
<RecordCount>388</RecordCount>
</BankruptcyItem>
</BankruptcyCollection>
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:
Bankruptcy.ashx/ListWhere?BankruptcyID=1,2,3
- Response:
<BankruptcyCollection>
<BankruptcyItem>
<BankruptcyID>495</BankruptcyID>
<Bankruptcy>10000024</Bankruptcy>
</BankruptcyItem>
<BankruptcyItem>
<BankruptcyID>498</BankruptcyID>
<Bankruptcy>10000027</Bankruptcy>
</BankruptcyItem>
</BankruptcyCollection>