4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

ObjSearch Component

Properties   Methods   Events   Configuration Settings   Errors  

ObjSearch is used to search the QuickBooks database.

Syntax

DPayments.DAccountingSDK.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 FilterLimits the search to records last modified before/after specified dates. One or both of ModifiedDateStart and ModifiedDateEnd may be specified.

The following filters may be specified when searching for entities (a Customer, Vendor, or Employee). The Name filter may also be specified for Item searches.

Name FilterLimits 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 FilterLimits the search to entities with balances at least TotalBalanceMinimum or at most TotalBalanceMaximum (not defined for Employee).

The following filters may be specified when searching for transactions:

RefNumber FilterLimits 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 FilterLimits the search to transactions with a date before or after specified dates. One or both of TransactionDateStart and TransactionDateEnd may be specified.
Entity FilterLimits the search to transactions associated with the entity specified by EntityName.
Account FilterLimits the search to transactions associated with the account specified by AccountName.

Note that for TimeTracking searches the Account and RefNumber filters are not used.

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

PaidStatus FilterLimits the search either to paid or unpaid bills or invoices only, as specified in PaidStatus.

The additional filters may be specified for Item objects.

Name FilterLimits the search based on the name of the item (see above).
ItemType FilterLimits 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.

IncludeLineItemsIndicates whether to include line items in the response.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
IterateResultsIndicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater.
MaxResultsThe maximum number of results to be returned from a search.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestAggregateThe request aggregate.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
QueryTypeThe type of search to perform.
RemainingResultsIndicates the number of results left in an iterative search.
ResultsContains a collection of search results.
RetrieveNamesOnlyReturn only the names and Ids in the results.
SearchCriteriaCriteria used to limit a search to specific set of transactions.
SpecialQueryTypeThe 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.

CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
GetNextResultsRetrieves the next set of results (only applicable for iterative searches).
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SearchSubmits 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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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.

AuthFlagsConnection Flags (use for QuickBooks Simple Start).
CurrencyIdFilters results by indicated currency.
CurrencyNameFilters results by indicated currency.
DateSearches by exact date.
DeletionTypeThe type of list or transaction from which a member has been deleted.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
FindWithChildrenInclude children in the results of an entity Name or Id search.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
MetaDataTypeControls whether a count of results is returned or not.
ModifiedDateRangeFilterNameThe ModifiedDateRangeFilter tag name to be used in the request.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
ResultCountA count of results returned via QuickBooks' metaData attribute.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TotalBalanceThe balance which returned records should have.
TxnDateRangeFilterNameThe TxnDateRangeFilter tag name to be used in the request.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]