Closing Class - quandis/qbo3-Documentation GitHub Wiki
The Mortgage module's Closing table is based on the MISMO data dictionary standard.
| Column | Type | Required | Description |
|---|---|---|---|
| Active | string | ||
| ActiveStatus | string | ||
| ActiveWorkflow | string | ||
| AssignedOrganizationID | integer | ||
| AssignedPersonID | integer | ||
| Batch | integer | ||
| BuyerBrokerContactID | integer | ||
| BuyerContactID | integer | ||
| BuyerLedgerID | integer | ||
| CanDelete | string | ||
| CanInsert | string | ||
| CanUpdate | string | ||
| ClientID | integer | ||
| ClientPersonID | integer | ||
| Closed | string | ||
| ClosedReason | string | ||
| Closing | string | yes | Label for the table. |
| ClosingActual | dateTime | ||
| ClosingEstimated | dateTime | ||
| ClosingID | integer | yes | Identity column and primary key for the table. |
| ContractID | integer | ||
| ContractReceived | dateTime | ||
| CostLedgerID | integer | ||
| CreatedDate | dateTime | ||
| CreatedPersonID | integer | ||
| CurrentDecisionID | integer | ||
| DateClosed | dateTime | ||
| DateDue | dateTime | ||
| DateOpened | dateTime | ||
| DaysOnMarket | integer | ||
| DecisionStep | string | ||
| Entity | string | ||
| EntityParent | string | ||
| EscrowCompanyID | integer | ||
| EscrowType | string | ||
| Extranet | string | ||
| FinalStatus | string | ||
| Form | string | ||
| InDecisionID | string | ||
| InImportFileID | string | ||
| LinkedFrom | string | ||
| LinkedTo | string | ||
| LoanApproved | dateTime | ||
| LoanID | integer | ||
| LoanSubmitted | dateTime | ||
| LocationID | integer | ||
| MetaXml | string | Deprecated | |
| NotLinkedFrom | string | ||
| NotLinkedTo | string | ||
| Object | string | ||
| ObjectID | integer | ||
| Open | string | ||
| OpenAsOf | string | ||
| OpenedReason | string | ||
| Priority | integer | ||
| ProceedsActual | double | ||
| ProceedsExpected | double | ||
| ProceedsReceived | dateTime | ||
| Process | string | ||
| ProcessID | integer | ||
| ProcessTemplateID | integer | ||
| ProcessType | string | ||
| PropertyID | integer | ||
| SaleDate | dateTime | ||
| SalePrice | double | ||
| SellerLedgerID | integer | ||
| SellingBrokerContactID | integer | ||
| SellingContactID | integer | ||
| Sibling | string | ||
| SiblingID | integer | ||
| SourceXml | string | Deprecated | |
| State | string | ||
| Status | string | ||
| Tags | string | ||
| TitleContactID | 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 |
| BuyerBrokerContact | qbo.Contact.ContactObject | Foreign Key |
| BuyerContact | qbo.Contact.ContactObject | Foreign Key |
| BuyerLedger | qbo.Accounting.LedgerObject | Foreign Key |
| Client | qbo.Contact.OrganizationObject | Foreign Key |
| ClientPerson | qbo.Security.PersonObject | Foreign Key |
| Collections | CollectionMember | Child |
| ConfigurationEntryCollection | ConfigurationEntry | Child |
| Contacts | Contact | Child |
| Contract | qbo.Attachment.AttachmentObject | Foreign Key |
| CostLedger | qbo.Accounting.LedgerObject | Foreign Key |
| CurrentDecision | qbo.Decision.DecisionObject | Foreign Key |
| Decisions | Decision | Child |
| Delays | DecisionDelay | Child |
| EscrowCompany | qbo.Contact.OrganizationObject | Foreign Key |
| Forms | ImportForm | Child |
| Labels | CollectionMember | Child |
| Ledgers | Ledger | Child |
| Loan | qbo.Mortgage.LoanObject | Foreign Key |
| Location | qbo.Contact.ContactObject | Foreign Key |
| Messages | Message | Child |
| ProcessTemplate | qbo.Process.ProcessTemplateObject | Foreign Key |
| Property | qbo.Mortgage.PropertyObject | Foreign Key |
| Regions | Geography | Child |
| Scores | Score | Child |
| SearchIndexes | SearchIndex | Child |
| SellerLedger | qbo.Accounting.LedgerObject | Foreign Key |
| SellingBrokerContact | qbo.Contact.ContactObject | Foreign Key |
| SellingContact | qbo.Contact.ContactObject | Foreign Key |
| TitleContact | 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 theClosing.Search.xslttemplate. - DisplaySize: determines the maximum number of rows returned. Default is 25.
DisplaySize=0will 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:
Closing.ashx/Search?Closing=ABC123 - Response:
<ClosingCollection>
<ClosingItem>
<ClosingID>4</ClosingID>
<Closing>17-LA1415156</Closing>
<PropertyID>629</PropertyID>
<LoanID>639</LoanID>
<BuyerContactID>
</BuyerContactID>
<BuyerBrokerContactID>
</BuyerBrokerContactID>
<SellingContactID>
</SellingContactID>
<SellingBrokerContactID>
</SellingBrokerContactID>
<TitleContactID>
</TitleContactID>
<SaleDate>
</SaleDate>
<SalePrice>
</SalePrice>
<LoanSubmitted>
</LoanSubmitted>
<LoanApproved>
</LoanApproved>
<ContractReceived>
</ContractReceived>
<ProceedsExpected>
</ProceedsExpected>
<ProceedsActual>
</ProceedsActual>
<ProceedsReceived>
</ProceedsReceived>
<ContractID>
</ContractID>
<ClosingEstimated>
</ClosingEstimated>
<ClosingActual>
</ClosingActual>
<SellerLedgerID>
</SellerLedgerID>
<BuyerLedgerID>
</BuyerLedgerID>
<ProcessID>531</ProcessID>
<EscrowType>
</EscrowType>
<EscrowCompanyID>
</EscrowCompanyID>
<LocationID>
</LocationID>
<DaysOnMarket>
</DaysOnMarket>
<Process>17-LA1415156</Process>
<ProcessTemplateID>10</ProcessTemplateID>
<Sibling>Closing</Sibling>
<SiblingID>4</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2017-08-04T00:00:00-07:00</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>
</DateClosed>
<ClosedReason>
</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>
</CostLedgerID>
<CurrentDecisionID>
</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>1</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>Loan</Object>
<ObjectID>639</ObjectID>
<Status>Escrow Delay</Status>
<CreatedPersonID>42</CreatedPersonID>
<CreatedDate>2017-08-04T09:46:33.147-07:00</CreatedDate>
<UpdatedPersonID>42</UpdatedPersonID>
<UpdatedDate>2017-08-04T09:53:55.923-07:00</UpdatedDate>
<ServicerID>1</ServicerID>
<Servicer>Demo Servicer</Servicer>
<ServicerLoanID>10229637</ServicerLoanID>
<AgencyID>334</AgencyID>
<Agency>Unkn</Agency>
<AgencyLoanID>1361024</AgencyLoanID>
<ContextIdentifierLoanID>
</ContextIdentifierLoanID>
<InvestorID>124</InvestorID>
<Investor>GLAV FUND III TRUST</Investor>
<InvestorLoanID>1361024</InvestorLoanID>
<Address>2016 58th Place</Address>
<City>San Diego</City>
<State>LA</State>
<PostalCode>70601</PostalCode>
<Property>2016 58th Place</Property>
<Loan>10229637</Loan>
<BuyerContact>
</BuyerContact>
<BuyerBrokerContact>
</BuyerBrokerContact>
<SellingContact>
</SellingContact>
<SellingBrokerContact>
</SellingBrokerContact>
<TitleContact>
</TitleContact>
<Contract>
</Contract>
<SellerLedger>
</SellerLedger>
<BuyerLedger>
</BuyerLedger>
<EscrowCompany>
</EscrowCompany>
<Location>
</Location>
<ProcessTemplate>Closing</ProcessTemplate>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>Demo Servicer</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<ParentLabel>10229637</ParentLabel>
<Grandparent>Property</Grandparent>
<GrandparentID>629</GrandparentID>
<RecordCount>7</RecordCount>
</ClosingItem>
<ClosingItem>
<ClosingID>2</ClosingID>
<Closing>17-NJ48562</Closing>
<PropertyID>608</PropertyID>
<LoanID>618</LoanID>
<BuyerContactID>
</BuyerContactID>
<BuyerBrokerContactID>
</BuyerBrokerContactID>
<SellingContactID>
</SellingContactID>
<SellingBrokerContactID>
</SellingBrokerContactID>
<TitleContactID>
</TitleContactID>
<SaleDate>
</SaleDate>
<SalePrice>
</SalePrice>
<LoanSubmitted>
</LoanSubmitted>
<LoanApproved>
</LoanApproved>
<ContractReceived>
</ContractReceived>
<ProceedsExpected>
</ProceedsExpected>
<ProceedsActual>
</ProceedsActual>
<ProceedsReceived>
</ProceedsReceived>
<ContractID>
</ContractID>
<ClosingEstimated>
</ClosingEstimated>
<ClosingActual>
</ClosingActual>
<SellerLedgerID>
</SellerLedgerID>
<BuyerLedgerID>
</BuyerLedgerID>
<ProcessID>529</ProcessID>
<EscrowType>
</EscrowType>
<EscrowCompanyID>
</EscrowCompanyID>
<LocationID>
</LocationID>
<DaysOnMarket>
</DaysOnMarket>
<Process>17-NJ48562</Process>
<ProcessTemplateID>10</ProcessTemplateID>
<Sibling>Closing</Sibling>
<SiblingID>2</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2017-07-06T00:00:00-07:00</DateOpened>
<OpenedReason>
</OpenedReason>
<DateClosed>
</DateClosed>
<ClosedReason>
</ClosedReason>
<DateDue>
</DateDue>
<CostLedgerID>
</CostLedgerID>
<CurrentDecisionID>
</CurrentDecisionID>
<SourceXml>
</SourceXml>
<MetaXml>
</MetaXml>
<ClientID>1</ClientID>
<ClientPersonID>
</ClientPersonID>
<Object>Loan</Object>
<ObjectID>618</ObjectID>
<Status>Closed</Status>
<CreatedPersonID>42</CreatedPersonID>
<CreatedDate>2017-08-04T09:44:37.053-07:00</CreatedDate>
<UpdatedPersonID>42</UpdatedPersonID>
<UpdatedDate>2017-08-04T09:54:04.567-07:00</UpdatedDate>
<ServicerID>1</ServicerID>
<Servicer>Demo Servicer</Servicer>
<ServicerLoanID>10220595</ServicerLoanID>
<AgencyID>
</AgencyID>
<Agency>
</Agency>
<AgencyLoanID>4005785793</AgencyLoanID>
<ContextIdentifierLoanID>
</ContextIdentifierLoanID>
<InvestorID>131</InvestorID>
<Investor>CTX Mortgage Company LLC</Investor>
<InvestorLoanID>4005785793</InvestorLoanID>
<Address>20 HEATHER DR</Address>
<City>EAST HARTFORD</City>
<State>NJ</State>
<PostalCode>07407-1327</PostalCode>
<Property>20 HEATHER DR</Property>
<Loan>10220595</Loan>
<BuyerContact>
</BuyerContact>
<BuyerBrokerContact>
</BuyerBrokerContact>
<SellingContact>
</SellingContact>
<SellingBrokerContact>
</SellingBrokerContact>
<TitleContact>
</TitleContact>
<Contract>
</Contract>
<SellerLedger>
</SellerLedger>
<BuyerLedger>
</BuyerLedger>
<EscrowCompany>
</EscrowCompany>
<Location>
</Location>
<ProcessTemplate>Closing</ProcessTemplate>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>Demo Servicer</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<ParentLabel>10220595</ParentLabel>
<Grandparent>Property</Grandparent>
<GrandparentID>608</GrandparentID>
<RecordCount>7</RecordCount>
</ClosingItem>
</ClosingCollection>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:
Closing.ashx/ListWhere?ClosingID=1,2,3 - Response:
<ClosingCollection>
<ClosingItem>
<ClosingID>2</ClosingID>
<Closing>17-NJ48562</Closing>
</ClosingItem>
<ClosingItem>
<ClosingID>1</ClosingID>
<Closing>17-OH776443</Closing>
</ClosingItem>
<ClosingItem>
<ClosingID>3</ClosingID>
<Closing>17-VT9865454.A</Closing>
</ClosingItem>
</ClosingCollection>