ObjSearch Component
Properties Methods Events Configuration Settings Errors
ObjSearch is used to search the QuickBooks database.
Syntax
nsoftware.InQB.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.SearchCriteria.TransactionDateStart = "10/01/2002"; ObjSearch1.SearchCriteria.EntityName = "Joe Reckless"; ObjSearch1.SearchCriteria.PaidStatus = psUnpaid; ObjSearch1.Search(); Invoice1.QBResponseAggregate = ObjSearch1.Results[0].Aggregate; Invoice2.QBResponseAggregate = ObjSearch1.Results[1].Aggregate;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 ResultId will hold the Ids returned and Aggregate will hold information for the objects returned. To instantiate an object, set its QBResponseAggregate property to the appropriate Aggregate.
One or more search filters may be specified. These filters limit the search to records meeting specified criteria. If no filters are specified, ObjSearch will return all objects in the database, up to the limit specified by MaxResults.
The following filter may be specified in all searches:
| 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 component 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. |
| Results | Contains a collection of search results. |
| RetrieveNamesOnly | Return only the names and Ids in the results. |
| SearchCriteria | Criteria used to limit a search to specific set of transactions. |
| SpecialQueryType | The special query type; for example ItemService. |
Method List
The following is the full list of the methods of the component 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 component 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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| FindWithChildren | Include children in the results of an entity Name or Id search. |
| Date | Searches by exact date. |
| DeletionType | The type of list or transaction from which a member has been deleted. |
| CurrencyId | Filters results by indicated currency. |
| CurrencyName | Filters results by indicated currency. |
| MetaDataType | Controls whether a count of results is returned or not. |
| ModifiedDateRangeFilterName | The ModifiedDateRangeFilter tag name to be used in the request. |
| ResultCount | A count of results returned via QuickBooks' metaData attribute. |
| TotalBalance | The balance which returned records should have. |
| TxnDateRangeFilterName | The TxnDateRangeFilter tag name to be used in the request. |
| StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
| SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
| SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
| GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
| GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| QBOpenCompanyFile | The file currently open in QuickBooks. |
| QBConnectionMode | The mode of connection to QuickBooks. |
| QBFileStatus | The status of the company file as it pertains to accepting connections. |
| 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. |