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 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 class with short descriptions. Click on the links for further details.


IncludeLineItems	Indicates whether to include line items in the response.
IncludeLinkedTxns	Indicates whether to include linked transactions in the response.
IterateResults	Indicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater.
MaxResults	The maximum number of results to be returned from a search.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBRequestAggregate	The request aggregate.
QBRequestMode	Defines whether the request is made online or stored offline.
QBResponseAggregate	The last QBXML response aggregate received from QuickBooks.
QBXMLVersion	The version of QBXML used in the outgoing message.
QueryType	The type of search to perform.
RemainingResults	Indicates the number of results left in an iterative search.
ResultCount	The number of records in the Result arrays.
ResultAggregate	XML response aggregate returned from QuickBooks.
ResultId	Id of the result aggregate stored in Aggregate .
ResultName	Name of the result aggregate stored in Aggregate .
RetrieveNamesOnly	Return only the names and Ids in the results.
AccountId	An account name to search for in a transaction.
AccountName	An account name to search for in a transaction.
AccountType	Search by the type of QuickBooks account.
ActiveStatus	Limits the search to active or inactive records only.
EntityId	Limits the search to transactions associated with the entity specified by EntityId .
EntityName	An entity name to search for in a transaction.
ItemType	The type of item to search for.
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.
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.
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.
SpecialQueryType	The special query type; for example ItemService.

Method List

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


CloseQBConnection	Closes a persistent connection to QuickBooks.
Config	Sets or retrieves a configuration setting.
GetNextResults	Retrieves the next set of results (only applicable for iterative searches).
ImportQBXML	Imports a QBXML response aggregate.
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 class with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Config Settings

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


AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CurrencyId	Filters results by indicated currency.
CurrencyName	Filters results by indicated currency.
Date	Searches by exact date.
DeletionType	The type of list or transaction from which a member has been deleted.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
FindWithChildren	Include children in the results of an entity Name or Id search.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
MetaDataType	Controls whether a count of results is returned or not.
ModifiedDateRangeFilterName	The ModifiedDateRangeFilter tag name to be used in the request.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
QBOpenCompanyFile	The file currently open in QuickBooks.
ResultCount	A count of results returned via QuickBooks' metaData attribute.
SSLAcceptServerCert	The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFile	The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TotalBalance	The balance which returned records should have.
TxnDateRangeFilterName	The TxnDateRangeFilter tag name to be used in the request.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
WarningCodes	A comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

IncludeLineItems Property (ObjSearch Class)

Indicates whether to include line items in the response.

Syntax

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

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 ResultAggregate. 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

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

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

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

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:


