Contact Class - quandis/qbo3-Documentation GitHub Wiki

Contact

...Contact/Contact.ashx/

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

Contact properties

Column Type Required Description
Active string
ActiveStatus string
Address string Street address of contact. This may contain carriage returns, holding multiple address lines.
Batch integer
BirthDate dateTime Date of Birth of the contact.
CanDelete string
CanInsert string
CanUpdate string
City string City component of the contact's address.
Company string Name of company associated with the Contact.
Contact string yes Label for the table; e.g. LastName, FirstName.
ContactID integer yes Identity column and primary key for the table.
ContactTemplateID integer Foreign key to Contact Template. Contact Templates are power-user defined. E.g. 'Primary Borrower', 'Cosigner', etc.
ContactType string Enumerated values; set by power user in ObjectType table.
Country string Country code of contact's address; e.g. US, CA, MX.
CreatedDate dateTime
CreatedPersonID integer
DeathDate dateTime Date of death of a contact.
Email string
Entity string
EntityParent string
Extranet string
FinalStatus string
FirstName string Given name of contact.
Form string
InDecisionID string
InImportFileID string
LastName string Surname of contact.
Latitude double Geocoded latitude. This is calcualted by a mapping provider plug-in by calling Contact/Normalize.
LinkedFrom string
LinkedTo string
Longitude double Geocoded longitude. This is calcualted by a mapping provider plug-in by calling Contact/Normalize.
MiddleName string Middle name of contact.
Nationality string Nationality of a contact.
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
ParentContactID integer Parent contact; an alias of a contact would have Alias.ParentContactID = MainContact.ContactID.
Phone string
PostalCode string Postal (zip) code of contact's address.
Prefix string Name prefix: Mr., Mrs., Ms., Miss., Hon., Dr., etc. This is enumerated in the ObjectType table.
SCRASource string Source of SCRA information.
SCRAStatus string Military active duty status. This is typically calculated by invoke Contact/SCRA.
SCRAStatusAsOf dateTime Date the SCRA status was determined.
Sequence integer Used to locate Contact by Sequence in conjunction with Object/ObjectID
SpokenLanguage string Primary language spoken by the contact.
State string State (or Province) component of contact's address.
Status string
Suffix string Family suffix; e.g. Jr., III, etc. This is enumerated in the ObjectType table.
Tag string
Tags string
TIN string Tax ID number of a corporate entity.
TIN4 string Last for digits of a TIN.
Title string Job title of the contact.
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
USSSN string Contact social security number. This field is masked with standard SQL statements.
USSSN4 string Calculated last 4 digits of a USSSN.
ValidEnd dateTime End date of a valid contact. This is used for defining temporary addresses.
ValidStart dateTime Start date of a valid contact. This is used for defining temporary addresses.
VerifiedConfidence integer Third party confidence associated with the quality of the contact address.
VerifiedDate dateTime Date the contact was verified (typically from a third party).
VerifiedSource string Source of data for the contact. This is typically used when the contact record is created from a third party skip tracing data source.
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
Attachments Attachment Child
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
ContactTemplate qbo.Contact.ContactTemplateObject Foreign Key
Decisions Decision Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
Methods ContactMethod Child
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

GeocodeXml

Summary

Geocodes an address. This will iterate through specified mapping providers until an address with meeting the minimum confidenceThreshold is found. By default, the Address parameter (which should be a street address) will be parsed to remove Unit/Apartment info, and that will be passed to the IMapping providers. A confidenceThreshold level of 100 is the highest possible, and indicates an exact match on all properties. Any mismatches cause the confidenceThreshold to be decremented by a configurable amount

Input

Address: Street address to geocode.

City: City to geocode.

State: State to geocode.

PostalCode: Postal code to geocode.

Output : [DbXmlReaderMethod]

A list of contacts matching each returned geocoded address.

Contact/Contact.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 Contact.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: Contact.ashx/Search?Contact=ABC123
  • Response:
