IBiz QuickBooks objsearch Component : objsearch OCX, objsearch .NET Component, objsearch Class, objsearch Bean, objsearch Object

Available in: QUICKBOOKS

ObjSearch Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

ObjSearch is used to search the QuickBooks database.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

ObjSearch is used to search the QuickBooks database. When ObjSearch is called a QuickBooks search is initiated using the specified search filters.

Example (Querying for Invoices)

ObjSearch1.QueryType = 4 'qtInvoiceSearch ObjSearch1.TransactionDateStart = "10/01/2002" ObjSearch1.EntityName = "Joe Reckless" ObjSearch1.PaidStatus = 3 'psUnpaid ObjSearch1.Search() Invoice1.QBResponseAggregate = Objsearch1.ResultAggregate(0) Invoice2.QBResponseAggregate = Objsearch1.ResultAggregate(1) ' etc.
ObjSearch may only be used to search for one type of object at a time. The type of search should be specified in QueryType before beginning the search. The maximum number of returned objects may also be specified in MaxResults.

The search may be executed by calling the Search method. After Search is called, ResultCount will hold the number of results, ResultId will hold the Ids returned, and ResultAggregate will hold information for the objects returned. To instantiate an object, set its QBResponseAggregate property to the appropriate ResultAggregate.

One or more search filters may be specified. These filters limit the search to records meeting specified criteria. If no filters are specified, ObjSearch will return all objects in the database, up to the limit specified by MaxResults.

The following filter may be specified in all searches:


ModifiedDate Filter	Limits the search to records last modified before/after specified dates. One or both of ModifiedDateStart and ModifiedDateEnd may be specified.

The following filters may be specified when searching for entities (a CUSTOMER, VENDOR, or EMPLOYEE). The Name filter may also be specified for ITEM searches.


Name Filter	Limits the search based on the name of the entity. One or both of NameRangeStart or NameRangeEnd may be specified to limit the search to a range of names. Alternatively, one of NameStartsWith, NameEndsWith, or NameContains may be specified.
TotalBalance Filter	Limits the search to entities with balances at least TotalBalanceMinimum or at most TotalBalanceMaximum. (Not defined for EMPLOYEE.)

The following filters may be specified when searching for transactions:


RefNumber Filter	Limits the search based on the RefNumber (i.e., check number, invoice number, etc.) of the transaction. One or both of RefNumberRangeStart or RefNumberRangeEnd may be specified to limit the search to a range of RefNumbers. Alternatively, one of RefNumberStartsWith, RefNumberEndsWith, or RefNumberContains may be specified.
TransactionDate Filter	Limits the search to transactions with a date before or after specified dates. One or both of TransactionDateStart and TransactionDateEnd may be specified.
Entity Filter	Limits the search to transactions associated with the entity specified by EntityName.
Account Filter	Limits the search to transactions associated with the account specified by AccountName.

Note that for TIMETRACKING searches the Account and RefNumber filters are not used.

The following additional filter may be specified for BILL and INVOICE objects.


PaidStatus Filter	Limits the search either to paid or unpaid bills or invoices only, as specified in PaidStatus.

The additional filters may be specified for ITEM objects.


Name Filter	Limits the search based on the name of the item. (See above.)
ItemType Filter	Limits the search to the type of item specified by ItemType.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AccountName	An account name to search for in a transaction.
ActiveStatus	Limits the search to active or inactive records only.
EntityName	An entity name to search for in a transaction.
IncludeLineItems	Indicates whether to include line items in the response.
IncludeLinkedTxns	Indicates whether to include linked transactions in the response.
ItemType	The type of item to search for.
MaxResults	The maximum number of results to be returned from a search.
ModifiedDateEnd	Latest modified date to search for.
ModifiedDateStart	Earliest modified date to search for.
NameContains	String which names are to contain.
NameEndsWith	String which names are to end with.
NameRangeEnd	Ending point of a name range.
NameRangeStart	Starting point of a name range.
NameStartsWith	String which names are to start with.
PaidStatus	Limits the search to paid or unpaid transactions only.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBXMLVersion	The version of QBXML used in the outgoing message.
QueryType	The type of search to perform.
RefNumber	Exact RefNumber to search for.
RefNumberContains	String which RefNumbers are to contain.
RefNumberEndsWith	String which RefNumbers are to end with.
RefNumberRangeEnd	Ending point of a RefNumber range.
RefNumberRangeStart	Starting point of a RefNumber range.
RefNumberStartsWith	String which RefNumbers are to start with.
RemainingResults	Indicates the number of results left in an iterative search.
ResultAggregate	An array of XML aggregates returned from the server.
ResultCount	The count of results returned from the server.
ResultId	An array of Ids returned from the server.
SpecialQueryType	The special query type; for example ItemService.
TotalBalanceMaximum	A maximum balance which returned records should have.
TotalBalanceMinimum	A minimum balance which returned records should have.
TransactionDateEnd	Latest transaction date to search for.
TransactionDateStart	Earliest transaction date to search for.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


CheckRequestStatus	Checks whether or not the specified request was processed by QuickBooks.
CloseQBConnection	Closes a persistent connection to QuickBooks.
Config	Sets or retrieves a component configuration setting.
GetNextResults	Retrieves the next set of results. (Only applicable for iterative searches)
OpenQBConnection	Opens a persistent connection to QuickBooks.
Reset	Resets all properties to their defaults.
Search	Submits a query request to QuickBooks.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields
EntityId	An entity Id to search for in a transaction.
FindWithChildren	Include children in the results of an entity Name or Id search.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
IncludeLinkedTxns	Indicates to QuickBooks whether to return transactions linked to this request.
IterateResults	Indicates whether to perform iterative searches when QBXMLVersion = 5.0
QBOELoginURL	The URL for QBOE login.
QBOEPostURL	The URL for posting of QBOE requests.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector