ObjSearch Class

Properties   Methods   Events   Config Settings   Errors  

ObjSearch is used to search the QuickBooks database.

Syntax

ObjSearch

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 = qtInvoiceSearch ObjSearch1.TransactionDateStart = "10/01/2002" ObjSearch1.EntityName = "Joe Reckless" ObjSearch1.PaidStatus = 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 Aggregate will hold information for the objects returned. To instantiate an object, set its QBResponseAggregate property to the appropriate Aggregate.

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:

The following additional filter may be specified for Bill and Invoice objects.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

IncludeLineItems Property (ObjSearch Class)

Indicates whether to include line items in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeLineItems();
int SetIncludeLineItems(int bIncludeLineItems);

Unicode (Windows)
BOOL GetIncludeLineItems();
INT SetIncludeLineItems(BOOL bIncludeLineItems);

int inqb_objsearch_getincludelineitems(void* lpObj);
int inqb_objsearch_setincludelineitems(void* lpObj, int bIncludeLineItems);

bool GetIncludeLineItems();
int SetIncludeLineItems(bool bIncludeLineItems);

Default Value

TRUE

Remarks

This filter allows you to omit line items from a query response to get a smaller result. The default value is true, so line items are returned by default. Set IncludeLineItems to false to exclude line items in the response if you don't need to read line item data.

Data Type

Boolean

IncludeLinkedTxns Property (ObjSearch Class)

Indicates whether to include linked transactions in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeLinkedTxns();
int SetIncludeLinkedTxns(int bIncludeLinkedTxns);

Unicode (Windows)
BOOL GetIncludeLinkedTxns();
INT SetIncludeLinkedTxns(BOOL bIncludeLinkedTxns);

int inqb_objsearch_getincludelinkedtxns(void* lpObj);
int inqb_objsearch_setincludelinkedtxns(void* lpObj, int bIncludeLinkedTxns);

bool GetIncludeLinkedTxns();
int SetIncludeLinkedTxns(bool bIncludeLinkedTxns);

Default Value

FALSE

Remarks

If you set IncludeLinkedTxns to true, then the returned object will include a list of all the transactions linked to the queried object (this list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items). Each linked transaction will be represented by a LinkedTxn aggregate, which will be part of the Aggregate. Passing this aggregate to the corresponding class will parse the linked transactions into their respective properties.

Data Type

Boolean

IterateResults Property (ObjSearch Class)

Indicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIterateResults();
int SetIterateResults(int bIterateResults);

Unicode (Windows)
BOOL GetIterateResults();
INT SetIterateResults(BOOL bIterateResults);

int inqb_objsearch_getiterateresults(void* lpObj);
int inqb_objsearch_setiterateresults(void* lpObj, int bIterateResults);

bool GetIterateResults();
int SetIterateResults(bool bIterateResults);

Default Value

TRUE

Remarks

This property allows the user to enable or disable iterative searching (Query Iterators) when QBXMLVersion is 5.0 or greater. Please see GetNextResults for more info.

Data Type

Boolean

MaxResults Property (ObjSearch Class)

The maximum number of results to be returned from a search.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxResults();
int SetMaxResults(int iMaxResults);

Unicode (Windows)
INT GetMaxResults();
INT SetMaxResults(INT iMaxResults);

int inqb_objsearch_getmaxresults(void* lpObj);
int inqb_objsearch_setmaxresults(void* lpObj, int iMaxResults);

int GetMaxResults();
int SetMaxResults(int iMaxResults);

Default Value

0

Remarks

The maximum number of records to return from QuickBooks.

If MaxResults is set to 0, all records matching the search criteria will be returned.

Data Type

Integer

QBConnectionString Property (ObjSearch Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString);

Unicode (Windows)
LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);

char* inqb_objsearch_getqbconnectionstring(void* lpObj);
int inqb_objsearch_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);

QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

Data Type

String

QBRequestAggregate Property (ObjSearch Class)

The request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate);

Unicode (Windows)
LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);

char* inqb_objsearch_getqbrequestaggregate(void* lpObj);
int inqb_objsearch_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);

QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestMode Property (ObjSearch Class)

Defines whether the request is made online or stored offline.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Unicode (Windows)
INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);

RM_ONLINE(0), 
RM_OFFLINE(1)

