ObjSearch Class
Properties Methods Events Configuration Settings Errors
ObjSearch is used to search the QuickBooks database.
Syntax
class 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.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 query_type before beginning the search. The maximum number of returned objects may also be specified in max_results.
The search may be executed by calling the search method. After search is called ResultCount will hold the number of results, result_id will hold the Ids returned and result_aggregate will hold information for the objects returned. To instantiate an object, set its QBResponseAggregate property to the appropriate result_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 max_results.
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 modified_date_start and modified_date_end may be specified. |
| Name Filter | Limits the search based on the name of the entity. One or both of name_range_start or name_range_end may be specified to limit the search to a range of names. Alternatively, one of name_starts_with, name_ends_with, or name_contains may be specified. |
| TotalBalance Filter | Limits the search to entities with balances at least total_balance_minimum or at most total_balance_maximum (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 ref_number_range_start or ref_number_range_end may be specified to limit the search to a range of RefNumbers. Alternatively, one of ref_number_starts_with, ref_number_ends_with, or ref_number_contains may be specified. |
| TransactionDate Filter | Limits the search to transactions with a date before or after specified dates. One or both of transaction_date_start and transaction_date_end may be specified. |
| Entity Filter | Limits the search to transactions associated with the entity specified by entity_name. |
| Account Filter | Limits the search to transactions associated with the account specified by account_name. |
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 paid_status. |
| 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 item_type. |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| include_line_items | Indicates whether to include line items in the response. |
| include_linked_txns | Indicates whether to include linked transactions in the response. |
| iterate_results | Indicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater. |
| max_results | The maximum number of results to be returned from a search. |
| qb_connection_string | An aggregate consisting of various QuickBooks connection properties. |
| qb_request_aggregate | The request aggregate. |
| qb_request_mode | Defines whether the request is made online or stored offline. |
| qb_response_aggregate | The last QBXML response aggregate received from QuickBooks. |
| qbxml_version | The version of QBXML used in the outgoing message. |
| query_type | The type of search to perform. |
| remaining_results | Indicates the number of results left in an iterative search. |
| result_count | The number of records in the Result arrays. |
| result_aggregate | XML response aggregate returned from QuickBooks. |
| result_id | Id of the result aggregate stored in Aggregate . |
| result_name | Name of the result aggregate stored in Aggregate . |
| retrieve_names_only | Return only the names and Ids in the results. |
| account_id | An account name to search for in a transaction. |
| account_name | An account name to search for in a transaction. |
| account_type | Search by the type of QuickBooks account. |
| active_status | Limits the search to active or inactive records only. |
| entity_id | Limits the search to transactions associated with the entity specified by EntityId . |
| entity_name | An entity name to search for in a transaction. |
| item_type | The type of item to search for. |
| modified_date_end | Latest modified date to search for. |
| modified_date_start | Earliest modified date to search for. |
| name_contains | String which names are to contain. |
| name_ends_with | String which names are to end with. |
| name_range_end | Ending point of a name range. |
| name_range_start | Starting point of a name range. |
| name_starts_with | String which names are to start with. |
| paid_status | Limits the search to paid or unpaid transactions only. |
| ref_number | Exact RefNumber to search for. |
| ref_number_contains | String which RefNumbers are to contain. |
| ref_number_ends_with | String which RefNumbers are to end with. |
| ref_number_range_end | Ending point of a RefNumber range. |
| ref_number_range_start | Starting point of a RefNumber range. |
| ref_number_starts_with | String which RefNumbers are to start with. |
| total_balance_maximum | A maximum balance which returned records should have. |
| total_balance_minimum | A minimum balance which returned records should have. |
| transaction_date_end | Latest transaction date to search for. |
| transaction_date_start | Earliest transaction date to search for. |
| special_query_type | 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.
| close_qb_connection | Closes a persistent connection to QuickBooks. |
| config | Sets or retrieves a configuration setting. |
| get_next_results | Retrieves the next set of results (only applicable for iterative searches). |
| import_qbxml | Imports a QBXML response aggregate. |
| open_qb_connection | 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.
| on_error | Information about errors during data delivery. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_status | Shows the progress of the QuickBooks connection. |
| on_warning | Fired when a warning occurs. |
Configuration Settings
The following is a list of configuration 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 Remote Connector. |
| SSLAcceptServerCertFile | The SSL certificate file being used by the 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. |
| 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. |