ApplicationName	The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFile	The name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used. This setting is not applicable when communicating with QB Connector.
URL	The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the class will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the class's request to QuickBooks, and return the response.
User	A username for the Remote Connector connection (if required on the Connector side)
Password	A password for the Remote Connector connection (if required on the Connector side)
Timeout	A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the class will generate an exception instead of hanging.
DelayAfterClose	A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.
FirewallHost	Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
FirewallPassword	Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
FirewallPort	Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.
FirewallType	Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.
FirewallUser	Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
ProxyAuthorization	Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.
ProxyPassword	Contains a password if authentication is to be used for the proxy.
ProxyPort	Contains the TCP port for a ProxyServer; (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.
ProxyServer	If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.
ProxyUser	Contains a user name, if authentication is to be used for the proxy.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the class binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the class will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

Data Type

String

QBRequestAggregate Property (ObjSearch Class)

The request aggregate.

Syntax

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

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

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

Possible Values

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

Remarks

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


0 (rmOnline - default)	The request is made normally.
1 (rmOffline)	The request is generated but not sent, and QBRequestAggregate is populated.

The use of offline mode is required when using the QBWCServer class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

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

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

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:


QuickBooks 2002	1.0, 1.1
QuickBooks 2003	2.0
QuickBooks 2004	3.0
QuickBooks 2005	4.0, 4.1
QuickBooks 2006	5.0
QuickBooks 2007	6.0
QuickBooks 2008	7.0
QuickBooks 2009	8.0
QuickBooks 2010	9.0
QuickBooks 2011	10.0
QuickBooks 2012	11.0
QuickBooks 2013	12.0
QuickBooks 2014	13.0
QuickBooks 2015	14.0
QuickBooks 2016	15.0

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:


QuickBooks Canadian 2003	CA2.0
QuickBooks Canadian 2004 to 2007	CA3.0
QuickBooks UK 2003	UK2.0
QuickBooks UK 2004 to 2007	UK3.0
QuickBooks Australian 2003	OZ2.0
QuickBooks Australian 2004 to 2007	AU3.0

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Data Type

String

QueryType Property (ObjSearch Class)

The type of search to perform.

Syntax

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

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

Possible Values

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

Remarks

The type of search to perform.

The following values are permitted:


qtNone	0
qtVendorSearch	1
qtEmployeeSearch	2
qtBillSearch	3
qtInvoiceSearch	4
qtCreditMemoSearch	5
qtVendorCreditSearch	6
qtSalesReceiptSearch	7
qtPurchaseOrderSearch	8
qtCheckSearch	9
qtCCCreditSearch	10
qtCCChargeSearch	11
qtCustomerSearch	12
qtEstimateSearch	13
qtSalesOrderSearch	14
qtTimeTrackingSearch	15
qtReceivePaymentSearch	16
qtJournalEntrySearch	17
qtItemSearch	18
qtAccountSearch	19
qtDepositSearch	20
qtInventoryAdjustmentSearch	21
qtPriceLevelSearch	22
qtClass	23
qtCustomerType	24
qtJobType	25
qtPaymentMethod	26
qtPayrollItemWage	27
qtSalesTaxCode	28
qtShipMethod	29
qtSalesRep	30
qtVendorType	31
qtBillToPayQuery	32
qtItemAssembliesCanBuildQuery	33
qtListDeletedQuery	34
qtPreferencesQuery	35
qtReceivePaymentToDepositQuery	36
qtSalesTaxPaymentCheckQuery	37
qtTxnDeletedQuery	38
qtItemReceiptQuery	39
qtBillPaymentCheckQuery	40
qtBillPaymentChargeQuery	41
qtOtherTransactionSearch	100
qtOtherListSearch	101

If QueryType is set to qtOtherTransactionSearch or OtherListSearch, SpecialQueryType should be set as well.

This property is required.

Data Type

Integer

RemainingResults Property (ObjSearch Class)

Indicates the number of results left in an iterative search.

Syntax

ANSI (Cross Platform)
int GetRemainingResults();

Unicode (Windows)
INT GetRemainingResults();

int inqb_objsearch_getremainingresults(void* lpObj);

int GetRemainingResults();

Default Value

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

ResultCount Property (ObjSearch Class)

The number of records in the Result arrays.

Syntax

ANSI (Cross Platform)
int GetResultCount();

Unicode (Windows)
INT GetResultCount();

int inqb_objsearch_getresultcount(void* lpObj);

int GetResultCount();

Default Value

Remarks

This property controls the size of the following arrays:

ResultAggregate
ResultId
ResultName

The array indices start at 0 and end at ResultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ResultAggregate Property (ObjSearch Class)

XML response aggregate returned from QuickBooks.

Syntax

ANSI (Cross Platform)
char* GetResultAggregate(int iResultIndex);

Unicode (Windows)
LPWSTR GetResultAggregate(INT iResultIndex);

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

QString GetResultAggregate(int iResultIndex);

Default Value

Remarks

XML response aggregate returned from QuickBooks.

This array property contains all of the XML response aggregates returned from QuickBooks after a successful call to Search.

This property may be used to set the Aggregate property of any other class. If this is done the class will be set to the record specified in ResultAggregate.

The Ids are also provided separately in the ResultId property.

The ResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.

This property is read-only and not available at design time.

Data Type

String

ResultId Property (ObjSearch Class)

Id of the result aggregate stored in Aggregate .

Syntax

ANSI (Cross Platform)
char* GetResultId(int iResultIndex);

Unicode (Windows)
LPWSTR GetResultId(INT iResultIndex);

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

QString GetResultId(int iResultIndex);

Default Value

Remarks

Id of the result aggregate stored in Aggregate.

The ResultIds will automatically be prefixed with a hash, and may be passed as is to the Get method of any class, or used as references.

The corresponding XML response aggregate is provided in the Aggregate property

The ResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.

This property is read-only and not available at design time.

Data Type

String

ResultName Property (ObjSearch Class)

Name of the result aggregate stored in Aggregate .

Syntax

ANSI (Cross Platform)
char* GetResultName(int iResultIndex);

Unicode (Windows)
LPWSTR GetResultName(INT iResultIndex);

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

QString GetResultName(int iResultIndex);

Default Value

Remarks

Name of the result aggregate stored in Aggregate.

The ResultName will only be returned for Entity searches, and may be passed as is to the GetByName method of any class that supports such functionality. (Customer, Account, Item, Vendor, Employee, etc).

The corresponding XML response aggregate is provided in the Aggregate property

The ResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.

This property is read-only and not available at design time.

Data Type

String

RetrieveNamesOnly Property (ObjSearch Class)

Return only the names and Ids in the results.

Syntax

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

AccountId Property (ObjSearch Class)

An account name to search for in a transaction.

Syntax

ANSI (Cross Platform)
char* GetAccountId();
int SetAccountId(const char* lpszAccountId);

Unicode (Windows)
LPWSTR GetAccountId();
INT SetAccountId(LPCWSTR lpszAccountId);

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

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

Default Value

Remarks

An account name to search for in a transaction. Limits the search to transactions associated with the account specified by AccountId.

Only applicable to searches for transaction objects and BillToPay queries.

Data Type

String

AccountName Property (ObjSearch Class)

An account name to search for in a transaction.

Syntax

ANSI (Cross Platform)
char* GetAccountName();
int SetAccountName(const char* lpszAccountName);

Unicode (Windows)
LPWSTR GetAccountName();
INT SetAccountName(LPCWSTR lpszAccountName);

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

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

Default Value

Remarks

An account name to search for in a transaction. Limits the search to transactions associated with the account specified by AccountName. For example, if searching for a CCCredit AccountName would be the full name of a credit card.

Only applicable to searches for transaction objects and BillToPay queries.

Data Type

String

AccountType Property (ObjSearch Class)

Search by the type of QuickBooks account.

Syntax

ANSI (Cross Platform)
int GetAccountType();
int SetAccountType(int iAccountType);

Unicode (Windows)
INT GetAccountType();
INT SetAccountType(INT iAccountType);

Possible Values

AT_UNSPECIFIED(0), 
AT_ACCOUNTS_PAYABLE(1), 
AT_ACCOUNTS_RECEIVABLE(2), 
AT_BANK(3), 
AT_COST_OF_GOODS_SOLD(4), 
AT_CREDIT_CARD(5), 
AT_EQUITY(6), 
AT_EXPENSE(7), 
AT_FIXED_ASSET(8), 
AT_INCOME(9), 
AT_LONG_TERM_LIABILITY(10), 
AT_OTHER_ASSET(11), 
AT_OTHER_CURRENT_ASSET(12), 
AT_OTHER_CURRENT_LIABILITY(13), 
AT_OTHER_EXPENSE(14), 
AT_OTHER_INCOME(15), 
AT_NON_POSTING(16)

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

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

Default Value

Remarks

Search by the type of QuickBooks account.

Only applicable to account queries.

Data Type

Integer

ActiveStatus Property (ObjSearch Class)

Limits the search to active or inactive records only.

Syntax

ANSI (Cross Platform)
int GetActiveStatus();
int SetActiveStatus(int iActiveStatus);

Unicode (Windows)
INT GetActiveStatus();
INT SetActiveStatus(INT iActiveStatus);

Possible Values

AS_UNSPECIFIED(0), 
AS_ACTIVE_ONLY(1), 
AS_INACTIVE_ONLY(2), 
AS_ALL(3)

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

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

Default Value

Remarks

Limits the search to active or inactive records only. May be used to limit the search to active or inactive records only.

The following values are permitted:


asUnspecified	0
asActiveOnly	1
asInactiveOnly	2
asAll	3

Only applicable to searches for entity objects.

Data Type

Integer

EntityId Property (ObjSearch Class)

Limits the search to transactions associated with the entity specified by EntityId .

Syntax

ANSI (Cross Platform)
char* GetEntityId();
int SetEntityId(const char* lpszEntityId);

Unicode (Windows)
LPWSTR GetEntityId();
INT SetEntityId(LPCWSTR lpszEntityId);

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

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

Default Value

Remarks

Limits the search to transactions associated with the entity specified by EntityId. Note that you may use EntityName OR EntityId to search, but you may not use both.

Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityId field, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyId field.

Data Type

String

EntityName Property (ObjSearch Class)

An entity name to search for in a transaction.

Syntax

ANSI (Cross Platform)
char* GetEntityName();
int SetEntityName(const char* lpszEntityName);

Unicode (Windows)
LPWSTR GetEntityName();
INT SetEntityName(LPCWSTR lpszEntityName);

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

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

Default Value

Remarks

An entity name to search for in a transaction. Limits the search to transactions associated with the entity specified by EntityName. For example, if searching for an Invoice EntityName would be the full name of a Customer.

Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityName field, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyName field.

Data Type

String

ItemType Property (ObjSearch Class)

The type of item to search for.

Syntax

ANSI (Cross Platform)
int GetItemType();
int SetItemType(int iItemType);

Unicode (Windows)
INT GetItemType();
INT SetItemType(INT iItemType);

Possible Values

SIT_ALL(0), 
SIT_SERVICE(1), 
SIT_INVENTORY(2), 
SIT_NON_INVENTORY(3), 
SIT_PAYMENT(4), 
SIT_DISCOUNT(5), 
SIT_SALES_TAX(6), 
SIT_SUBTOTAL(7), 
SIT_OTHER_CHARGE(8), 
SIT_INVENTORY_ASSEMBLY(9), 
SIT_GROUP(10), 
SIT_SALES_TAX_GROUP(11), 
SIT_FIXED_ASSET(12), 
SIT_SITES(13)

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

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

Default Value

Remarks

The type of item to search for. Applies only to searches for items. If set to itAll (the default) the class will search for all types of items.

Data Type

Integer

ModifiedDateEnd Property (ObjSearch Class)

Latest modified date to search for.

Syntax

ANSI (Cross Platform)
char* GetModifiedDateEnd();
int SetModifiedDateEnd(const char* lpszModifiedDateEnd);

Unicode (Windows)
LPWSTR GetModifiedDateEnd();
INT SetModifiedDateEnd(LPCWSTR lpszModifiedDateEnd);

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

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

Default Value

Remarks

Latest modified date to search for. Limits the search to records modified on or before this date.

This is also used as the Deleted date range filter for qtListDeletedQuery and qtTxnDeletedQuery query types.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This property may also be set using the DateTime format. This format for specifying date and time is"CCCC-MM-DDThh:mm:ss+hh:mm" or "CCCC-MM-DDThh:mm:ss-hh:mm" where CCCC is the four-digit year, MM is the month, DD is the day, the character T is a separator, hh is the hour, mm is the minute, ss is the second, and hh:mm is the difference between the local time of the client and UTC (Universal Coordinated Time). For example, "2011-01-19T15:43:21-05:00" is January first, 2011 3:43:21 PM, Eastern Standard Time. The timezone differential is optional, if omitted Quickbooks will use the System's time zone.

Data Type

String

ModifiedDateStart Property (ObjSearch Class)

Earliest modified date to search for.

Syntax

ANSI (Cross Platform)
char* GetModifiedDateStart();
int SetModifiedDateStart(const char* lpszModifiedDateStart);

Unicode (Windows)
LPWSTR GetModifiedDateStart();
INT SetModifiedDateStart(LPCWSTR lpszModifiedDateStart);

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

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

Default Value

Remarks

Earliest modified date to search for. Limits the search to records modified on or after this date.

This is also used as the Deleted date range filter for qtListDeletedQuery and qtTxnDeletedQuery query types.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

Data Type

String

NameContains Property (ObjSearch Class)

String which names are to contain.

Syntax

ANSI (Cross Platform)
char* GetNameContains();
int SetNameContains(const char* lpszNameContains);

Unicode (Windows)
LPWSTR GetNameContains();
INT SetNameContains(LPCWSTR lpszNameContains);

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

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

Default Value

Remarks

String which names are to contain. Limits the search to records with names which contain the string NameContains.

If NameContains is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

Data Type

String

NameEndsWith Property (ObjSearch Class)

String which names are to end with.

Syntax

ANSI (Cross Platform)
char* GetNameEndsWith();
int SetNameEndsWith(const char* lpszNameEndsWith);

Unicode (Windows)
LPWSTR GetNameEndsWith();
INT SetNameEndsWith(LPCWSTR lpszNameEndsWith);

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

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

Default Value

Remarks

String which names are to end with. Limits the search to records with names which end with the string specified by NameEndsWith.

If NameEndsWith is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

Data Type

String

NameRangeEnd Property (ObjSearch Class)

Ending point of a name range.

Syntax

ANSI (Cross Platform)
char* GetNameRangeEnd();
int SetNameRangeEnd(const char* lpszNameRangeEnd);

Unicode (Windows)
LPWSTR GetNameRangeEnd();
INT SetNameRangeEnd(LPCWSTR lpszNameRangeEnd);

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

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

Default Value

Remarks

Ending point of a name range. Limits the search to records with names lexicographically lower than or equal to NameRangeEnd.

May be combined with NameRangeStart, but not with NameContains, NameStartsWith, or NameEndsWith.

Only applicable to searches for entity objects.

Data Type

String

NameRangeStart Property (ObjSearch Class)

Starting point of a name range.

Syntax

ANSI (Cross Platform)
char* GetNameRangeStart();
int SetNameRangeStart(const char* lpszNameRangeStart);

Unicode (Windows)
LPWSTR GetNameRangeStart();
INT SetNameRangeStart(LPCWSTR lpszNameRangeStart);

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

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

Default Value

Remarks

Starting point of a name range. Limits the search to records with names lexicographically higher than or equal to NameRangeStart.

May be combined with NameRangeEnd, but not with NameContains, NameStartsWith, or NameEndsWith.

Only applicable to searches for entity objects.

Data Type

String

NameStartsWith Property (ObjSearch Class)

String which names are to start with.

Syntax

ANSI (Cross Platform)
char* GetNameStartsWith();
int SetNameStartsWith(const char* lpszNameStartsWith);

Unicode (Windows)
LPWSTR GetNameStartsWith();
INT SetNameStartsWith(LPCWSTR lpszNameStartsWith);

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

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

Default Value

Remarks

String which names are to start with. Limits the search to records with names which start with the string specified by NameStartsWith.

If NameStartsWith is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

Data Type

String

PaidStatus Property (ObjSearch Class)

Limits the search to paid or unpaid transactions only.

Syntax

ANSI (Cross Platform)
int GetPaidStatus();
int SetPaidStatus(int iPaidStatus);

Unicode (Windows)
INT GetPaidStatus();
INT SetPaidStatus(INT iPaidStatus);

Possible Values

PS_UNSPECIFIED(0), 
PS_ALL(1), 
PS_PAID(2), 
PS_UNPAID(3)

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

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

Default Value

Remarks

Limits the search to paid or unpaid transactions only. May be used to limit the search to paid or unpaid records only.

The following values are permitted:


psUnspecified	0
psAll	1
psPaid	2
psUnpaid	3

Only applicable to searches for Bill or Invoice transaction objects.

Data Type

Integer

RefNumber Property (ObjSearch Class)

Exact RefNumber to search for.

Syntax

ANSI (Cross Platform)
char* GetRefNumber();
int SetRefNumber(const char* lpszRefNumber);

Unicode (Windows)
LPWSTR GetRefNumber();
INT SetRefNumber(LPCWSTR lpszRefNumber);

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

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

Default Value

Remarks

Exact RefNumber to search for. Limits the search to records with RefNumbers identical to RefNumber.

If RefNumber is specified, no other search criteria will be sent in the query. If you wish to narrow your results based on the RefNumber and other criteria such as ModifiedDateStart or EntityName, you will need to use the RefNumberContains, RefNumberStartsWith, RefNumberEndsWith, RefNumberRangeStart, or RefNumberRangeEnd properties.

Only applicable to searches for transaction objects.

Data Type

String

RefNumberContains Property (ObjSearch Class)

String which RefNumbers are to contain.

Syntax

ANSI (Cross Platform)
char* GetRefNumberContains();
int SetRefNumberContains(const char* lpszRefNumberContains);

Unicode (Windows)
LPWSTR GetRefNumberContains();
INT SetRefNumberContains(LPCWSTR lpszRefNumberContains);

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

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

Default Value

Remarks

String which RefNumbers are to contain. Limits the search to records with RefNumbers which contain the string RefNumberContains.

If RefNumberContains is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

Data Type

String

RefNumberEndsWith Property (ObjSearch Class)

String which RefNumbers are to end with.

Syntax

ANSI (Cross Platform)
char* GetRefNumberEndsWith();
int SetRefNumberEndsWith(const char* lpszRefNumberEndsWith);

Unicode (Windows)
LPWSTR GetRefNumberEndsWith();
INT SetRefNumberEndsWith(LPCWSTR lpszRefNumberEndsWith);

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

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

Default Value

Remarks

String which RefNumbers are to end with. Limits the search to records with RefNumbers which end with the string specified by RefNumberEndsWith.

If RefNumberEndsWith is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

Data Type

String

RefNumberRangeEnd Property (ObjSearch Class)

Ending point of a RefNumber range.

Syntax

ANSI (Cross Platform)
char* GetRefNumberRangeEnd();
int SetRefNumberRangeEnd(const char* lpszRefNumberRangeEnd);

Unicode (Windows)
LPWSTR GetRefNumberRangeEnd();
INT SetRefNumberRangeEnd(LPCWSTR lpszRefNumberRangeEnd);

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

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

Default Value

Remarks

Ending point of a RefNumber range. Limits the search to records with RefNumbers lexicographically lower than or equal to RefNumberRangeEnd.

May be combined with RefNumberRangeStart, but not with RefNumberContains, RefNumberStartsWith, or RefNumberEndsWith.

Only applicable to searches for transaction objects.

Data Type

String

RefNumberRangeStart Property (ObjSearch Class)

Starting point of a RefNumber range.

Syntax

ANSI (Cross Platform)
char* GetRefNumberRangeStart();
int SetRefNumberRangeStart(const char* lpszRefNumberRangeStart);

Unicode (Windows)
LPWSTR GetRefNumberRangeStart();
INT SetRefNumberRangeStart(LPCWSTR lpszRefNumberRangeStart);

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

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

Default Value

Remarks

Starting point of a RefNumber range. Limits the search to records with RefNumbers lexicographically higher than or equal to RefNumberRangeStart.

May be combined with RefNumberRangeEnd, but not with RefNumberContains, RefNumberStartsWith, or RefNumberEndsWith.

Only applicable to searches for transaction objects.

Data Type

String

RefNumberStartsWith Property (ObjSearch Class)

String which RefNumbers are to start with.

Syntax

ANSI (Cross Platform)
char* GetRefNumberStartsWith();
int SetRefNumberStartsWith(const char* lpszRefNumberStartsWith);

Unicode (Windows)
LPWSTR GetRefNumberStartsWith();
INT SetRefNumberStartsWith(LPCWSTR lpszRefNumberStartsWith);

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

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

Default Value

Remarks

String which RefNumbers are to start with. Limits the search to records with RefNumbers which start with the string specified by RefNumberStartsWith.

If RefNumberStartsWith is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

Data Type

String

TotalBalanceMaximum Property (ObjSearch Class)

A maximum balance which returned records should have.

Syntax

ANSI (Cross Platform)
char* GetTotalBalanceMaximum();
int SetTotalBalanceMaximum(const char* lpszTotalBalanceMaximum);

Unicode (Windows)
LPWSTR GetTotalBalanceMaximum();
INT SetTotalBalanceMaximum(LPCWSTR lpszTotalBalanceMaximum);

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

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

Default Value

Remarks

A maximum balance which returned records should have. Limits the search to records with balances less than or equal to TotalBalanceMaximum.

If TotalBalanceMaximum is specified TotalBalanceMinimum may not be (this limitation is imposed by the QBXML interface).

The amount should be formatted as a string in dollars.

Only applicable to searches for entity objects.

Data Type

String

TotalBalanceMinimum Property (ObjSearch Class)

A minimum balance which returned records should have.

Syntax

ANSI (Cross Platform)
char* GetTotalBalanceMinimum();
int SetTotalBalanceMinimum(const char* lpszTotalBalanceMinimum);

Unicode (Windows)
LPWSTR GetTotalBalanceMinimum();
INT SetTotalBalanceMinimum(LPCWSTR lpszTotalBalanceMinimum);

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

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

Default Value

Remarks

A minimum balance which returned records should have. Limits the search to records with balances greater than or equal to TotalBalanceMinimum.

If TotalBalanceMinimum is specified TotalBalanceMaximum may not be (this limitation is imposed by the QBXML interface).

The amount should be formatted as a string in dollars.

Only applicable to searches for entity objects.

Data Type

String

TransactionDateEnd Property (ObjSearch Class)

Latest transaction date to search for.

Syntax

ANSI (Cross Platform)
char* GetTransactionDateEnd();
int SetTransactionDateEnd(const char* lpszTransactionDateEnd);

Unicode (Windows)
LPWSTR GetTransactionDateEnd();
INT SetTransactionDateEnd(LPCWSTR lpszTransactionDateEnd);

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

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

Default Value

Remarks

Latest transaction date to search for. Limits the search to transactions with a date on or before TransactionDateEnd.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

Only applicable to searches for transaction objects.

Data Type

String

TransactionDateStart Property (ObjSearch Class)

Earliest transaction date to search for.

Syntax

ANSI (Cross Platform)
char* GetTransactionDateStart();
int SetTransactionDateStart(const char* lpszTransactionDateStart);

Unicode (Windows)
LPWSTR GetTransactionDateStart();
INT SetTransactionDateStart(LPCWSTR lpszTransactionDateStart);

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

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

Default Value

Remarks

Earliest transaction date to search for. Limits the search to transactions with a date on or after TransactionDateStart.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

Only applicable to searches for transaction objects.

Data Type

String

SpecialQueryType Property (ObjSearch Class)

The special query type; for example ItemService.

Syntax

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

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

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

ANSI (Cross Platform)
int GetNextResults();

Unicode (Windows)
INT GetNextResults();

int inqb_objsearch_getnextresults(void* lpObj);

int GetNextResults();

Remarks

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++)