int inqb_objsearch_getqbrequestmode(void* lpObj);
int inqb_objsearch_setqbrequestmode(void* lpObj, int iQBRequestMode);

int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Default Value

0

Remarks

This property defines the behavior of the class when calling a method. Possible values are:

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (ObjSearch Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate);

Unicode (Windows)
LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);

char* inqb_objsearch_getqbresponseaggregate(void* lpObj);
int inqb_objsearch_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);

QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (ObjSearch Class)

The version of QBXML used in the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion);

Unicode (Windows)
LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);

char* inqb_objsearch_getqbxmlversion(void* lpObj);
int inqb_objsearch_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

This property is not available at design time.

Data Type

String

QueryType Property (ObjSearch Class)

The type of search to perform.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueryType();
int SetQueryType(int iQueryType);

Unicode (Windows)
INT GetQueryType();
INT SetQueryType(INT iQueryType);

QT_NONE(0), 
QT_VENDOR_SEARCH(1), 
QT_EMPLOYEE_SEARCH(2), 
QT_BILL_SEARCH(3), 
QT_INVOICE_SEARCH(4), 
QT_CREDIT_MEMO_SEARCH(5), 
QT_VENDOR_CREDIT_SEARCH(6), 
QT_SALES_RECEIPT_SEARCH(7), 
QT_PURCHASE_ORDER_SEARCH(8), 
QT_CHECK_SEARCH(9), 
QT_CCCREDIT_SEARCH(10), 
QT_CCCHARGE_SEARCH(11), 
QT_CUSTOMER_SEARCH(12), 
QT_ESTIMATE_SEARCH(13), 
QT_SALES_ORDER_SEARCH(14), 
QT_TIME_TRACKING_SEARCH(15), 
QT_RECEIVE_PAYMENT_SEARCH(16), 
QT_JOURNAL_ENTRY_SEARCH(17), 
QT_ITEM_SEARCH(18), 
QT_ACCOUNT_SEARCH(19), 
QT_DEPOSIT_SEARCH(20), 
QT_INVENTORY_ADJUSTMENT_SEARCH(21), 
QT_PRICE_LEVEL_SEARCH(22), 
QT_CLASS(23), 
QT_CUSTOMER_TYPE(24), 
QT_JOB_TYPE(25), 
QT_PAYMENT_METHOD(26), 
QT_PAYROLL_ITEM_WAGE(27), 
QT_SALES_TAX_CODE(28), 
QT_SHIP_METHOD(29), 
QT_SALES_REP(30), 
QT_VENDOR_TYPE(31), 
QT_BILL_TO_PAY_QUERY(32), 
QT_ITEM_ASSEMBLIES_CAN_BUILD_QUERY(33), 
QT_LIST_DELETED_QUERY(34), 
QT_PREFERENCES_QUERY(35), 
QT_RECEIVE_PAYMENT_TO_DEPOSIT_QUERY(36), 
QT_SALES_TAX_PAYMENT_CHECK_QUERY(37), 
QT_TXN_DELETED_QUERY(38), 
QT_ITEM_RECEIPT_QUERY(39), 
QT_BILL_PAYMENT_CHECK_QUERY(40), 
QT_BILL_PAYMENT_CHARGE_QUERY(41), 
QT_STATEMENT_CHARGE_QUERY(42), 
QT_MILEAGE_QUERY(43), 
QT_OTHER_TRANSACTION_SEARCH(100), 
QT_OTHER_LIST_SEARCH(101)

int inqb_objsearch_getquerytype(void* lpObj);
int inqb_objsearch_setquerytype(void* lpObj, int iQueryType);

int GetQueryType();
int SetQueryType(int iQueryType);

Default Value

0

Remarks

The type of search to perform.

The following values are permitted:

This property is required.

Data Type

Integer

RemainingResults Property (ObjSearch Class)

Indicates the number of results left in an iterative search.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemainingResults();

Unicode (Windows)
INT GetRemainingResults();

int inqb_objsearch_getremainingresults(void* lpObj);

int GetRemainingResults();

Default Value

0

Remarks

A new feature in QuickBooks 2006 allows you to search iteratively. What this basically means is that you can search a customer or transaction list for all transactions, but receive them in chunks of 50 or 100 at a time, instead of one large response potentially containing thousands of entries. This greatly improves response time and also assures that your application does not appear to hang while QuickBooks is putting together the response.

