ObjSearch Control
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. |
| 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). |
| 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. |
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. |
| 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 control 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 control 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 control 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 control 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |
IncludeLineItems Property (ObjSearch Control)
Indicates whether to include line items in the response.
Syntax
objsearchcontrol.IncludeLineItems[=boolean]
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 Control)
Indicates whether to include linked transactions in the response.
Syntax
objsearchcontrol.IncludeLinkedTxns[=boolean]
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 control will parse the linked transactions into their respective properties.
Data Type
Boolean
IterateResults Property (ObjSearch Control)
Indicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater.
Syntax
objsearchcontrol.IterateResults[=boolean]
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 Control)
The maximum number of results to be returned from a search.
Syntax
objsearchcontrol.MaxResults[=integer]
Default Value
0
Remarks
The maximum number of records to return from QuickBooks.
If MaxResults is set to 0, all records matching the search criteria will be returned.
Data Type
Integer
QBConnectionString Property (ObjSearch Control)
An aggregate consisting of various QuickBooks connection properties.
Syntax
objsearchcontrol.QBConnectionString[=string]
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 control 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 control'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 control 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 control 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 control 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 control binds. |
| UseRDS | Whether to connect using Remote Data Sharing (RDS). If set to True, the control 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 Control)
The request aggregate.
Syntax
objsearchcontrol.QBRequestAggregate[=string]
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 control to generate requests to be sent to QuickBooks Web Connector.
This property is not available at design time.
Data Type
String
QBRequestMode Property (ObjSearch Control)
Defines whether the request is made online or stored offline.
Syntax
objsearchcontrol.QBRequestMode[=integer]
Possible Values
rmOnline(0), rmOffline(1)
Default Value
0
Remarks
This property defines the behavior of the control 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. |
For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.
Data Type
Integer
QBResponseAggregate Property (ObjSearch Control)
The last QBXML response aggregate received from QuickBooks.
Syntax
objsearchcontrol.QBResponseAggregate[=string]
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 control 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 Control)
The version of QBXML used in the outgoing message.
Syntax
objsearchcontrol.QBXMLVersion[=string]
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 |
| 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 |
This property is not available at design time.
Data Type
String
QueryType Property (ObjSearch Control)
The type of search to perform.
Syntax
objsearchcontrol.QueryType[=integer]
Possible Values
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), qtStatementChargeQuery(42), qtMileageQuery(43), qtOtherTransactionSearch(100), qtOtherListSearch(101)
Default Value
0
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 |
This property is required.
Data Type
Integer
RemainingResults Property (ObjSearch Control)
Indicates the number of results left in an iterative search.
Syntax
objsearchcontrol.RemainingResults
Default Value
0
Remarks
A new feature in QuickBooks 2006 allows you to search iteratively. What this basically means is that you can search a customer or transaction list for all transactions, but receive them in chunks of 50 or 100 at a time, instead of one large response potentially containing thousands of entries. This greatly improves response time and also assures that your application does not appear to hang while QuickBooks is putting together the response.
To accomplish such a search, you must set QBXMLVersion to 5.0 or higher. MaxResults will indicates the size of the chunks returned (if set to 0 an iterative search will not be performed). RemainingResults will indicate the number of results remaining. You must also must open and maintain a persistent connection, as searches cannot be continued across sessions. For example:
control.QueryType = qtCustomerSearch()
control.MaxResults = 10
control.QBXMLVersion = "5.0"
control.OpenQBConnection()
control.Search()
' Process first set of results here
While (control.RemainingResults > 0)
control.GetNextResults()
' Process results here
Wend
control.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 Control)
The number of records in the Result arrays.
Syntax
objsearchcontrol.ResultCount
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Control)
XML response aggregate returned from QuickBooks.
Syntax
objsearchcontrol.ResultAggregate(ResultIndex)
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 control. If this is done the control 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 Control)
Id of the result aggregate stored in Aggregate .
Syntax
objsearchcontrol.ResultId(ResultIndex)
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 control, 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 Control)
Name of the result aggregate stored in Aggregate .
Syntax
objsearchcontrol.ResultName(ResultIndex)
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 control 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 Control)
Return only the names and Ids in the results.
Syntax
objsearchcontrol.RetrieveNamesOnly[=boolean]
Default Value
False
Remarks
If RetrieveNamesOnly is True, entity searches (Customer, Employee, etc) will return only the FullName and ListID for each result. The control 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 Control)
An account name to search for in a transaction.
Syntax
objsearchcontrol.AccountId[=string]
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 Control)
An account name to search for in a transaction.
Syntax
objsearchcontrol.AccountName[=string]
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 Control)
Search by the type of QuickBooks account.
Syntax
objsearchcontrol.AccountType[=integer]
Possible Values
atUnspecified(0), atAccountsPayable(1), atAccountsReceivable(2), atBank(3), atCostOfGoodsSold(4), atCreditCard(5), atEquity(6), atExpense(7), atFixedAsset(8), atIncome(9), atLongTermLiability(10), atOtherAsset(11), atOtherCurrentAsset(12), atOtherCurrentLiability(13), atOtherExpense(14), atOtherIncome(15), atNonPosting(16)
Default Value
0
Remarks
Search by the type of QuickBooks account.
Only applicable to account queries.
Data Type
Integer
ActiveStatus Property (ObjSearch Control)
Limits the search to active or inactive records only.
Syntax
objsearchcontrol.ActiveStatus[=integer]
Possible Values
asUnspecified(0), asActiveOnly(1), asInactiveOnly(2), asAll(3)
Default Value
0
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 |
Data Type
Integer
EntityId Property (ObjSearch Control)
Limits the search to transactions associated with the entity specified by EntityId .
Syntax
objsearchcontrol.EntityId[=string]
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 Control)
An entity name to search for in a transaction.
Syntax
objsearchcontrol.EntityName[=string]
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 Control)
The type of item to search for.
Syntax
objsearchcontrol.ItemType[=integer]
Possible Values
sitAll(0), sitService(1), sitInventory(2), sitNonInventory(3), sitPayment(4), sitDiscount(5), sitSalesTax(6), sitSubtotal(7), sitOtherCharge(8), sitInventoryAssembly(9), sitGroup(10), sitSalesTaxGroup(11), sitFixedAsset(12), sitSites(13)
Default Value
0
Remarks
The type of item to search for. Applies only to searches for items. If set to itAll (the default) the control will search for all types of items.
Data Type
Integer
ModifiedDateEnd Property (ObjSearch Control)
Latest modified date to search for.
Syntax
objsearchcontrol.ModifiedDateEnd[=string]
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 Control)
Earliest modified date to search for.
Syntax
objsearchcontrol.ModifiedDateStart[=string]
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.
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
NameContains Property (ObjSearch Control)
String which names are to contain.
Syntax
objsearchcontrol.NameContains[=string]
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 Control)
String which names are to end with.
Syntax
objsearchcontrol.NameEndsWith[=string]
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 Control)
Ending point of a name range.
Syntax
objsearchcontrol.NameRangeEnd[=string]
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 Control)
Starting point of a name range.
Syntax
objsearchcontrol.NameRangeStart[=string]
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 Control)
String which names are to start with.
Syntax
objsearchcontrol.NameStartsWith[=string]
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 Control)
Limits the search to paid or unpaid transactions only.
Syntax
objsearchcontrol.PaidStatus[=integer]
Possible Values
psUnspecified(0), psAll(1), psPaid(2), psUnpaid(3)
Default Value
0
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 |
Data Type
Integer
RefNumber Property (ObjSearch Control)
Exact RefNumber to search for.
Syntax
objsearchcontrol.RefNumber[=string]
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 Control)
String which RefNumbers are to contain.
Syntax
objsearchcontrol.RefNumberContains[=string]
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 Control)
String which RefNumbers are to end with.
Syntax
objsearchcontrol.RefNumberEndsWith[=string]
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 Control)
Ending point of a RefNumber range.
Syntax
objsearchcontrol.RefNumberRangeEnd[=string]
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 Control)
Starting point of a RefNumber range.
Syntax
objsearchcontrol.RefNumberRangeStart[=string]
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 Control)
String which RefNumbers are to start with.
Syntax
objsearchcontrol.RefNumberStartsWith[=string]
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 Control)
A maximum balance which returned records should have.
Syntax
objsearchcontrol.TotalBalanceMaximum[=string]
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 Control)
A minimum balance which returned records should have.
Syntax
objsearchcontrol.TotalBalanceMinimum[=string]
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 Control)
Latest transaction date to search for.
Syntax
objsearchcontrol.TransactionDateEnd[=string]
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.
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.
Only applicable to searches for transaction objects.
Data Type
String
TransactionDateStart Property (ObjSearch Control)
Earliest transaction date to search for.
Syntax
objsearchcontrol.TransactionDateStart[=string]
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.
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.
Only applicable to searches for transaction objects.
Data Type
String
SpecialQueryType Property (ObjSearch Control)
The special query type; for example ItemService.
Syntax
objsearchcontrol.SpecialQueryType[=string]
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 control 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 Control)
Closes a persistent connection to QuickBooks.
Syntax
objsearchcontrol.CloseQBConnection
Remarks
Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the control 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.
Config Method (ObjSearch Control)
Sets or retrieves a configuration setting.
Syntax
objsearchcontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.
GetNextResults Method (ObjSearch Control)
Retrieves the next set of results (only applicable for iterative searches).
Syntax
objsearchcontrol.GetNextResults
Remarks
A new feature in QuickBooks 2006 allows you to search iteratively. What this basically means is that you can search a customer or transaction list for all transactions, but receive them in chunks of 50 or 100 at a time, instead of one large response potentially containing thousands of entries. This greatly improves response time and also assures that your application does not appear to hang while QuickBooks is putting together the response.
To accomplish such a search, you must set QBXMLVersion to 5.0 or higher. MaxResults will indicates the size of the chunks returned (if set to 0 an iterative search will not be performed). RemainingResults will indicate the number of results remaining. You must also must open and maintain a persistent connection, as searches cannot be continued across sessions. For example:
control.QueryType = qtCustomerSearch
control.MaxResults = 10
control.QBXMLVersion = "5.0"
control.OpenQBConnection()
control.Search()
' Process first set of results here
While (control.RemainingResults > 0)
control.GetNextResults()
' Process additional results here
Wend
control.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.
ImportQBXML Method (ObjSearch Control)
Imports a QBXML response aggregate.
Syntax
objsearchcontrol.ImportQBXML XMLData
Remarks
This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the control will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.
OpenQBConnection Method (ObjSearch Control)
Opens a persistent connection to QuickBooks.
Syntax
objsearchcontrol.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 control 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.
Reset Method (ObjSearch Control)
Resets all properties to their defaults.
Syntax
objsearchcontrol.Reset
Remarks
This method resets the values of all properties (and all special fields) to their defaults.
After calling this method, the control may be reused as if it were newly created.
Search Method (ObjSearch Control)
Submits a query request to QuickBooks.
Syntax
objsearchcontrol.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 Event (ObjSearch Control)
Information about errors during data delivery.
Syntax
Sub objsearchcontrol_Error(ErrorCode As Integer, Description As String)
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 Control)
Fired after the server presents its certificate to the client.
Syntax
Sub objsearchcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
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 Control)
Shows the progress of the secure connection.
Syntax
Sub objsearchcontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Status Event (ObjSearch Control)
Shows the progress of the QuickBooks connection.
Syntax
Sub objsearchcontrol_Status(Message As String)
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Warning Event (ObjSearch Control)
Fired when a warning occurs.
Syntax
Sub objsearchcontrol_Warning(Code As Integer, Description As String)
Remarks
The Warning event is fired when the control has produced, or will produce, possibly unexpected results.
Warnings may be generated by QuickBooks or the control. 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. |
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 Control)
The control 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 control, 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 control 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.
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.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 control 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.
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.
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:
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 control will attempt to determine whether a subsequent connection using the provided QBConnectionString
value would succeed. Possible return values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 control 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.
The default value is umpOptional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.By default, the control 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 to mask sensitive data. The default is .
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the control whether or not to use the system security libraries or an internal implementation.
When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the control to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms. |
Trappable Errors (ObjSearch Control)
ErrorsThe following errors may be generated by the control. Note that frequently the error message will contain more specific information than what is listed here.
ObjSearch Errors
| 20102 String too long. | |
| 20104 Invalid date format (YYYY-MM-DD is standard). | |
| 20105 Invalid value for enumerated field. | |
| 20106 Invalid integer. | |
| 20107 Invalid dollar amount. | |
| 20108 Invalid boolean value (must be 'true' or 'false'). | |
| 20109 Invalid number. | |
| 20112 Invalid special characters in string. | |
| 20113 Invalid special field syntax. | |
| 20182 Could not load certificate file. | |
| 20202 Required field unspecified. | |
| 20212 Unsupported field specified. | |
| 20302 Array line count must be nonnegative. | |
| 20303 Array index out of bounds. | |
| 20304 Invalid field index. | |
| 20402 Field not accessible as a special field. | |
| 20403 Write access attempted of readonly field. | |
| 20404 Read access attempted of writeonly field. | |
| 20422 The object cannot be modified. | |
| 20512 The QBRequestId has been previously used. Please generate a new one. | |
| 20602 Could not access QuickBooks. | |
| 20603 Could not open specified file. | |
| 20604 The version of QuickBooks currently being used is not supported. | |
| 20605 QuickBooks has not been installed properly. | |
| 20606 The specified file was of an incorrect version. | |
| 20607 Could not start QuickBooks. | |
| 20608 QuickBooks is open in a mode different than the one requested. | |
| 20609 QuickBooks cannot currently be accessed. | |
| 20610 An application name must be specified. | |
| 20611 A file name must be specified if one is not currently open in QuickBooks. | |
| 20612 Access denied. | |
| 20613 QuickBooks is busy and cannot open your application in the mode requested. | |
| 20700 The connection to QuickBooks has failed for an unknown reason. | |
| 20703 The object requested does not exist in QuickBooks. | |
| 20752 Unsupported QBXML version. | |
| 20753 The QBXMLVersion chosen is insufficient to execute the request. | |
| 20802 A QuickBooks internal error has occurred. | |
| 20803 QuickBooks is not available due to a system-related problem. | |
| 20804 The Id specified is invalid. | |
| 20805 Invalid object name. | |
| 20806 The name already exists in QuickBooks. | |
| 20808 An object could not be found in QuickBooks. | |
| 20809 A reference did not refer to an object that exists in QuickBooks. | |
| 20810 The object is currently in use by the QuickBooks end user. | |
| 20811 The object may not be added. | |
| 20812 The object may not be updated because it is obsolete. | |
| 20813 The address is invalid. | |
| 20814 Permission to perform this operation is not granted. | |
| 20815 The request has not been processed. | |
| 20816 Time creation mismatch. | |
| 20817 The feature is turned off or not enabled. | |
| 20818 Permission level configured is insufficient for access. | |
| 20819 The item specified was of an unknown type. | |
| 20820 The object may not be changed. | |
| 20821 An internal QuickBooks error has occurred. | |
| 20822 An attempt was made to use a connection that was not properly initiated. | |
| 20823 An attempt was made to use a connection that is invalid or was previously closed. | |
| 20824 Not enough memory. | |
| 20825 Unable to lock the necessary information to allow this application access to the company file. Try again later. | |
| 20851 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit. | |
| 20852 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system. | |
| 20862 Server error on WebExport (details follow). | |
| 20863 The WebExport is impossible: an HTTP context was not found. | |
| 20872 You may not set the value of QBConnectionTicket. This value is readonly. | |
| 20881 Interrupted by the user. | |
| 20882 An error has occurred connecting to a remote machine. | |
| 20900 An unknown QuickBooks error has occurred. The message contains more details. | |
| 20902 XML Parser Error. Should not occur under normal circumstances. | |
| 20305 Unknown query field. | |
| 20502 Only one of TotalBalanceMinimum and TotalBalanceMaximum may be specified. |