<ContactCollection>
  <ContactItem>
    <ContactID>14102</ContactID>
    <Contact>, </Contact>
    <ParentContactID>
    </ParentContactID>
    <ContactType>
    </ContactType>
    <Company>
    </Company>
    <Title>
                  </Title>
    <Prefix>
    </Prefix>
    <FirstName>
    </FirstName>
    <MiddleName>
    </MiddleName>
    <LastName>
    </LastName>
    <Suffix>
    </Suffix>
    <Address>
                  </Address>
    <City>
    </City>
    <State>
    </State>
    <PostalCode>
    </PostalCode>
    <Country>
    </Country>
    <USSSN>
    </USSSN>
    <USSSN4>
    </USSSN4>
    <BirthDate>
    </BirthDate>
    <DeathDate>
    </DeathDate>
    <Nationality>
    </Nationality>
    <SpokenLanguage>
    </SpokenLanguage>
    <ValidStart>
    </ValidStart>
    <ValidEnd>
    </ValidEnd>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <ContactTemplateID>
    </ContactTemplateID>
    <TIN>
    </TIN>
    <TIN4>
    </TIN4>
    <VerifiedSource>
    </VerifiedSource>
    <VerifiedDate>
    </VerifiedDate>
    <VerifiedConfidence>
    </VerifiedConfidence>
    <SCRAStatus>
    </SCRAStatus>
    <SCRASource>
    </SCRASource>
    <SCRAStatusAsOf>
    </SCRAStatusAsOf>
    <Sequence>
    </Sequence>
    <Object>Loan</Object>
    <ObjectID>1414515</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>17</CreatedPersonID>
    <CreatedDate>2016-07-12T10:23:11.67-07:00</CreatedDate>
    <UpdatedPersonID>17</UpdatedPersonID>
    <UpdatedDate>2016-07-12T10:23:11.67-07:00</UpdatedDate>
    <ParentContact>
    </ParentContact>
    <ContactTemplate>
    </ContactTemplate>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <Phone>
    </Phone>
    <Email>
    </Email>
    <RecordCount>500</RecordCount>
  </ContactItem>
  <ContactItem>
    <ContactID>14104</ContactID>
    <Contact>, </Contact>
    <ParentContactID>
    </ParentContactID>
    <ContactType>
    </ContactType>
    <Company>
    </Company>
    <Title>
                  </Title>
    <Prefix>
    </Prefix>
    <FirstName>
    </FirstName>
    <MiddleName>
    </MiddleName>
    <LastName>
    </LastName>
    <Suffix>
    </Suffix>
    <Address>
                  </Address>
    <City>
    </City>
    <State>
    </State>
    <PostalCode>
    </PostalCode>
    <Country>
    </Country>
    <USSSN>
    </USSSN>
    <USSSN4>
    </USSSN4>
    <BirthDate>
    </BirthDate>
    <DeathDate>
    </DeathDate>
    <Nationality>
    </Nationality>
    <SpokenLanguage>
    </SpokenLanguage>
    <ValidStart>
    </ValidStart>
    <ValidEnd>
    </ValidEnd>
    <Latitude>
    </Latitude>
    <Longitude>
    </Longitude>
    <ContactTemplateID>
    </ContactTemplateID>
    <TIN>
    </TIN>
    <TIN4>
    </TIN4>
    <VerifiedSource>
    </VerifiedSource>
    <VerifiedDate>
    </VerifiedDate>
    <VerifiedConfidence>
    </VerifiedConfidence>
    <SCRAStatus>
    </SCRAStatus>
    <SCRASource>
    </SCRASource>
    <SCRAStatusAsOf>
    </SCRAStatusAsOf>
    <Sequence>
    </Sequence>
    <Object>Loan</Object>
    <ObjectID>1414515</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>17</CreatedPersonID>
    <CreatedDate>2016-07-12T11:20:15.26-07:00</CreatedDate>
    <UpdatedPersonID>17</UpdatedPersonID>
    <UpdatedDate>2016-07-12T11:20:15.26-07:00</UpdatedDate>
    <ParentContact>
    </ParentContact>
    <ContactTemplate>
    </ContactTemplate>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <Phone>
    </Phone>
    <Email>
    </Email>
    <RecordCount>500</RecordCount>
  </ContactItem>
</ContactCollection>

Contact/Contact.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.

Contact/Contact.ashx/Delete?ID={Where.IdList}

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

Contact/Contact.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: Contact.ashx/ListWhere?ContactID=1,2,3
  • Response:
<ContactCollection>
  <ContactItem>
    <ContactID>1</ContactID>
    <Contact>[email protected]</Contact>
  </ContactItem>
  <ContactItem>
    <ContactID>3</ContactID>
    <Contact>Smith, Jenny</Contact>
  </ContactItem>
  <ContactItem>
    <ContactID>2</ContactID>
    <Contact>Smith, Joe</Contact>
  </ContactItem>
</ContactCollection>
⚠️ **GitHub.com Fallback** ⚠️