To accomplish such a search, you must set QBXMLVersion to 5.0 or higher. MaxResults will indicates the size of the chunks returned (if set to 0 an iterative search will not be performed). RemainingResults will indicate the number of results remaining. You must also must open and maintain a persistent connection, as searches cannot be continued across sessions. For example:

class.QueryType = qtCustomerSearch() class.MaxResults = 10 class.QBXMLVersion = "5.0" class.OpenQBConnection() class.Search() ' Process first set of results here While (class.RemainingResults > 0) class.GetNextResults() ' Process results here Wend class.CloseQBConnection()

Note that if you wish searches to operate the same way as they did with previous QBXMLVersions, you may set the IterateResults configuration setting to "False". See Config for more information.

This property is read-only.

Data Type

Integer

Results Property (ObjSearch Class)

Contains a collection of search results.

Syntax

• C++
• C
• Qt

InQBList<InQBObjSearchResult>* GetResults();

int inqb_objsearch_getresultcount(void* lpObj);

char* inqb_objsearch_getresultaggregate(void* lpObj, int resultindex);

char* inqb_objsearch_getresultid(void* lpObj, int resultindex);

char* inqb_objsearch_getresultname(void* lpObj, int resultindex);

int GetResultCount();

QString GetResultAggregate(int iResultIndex);

QString GetResultId(int iResultIndex);

QString GetResultName(int iResultIndex);

Remarks

The results of a search will be contained in this property. The Aggregate field contains the XML aggregate of a single search result, and may be passed to the QBResultAggregate property of the class associated with the QueryType of the result.

This property is read-only.

Data Type

InQBObjSearchResult

RetrieveNamesOnly Property (ObjSearch Class)

Return only the names and Ids in the results.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRetrieveNamesOnly();
int SetRetrieveNamesOnly(int bRetrieveNamesOnly);

Unicode (Windows)
BOOL GetRetrieveNamesOnly();
INT SetRetrieveNamesOnly(BOOL bRetrieveNamesOnly);

int inqb_objsearch_getretrievenamesonly(void* lpObj);
int inqb_objsearch_setretrievenamesonly(void* lpObj, int bRetrieveNamesOnly);

bool GetRetrieveNamesOnly();
int SetRetrieveNamesOnly(bool bRetrieveNamesOnly);

Default Value

FALSE

Remarks

If RetrieveNamesOnly is True, entity searches (Customer, Employee, etc) will return only the FullName and ListID for each result. The class will silently ignore this property if it is not applicable to the search being performed. This property requires a QBXMLVersion of "4.0" or greater, and is set to False by default.

Data Type

Boolean

SearchCriteria Property (ObjSearch Class)

Criteria used to limit a search to specific set of transactions.

Syntax

• C++
• C
• Qt

InQBSearchCriteria* GetSearchCriteria();
int SetSearchCriteria(InQBSearchCriteria* val);

char* inqb_objsearch_getaccountid(void* lpObj);
int inqb_objsearch_setaccountid(void* lpObj, const char* lpszAccountId);

char* inqb_objsearch_getaccountname(void* lpObj);
int inqb_objsearch_setaccountname(void* lpObj, const char* lpszAccountName);

int inqb_objsearch_getaccounttype(void* lpObj);
int inqb_objsearch_setaccounttype(void* lpObj, int iAccountType);

int inqb_objsearch_getactivestatus(void* lpObj);
int inqb_objsearch_setactivestatus(void* lpObj, int iActiveStatus);

char* inqb_objsearch_getentityid(void* lpObj);
int inqb_objsearch_setentityid(void* lpObj, const char* lpszEntityId);

char* inqb_objsearch_getentityname(void* lpObj);
int inqb_objsearch_setentityname(void* lpObj, const char* lpszEntityName);

int inqb_objsearch_getitemtype(void* lpObj);
int inqb_objsearch_setitemtype(void* lpObj, int iItemType);

char* inqb_objsearch_getmodifieddateend(void* lpObj);
int inqb_objsearch_setmodifieddateend(void* lpObj, const char* lpszModifiedDateEnd);

char* inqb_objsearch_getmodifieddatestart(void* lpObj);
int inqb_objsearch_setmodifieddatestart(void* lpObj, const char* lpszModifiedDateStart);

char* inqb_objsearch_getnamecontains(void* lpObj);
int inqb_objsearch_setnamecontains(void* lpObj, const char* lpszNameContains);

char* inqb_objsearch_getnameendswith(void* lpObj);
int inqb_objsearch_setnameendswith(void* lpObj, const char* lpszNameEndsWith);

char* inqb_objsearch_getnamerangeend(void* lpObj);
int inqb_objsearch_setnamerangeend(void* lpObj, const char* lpszNameRangeEnd);

char* inqb_objsearch_getnamerangestart(void* lpObj);
int inqb_objsearch_setnamerangestart(void* lpObj, const char* lpszNameRangeStart);

char* inqb_objsearch_getnamestartswith(void* lpObj);
int inqb_objsearch_setnamestartswith(void* lpObj, const char* lpszNameStartsWith);

int inqb_objsearch_getpaidstatus(void* lpObj);
int inqb_objsearch_setpaidstatus(void* lpObj, int iPaidStatus);

char* inqb_objsearch_getrefnumber(void* lpObj);
int inqb_objsearch_setrefnumber(void* lpObj, const char* lpszRefNumber);

char* inqb_objsearch_getrefnumbercontains(void* lpObj);
int inqb_objsearch_setrefnumbercontains(void* lpObj, const char* lpszRefNumberContains);

char* inqb_objsearch_getrefnumberendswith(void* lpObj);
int inqb_objsearch_setrefnumberendswith(void* lpObj, const char* lpszRefNumberEndsWith);

char* inqb_objsearch_getrefnumberrangeend(void* lpObj);
int inqb_objsearch_setrefnumberrangeend(void* lpObj, const char* lpszRefNumberRangeEnd);

char* inqb_objsearch_getrefnumberrangestart(void* lpObj);
int inqb_objsearch_setrefnumberrangestart(void* lpObj, const char* lpszRefNumberRangeStart);

char* inqb_objsearch_getrefnumberstartswith(void* lpObj);
int inqb_objsearch_setrefnumberstartswith(void* lpObj, const char* lpszRefNumberStartsWith);

char* inqb_objsearch_gettotalbalancemaximum(void* lpObj);
int inqb_objsearch_settotalbalancemaximum(void* lpObj, const char* lpszTotalBalanceMaximum);

char* inqb_objsearch_gettotalbalanceminimum(void* lpObj);
int inqb_objsearch_settotalbalanceminimum(void* lpObj, const char* lpszTotalBalanceMinimum);

char* inqb_objsearch_gettransactiondateend(void* lpObj);
int inqb_objsearch_settransactiondateend(void* lpObj, const char* lpszTransactionDateEnd);

char* inqb_objsearch_gettransactiondatestart(void* lpObj);
int inqb_objsearch_settransactiondatestart(void* lpObj, const char* lpszTransactionDateStart);

QString GetAccountId();
int SetAccountId(QString qsAccountId);

QString GetAccountName();
int SetAccountName(QString qsAccountName);

int GetAccountType();
int SetAccountType(int iAccountType);

int GetActiveStatus();
int SetActiveStatus(int iActiveStatus);

QString GetEntityId();
int SetEntityId(QString qsEntityId);

QString GetEntityName();
int SetEntityName(QString qsEntityName);

int GetItemType();
int SetItemType(int iItemType);

QString GetModifiedDateEnd();
int SetModifiedDateEnd(QString qsModifiedDateEnd);

QString GetModifiedDateStart();
int SetModifiedDateStart(QString qsModifiedDateStart);

QString GetNameContains();
int SetNameContains(QString qsNameContains);

QString GetNameEndsWith();
int SetNameEndsWith(QString qsNameEndsWith);

QString GetNameRangeEnd();
int SetNameRangeEnd(QString qsNameRangeEnd);

QString GetNameRangeStart();
int SetNameRangeStart(QString qsNameRangeStart);

QString GetNameStartsWith();
int SetNameStartsWith(QString qsNameStartsWith);

int GetPaidStatus();
int SetPaidStatus(int iPaidStatus);

QString GetRefNumber();
int SetRefNumber(QString qsRefNumber);

QString GetRefNumberContains();
int SetRefNumberContains(QString qsRefNumberContains);