ImportQBXML Method (ObjSearch Class)

Imports a QBXML response aggregate.

Syntax

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++)

OpenQBConnection Method (ObjSearch Class)

Opens a persistent connection to QuickBooks.

Syntax

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++)

Reset Method (ObjSearch Class)

Resets all properties to their defaults.

Syntax

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++)

Search Method (ObjSearch Class)

Submits a query request to QuickBooks.

Syntax

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 ResultAggregate 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++)

Error Event (ObjSearch Class)

Information about errors during data delivery.

Syntax

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

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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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)

Shows the progress of the secure connection.

Syntax

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. Used to track the progress of the connection.

Status Event (ObjSearch Class)

Shows the progress of the QuickBooks connection.

Syntax

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

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.


510*	Object added successfully, but cannot now be read.
520*	Insufficient permissions to get all data.
801	Unable to update field (name).
802	Unable to parse name.

Unlisted QuickBooks warnings will cause the class to throw an exception instead.

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.

Config Settings (ObjSearch Class)

The class accepts one or more of the following configuration settings. Configuration 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.

ObjSearch Config Settings

AuthFlags: Connection Flags (use for QuickBooks Simple Start).

Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By default, the class can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.

A list of allowable AuthFlags is provided below.


"" or 0	Do not send any auth flags
0x01	Support QB Simple Start
0x02	Support QB Pro
0x04	Support QB Premier
0x08	Support QB Enterprise
0x80000000	Force Auth Dialog

To specify support for multiple editions, OR together the values for each edition.

NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found.

CurrencyId: Filters results by indicated currency.

This is available for entity searches (Account, Customer, etc) when QBXMLVersion is "8.0" or greater.

CurrencyName: Filters results by indicated currency.

This is available for entity searches (Account, Customer, etc) when QBXMLVersion is "8.0" or greater.

Date: Searches by exact date.

This field is used as the DueDate for the qtBillToPayQuery Query Type and the TxnDate for the qtItemAssembliesCanBuildQuery Query Type. The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

DeletionType: The type of list or transaction from which a member has been deleted.

For the qtListDeletedQuery QueryType the following values are supported: Account, BillingRate, Class, Currency, Customer, CustomerMsg, CustomerType, DateDrivenTerms, Employee, ItemDiscount, ItemFixedAsset, ItemGroup, ItemInventory, ItemInventoryAssembly, ItemNonInventory, ItemOtherCharge, ItemPayment, ItemSalesTax, ItemSalesTaxGroup, ItemService, ItemSubtotal, JobType, OtherName, PaymentMethod, PayrollItemNonWage, PayrollItemWage, PriceLevel, SalesRep, SalesTaxCode, ShipMethod, StandardTerms, ToDo, UnitOfMeasureSet, Vehicle, Vendor, and VendorType.

For the qtTxnDeletedQuery QueryType the following values are supported: ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, CreditCardCharge, CreditCardCredit, CreditMemo, Deposit, Estimate, InventoryAdjustment, Invoice, ItemReceipt, JournalEntry, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, TimeTracking, VehicleMileage, VendorCredit

EnforceMaxLength: Indicates whether to enforce max lengths for QB Fields.

If you change this setting to False, the class will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

FindWithChildren: Include children in the results of an entity Name or Id search.

If set to true, searching by EntityName or EntityId will include all of that item's children in the response.

This is only applicable to searches for transaction objects.

GetHighestVersion: Highest QBXMLVersion supported by the installed instance of QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to QuickBooks.

GetRequestProcessorDLLVersion: Returns the version of the QB Request Processor that is installed on your system.

GetSupportedVersions: Returns a list of QBXMLVersions that are supported by QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters.

IsReadOnly: This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.

The default value is false.

MetaDataType: Controls whether a count of results is returned or not.

This configuration setting can be used to instruct QuickBooks (via the metaData request attribute) to return a count of the results being returned. This can be configured so that the count is returned with the results or so that only a count and no data is returned.

A list of available values is provided below.


0	No count will be returned. (default)
1	Only the count will be returned.
2	The count will be returned along with the results.

If this is set to return a count, this will be available via the ResultCount configuration setting.

ModifiedDateRangeFilterName: The ModifiedDateRangeFilter tag name to be used in the request.

Specifying ModifiedDateStart or ModifiedDateEnd SearchCriteria fields will cause a 'ModifiedDateRangeFilter' tag to be added to the qbXML request. In some transaction queries, however, the QuickBooks SDK specifies a different name for this tag. This configuration setting allows you to specify an alternate tag name to be used.

The default value is ModifiedDateRangeFilter

PersonalDataPref: Whether the connecting application will require access to personal data such as SSN or credit card information.

This setting allows you to let the user know immediately whether your application requires access to personal data or not.

A list of available values is provided below.


pdpOptional	Causes the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data.
pdpRequired	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data.
pdpNotNeeded	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data.

The default value is pdpOptional.

QBConnectionMode: The mode of connection to QuickBooks.

Specifies whether the integrated application logs in using single-user or multi-user mode.

The following values are permitted:


0	Don't Care
1	Single-User Mode
2	Multi-User Mode

About Single-User and Multi-User Modes

If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well.

If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out.

If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode.

About Integrated and Automatic Login

Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection.

Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified.

By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically.

For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString.

QBFileStatus: The status of the company file as it pertains to accepting connections.

This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When queried the class will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are:


0	The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open.
1	The company file will not accept the connection. This indicates a different company file is already open.

QBOpenCompanyFile: The file currently open in QuickBooks.

The name of the file currently open in QuickBooks, specified completely with the path. This field is read-only.

A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs.

If the value of this property is nonempty, the class may interact exclusively with the open file.

ResultCount: A count of results returned via QuickBooks' metaData attribute.

Contains the count returned from QuickBooks when MetaDataType is configured to return this information.

SSLAcceptServerCert: The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).

The Base-64 encoded certificate being used by the Remote Connector (you may get this certificate from the Remote Connector by going to the Security tab, and clicking Export.)

This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system.

SSLAcceptServerCertFile: The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).

If your public key certificate is stored in a file, you may set this configuration setting to the full path of the certificate, and it will be immediately read from disk and stored in SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.

Reading the value of this setting will return an empty string.

StopOnError: Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.

If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs.

TotalBalance: The balance which returned records should have.

Limits the search to records with balances equal to TotalBalance. If TotalBalance is specified, TotalBalanceMaximum and TotalBalanceMinumum may not be (this limitation is imposed by the QBXML interface).

The amount should be formatted as a string in dollars.

Only applicable to searches for entity objects.

TxnDateRangeFilterName: The TxnDateRangeFilter tag name to be used in the request.

Specifying TransactionDateStart or TransactionDateEnd SearchCriteria fields will cause a 'TxnDateRangeFilter' tag to be added to the qbXML request. In some transaction queries, however, the QuickBooks SDK specifies a different name for this tag. This configuration setting allows you to specify an alternate tag name to be used.

The default value is TxnDateRangeFilter

UnattendedModePref: Whether connecting while QuickBooks is closed is required or optional for the user.

This setting allows you to let the user know immediately whether your application requires the ability to access QuickBooks while QuickBooks is closed.

A list of available values is provided below.


umpOptional	Causes the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode.
umpRequired	Causes the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode).

The default value is umpOptional.

WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.

By default, the class will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

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.

Errors

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

101   String too long.
103   Invalid date format (YYYY-MM-DD is standard).
104   Invalid value for enumerated field.
105   Invalid integer.
106   Invalid dollar amount.
107   Invalid boolean value (must be 'true' or 'false').
108   Invalid number.
111   Invalid special characters in string.
112   Invalid special field syntax.
181   Could not load certificate file.
201   Required field unspecified.
211   Unsupported field specified.
301   Array line count must be nonnegative.
302   Array index out of bounds.
303   Invalid field index.
401   Field not accessible as a special field.
402   Write access attempted of readonly field.
403   Read access attempted of writeonly field.
421   The object cannot be modified.
511   The QBRequestId has been previously used. Please generate a new one.
601   Could not access QuickBooks.
602   Could not open specified file.
603   The version of QuickBooks currently being used is not supported.
604   QuickBooks has not been installed properly.
605   The specified file was of an incorrect version.
606   Could not start QuickBooks.
607   QuickBooks is open in a mode different than the one requested.
608   QuickBooks cannot currently be accessed.
609   An application name must be specified.
610   A file name must be specified if one is not currently open in QuickBooks.
611   Access denied.
612   QuickBooks is busy and cannot open your application in the mode requested.
699   The connection to QuickBooks has failed for an unknown reason.
702   The object requested does not exist in QuickBooks.
751   Unsupported QBXML version.
752   The QBXMLVersion chosen is insufficient to execute the request.
801   A QuickBooks internal error has occurred.
802   QuickBooks is not available due to a system-related problem.
803   The Id specified is invalid.
804   Invalid object name.
805   The name already exists in QuickBooks.
807   An object could not be found in QuickBooks.
808   A reference did not refer to an object that exists in QuickBooks.
809   The object is currently in use by the QuickBooks end user.
810   The object may not be added.
811   The object may not be updated because it is obsolete.
812   The address is invalid.
813   Permission to perform this operation is not granted.
814   The request has not been processed.
815   Time creation mismatch.
816   The feature is turned off or not enabled.
817   Permission level configured is insufficient for access.
818    The item specified was of an unknown type.
819   The object may not be changed.
820   An internal QuickBooks error has occurred.
821   An attempt was made to use a connection that was not properly initiated.
822   An attempt was made to use a connection that is invalid or was previously closed.
823   Not enough memory.
824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
861   Server error on WebExport (details follow).
862   The WebExport is impossible: an HTTP context was not found.
871   You may not set the value of QBConnectionTicket. This value is readonly.
880   Interrupted by the user.
881   An error has occurred connecting to a remote machine.
899   An unknown QuickBooks error has occurred. The message contains more details.
901   XML Parser Error. Should not occur under normal circumstances.
304   Unknown query field.
501   Only one of TotalBalanceMinimum and TotalBalanceMaximum may be specified.


	101 String too long.
	103 Invalid date format (YYYY-MM-DD is standard).
	104 Invalid value for enumerated field.
	105 Invalid integer.
	106 Invalid dollar amount.
	107 Invalid boolean value (must be 'true' or 'false').
	108 Invalid number.
	111 Invalid special characters in string.
	112 Invalid special field syntax.
	181 Could not load certificate file.
	201 Required field unspecified.
	211 Unsupported field specified.
	301 Array line count must be nonnegative.
	302 Array index out of bounds.
	303 Invalid field index.
	401 Field not accessible as a special field.
	402 Write access attempted of readonly field.
	403 Read access attempted of writeonly field.
	421 The object cannot be modified.
	511 The QBRequestId has been previously used. Please generate a new one.
	601 Could not access QuickBooks.
	602 Could not open specified file.
	603 The version of QuickBooks currently being used is not supported.
	604 QuickBooks has not been installed properly.
	605 The specified file was of an incorrect version.
	606 Could not start QuickBooks.
	607 QuickBooks is open in a mode different than the one requested.
	608 QuickBooks cannot currently be accessed.
	609 An application name must be specified.
	610 A file name must be specified if one is not currently open in QuickBooks.
	611 Access denied.
	612 QuickBooks is busy and cannot open your application in the mode requested.
	699 The connection to QuickBooks has failed for an unknown reason.
	702 The object requested does not exist in QuickBooks.
	751 Unsupported QBXML version.
	752 The QBXMLVersion chosen is insufficient to execute the request.
	801 A QuickBooks internal error has occurred.
	802 QuickBooks is not available due to a system-related problem.
	803 The Id specified is invalid.
	804 Invalid object name.
	805 The name already exists in QuickBooks.
	807 An object could not be found in QuickBooks.
	808 A reference did not refer to an object that exists in QuickBooks.
	809 The object is currently in use by the QuickBooks end user.
	810 The object may not be added.
	811 The object may not be updated because it is obsolete.
	812 The address is invalid.
	813 Permission to perform this operation is not granted.
	814 The request has not been processed.
	815 Time creation mismatch.
	816 The feature is turned off or not enabled.
	817 Permission level configured is insufficient for access.
	818 The item specified was of an unknown type.
	819 The object may not be changed.
	820 An internal QuickBooks error has occurred.
	821 An attempt was made to use a connection that was not properly initiated.
	822 An attempt was made to use a connection that is invalid or was previously closed.
	823 Not enough memory.
	824 Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861 Server error on WebExport (details follow).
	862 The WebExport is impossible: an HTTP context was not found.
	871 You may not set the value of QBConnectionTicket. This value is readonly.
	880 Interrupted by the user.
	881 An error has occurred connecting to a remote machine.
	899 An unknown QuickBooks error has occurred. The message contains more details.
	901 XML Parser Error. Should not occur under normal circumstances.
	304 Unknown query field.
	501 Only one of TotalBalanceMinimum and TotalBalanceMaximum may be specified.