QString GetRefNumberEndsWith();
int SetRefNumberEndsWith(QString qsRefNumberEndsWith);

QString GetRefNumberRangeEnd();
int SetRefNumberRangeEnd(QString qsRefNumberRangeEnd);

QString GetRefNumberRangeStart();
int SetRefNumberRangeStart(QString qsRefNumberRangeStart);

QString GetRefNumberStartsWith();
int SetRefNumberStartsWith(QString qsRefNumberStartsWith);

QString GetTotalBalanceMaximum();
int SetTotalBalanceMaximum(QString qsTotalBalanceMaximum);

QString GetTotalBalanceMinimum();
int SetTotalBalanceMinimum(QString qsTotalBalanceMinimum);

QString GetTransactionDateEnd();
int SetTransactionDateEnd(QString qsTransactionDateEnd);

QString GetTransactionDateStart();
int SetTransactionDateStart(QString qsTransactionDateStart);

Remarks

Any number of fields may be combined in a single search. However, some fields are applicable only to specific QueryTypes.

Data Type

InQBSearchCriteria

SpecialQueryType Property (ObjSearch Class)

The special query type; for example ItemService.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialQueryType();
int SetSpecialQueryType(const char* lpszSpecialQueryType);

Unicode (Windows)
LPWSTR GetSpecialQueryType();
INT SetSpecialQueryType(LPCWSTR lpszSpecialQueryType);

char* inqb_objsearch_getspecialquerytype(void* lpObj);
int inqb_objsearch_setspecialquerytype(void* lpObj, const char* lpszSpecialQueryType);

QString GetSpecialQueryType();
int SetSpecialQueryType(QString qsSpecialQueryType);

Default Value

""

Remarks

This property may be used to query QuickBooks for items supported by the QuickBooks SDK, but not by the component set.

The property should be set to the name of the object being queried for. A list of the objects supported for query operations by the SDK may be found in the SDK documentation.

When performing a special query the QueryType property should be set to qtOtherTransactionSearch or qtOtherListSearch, as appropriate. After searching, the QBObject class may be used to view and/or edit the results.

It is recommended that users using this property first read the SDK documentation.

Data Type

String

CloseQBConnection Method (ObjSearch Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_objsearch_closeqbconnection(void* lpObj);

int CloseQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (ObjSearch Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_objsearch_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetNextResults Method (ObjSearch Class)

Retrieves the next set of results (only applicable for iterative searches).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNextResults();

Unicode (Windows)
INT GetNextResults();

int inqb_objsearch_getnextresults(void* lpObj);

int GetNextResults();

Remarks

A new feature in QuickBooks 2006 allows you to search iteratively. What this basically means is that you can search a customer or transaction list for all transactions, but receive them in chunks of 50 or 100 at a time, instead of one large response potentially containing thousands of entries. This greatly improves response time and also assures that your application does not appear to hang while QuickBooks is putting together the response.

To accomplish such a search, you must set QBXMLVersion to 5.0 or higher. MaxResults will indicates the size of the chunks returned (if set to 0 an iterative search will not be performed). RemainingResults will indicate the number of results remaining. You must also must open and maintain a persistent connection, as searches cannot be continued across sessions. For example:

class.QueryType = qtCustomerSearch class.MaxResults = 10 class.QBXMLVersion = "5.0" class.OpenQBConnection() class.Search() ' Process first set of results here While (class.RemainingResults > 0) class.GetNextResults() ' Process additional results here Wend class.CloseQBConnection()

Note that if you wish searches to operate the same way as they did with previous QBXMLVersions, you may set the IterateResults configuration setting to "False". See Config for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportQBXML Method (ObjSearch Class)

Imports a QBXML response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportQBXML(const char* lpszXMLData);

Unicode (Windows)
INT ImportQBXML(LPCWSTR lpszXMLData);

int inqb_objsearch_importqbxml(void* lpObj, const char* lpszXMLData);

int ImportQBXML(const QString& qsXMLData);

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OpenQBConnection Method (ObjSearch Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_objsearch_openqbconnection(void* lpObj);

int OpenQBConnection();

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (ObjSearch Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_objsearch_reset(void* lpObj);

int Reset();

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Search Method (ObjSearch Class)

Submits a query request to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Search();

Unicode (Windows)
INT Search();

int inqb_objsearch_search(void* lpObj);

int Search();

Remarks

Submits a query request to QuickBooks, of the type specified in QueryType.

The number of results may be limited by setting the value of MaxResults. The results will also be limited to objects meeting the search criteria specified. If no search filters are specified, all objects of the requested type will be returned.

After the search, ResultCount will contain the number of results, and Aggregate will contain the returned XML aggregates. These may be assigned to the QBResponseAggregate property of the appropriate control to instantiate the objects.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (ObjSearch Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(ObjSearchErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ObjSearchErrorEventParams;


Unicode (Windows)
virtual INT FireError(ObjSearchErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ObjSearchErrorEventParams;

#define EID_OBJSEARCH_ERROR 1

virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class ObjSearchErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ObjSearchErrorEventParams *e);

// Or, subclass ObjSearch and override this emitter function.
virtual int FireError(ObjSearchErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (ObjSearch Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(ObjSearchSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} ObjSearchSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(ObjSearchSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} ObjSearchSSLServerAuthenticationEventParams;

#define EID_OBJSEARCH_SSLSERVERAUTHENTICATION 2

virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class ObjSearchSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(ObjSearchSSLServerAuthenticationEventParams *e);

// Or, subclass ObjSearch and override this emitter function.
virtual int FireSSLServerAuthentication(ObjSearchSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (ObjSearch Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(ObjSearchSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} ObjSearchSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(ObjSearchSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} ObjSearchSSLStatusEventParams;

#define EID_OBJSEARCH_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

class ObjSearchSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(ObjSearchSSLStatusEventParams *e);

// Or, subclass ObjSearch and override this emitter function.
virtual int FireSSLStatus(ObjSearchSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (ObjSearch Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(ObjSearchStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} ObjSearchStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(ObjSearchStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} ObjSearchStatusEventParams;

#define EID_OBJSEARCH_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

class ObjSearchStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(ObjSearchStatusEventParams *e);

// Or, subclass ObjSearch and override this emitter function.
virtual int FireStatus(ObjSearchStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (ObjSearch Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(ObjSearchWarningEventParams *e);

typedef struct {
  int Code;
  const char *Description;
  int reserved;
} ObjSearchWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(ObjSearchWarningEventParams *e);

typedef struct {
  INT Code;
  LPCWSTR Description;
  INT reserved;
} ObjSearchWarningEventParams;

#define EID_OBJSEARCH_WARNING 5

virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);

class ObjSearchWarningEventParams {
public:
  int Code();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Warning(ObjSearchWarningEventParams *e);

// Or, subclass ObjSearch and override this emitter function.
virtual int FireWarning(ObjSearchWarningEventParams *e) {...}

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

ObjSearchResult Type

Results of a search made with the OBJSEARCH component.

Syntax

InQBObjSearchResult (declared in inqb.h)

Remarks

This type contains a single result after issuing a search with the ObjSearch class. The Aggregate field contains the XML result aggregate, which you may then pass to a corresponding class to parse.

• Aggregate
• ResultId
• ResultName

Fields

Constructors

ObjSearchResult()

SearchCriteria Type

Criteria used to limit a search to specific set of transactions.

Syntax

InQBSearchCriteria (declared in inqb.h)

Remarks

This type is used by the ObjSearch class, and describes the transactions the user is looking for.

• AccountId
• AccountName
• AccountType
• ActiveStatus
• EntityId
• EntityName
• ItemType
• ModifiedDateEnd
• ModifiedDateStart
• NameContains
• NameEndsWith
• NameRangeEnd
• NameRangeStart
• NameStartsWith
• PaidStatus
• RefNumber
• RefNumberContains
• RefNumberEndsWith
• RefNumberRangeEnd
• RefNumberRangeStart
• RefNumberStartsWith
• TotalBalanceMaximum
• TotalBalanceMinimum
• TransactionDateEnd
• TransactionDateStart

Fields

Constructors

SearchCriteria()

InQBList Type

Syntax

InQBList<T> (declared in inqb.h)

Remarks

InQBList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the ObjSearch class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (ObjSearch Class)

ObjSearch Config Settings

Base Config Settings

Trappable Errors (ObjSearch Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

ObjSearch Errors