ObjSearch Module

Properties   Methods   Events   Config Settings   Errors  

ObjSearch is used to search the QuickBooks database.

Syntax

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 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, ResultsResultId will hold the Ids returned and ResultsAggregate will hold information for the objects returned. To instantiate an object, set its QBResponseAggregate property to the appropriate ResultsAggregate.

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:

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.

The following filters may be specified when searching for transactions:

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.

The additional filters may be specified for Item objects.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

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

IncludeLineItems Property (ObjSearch Module)

Indicates whether to include line items in the response.

Syntax

• Swift
• Objective-C

public var includeLineItems: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=includeLineItems,setter=setIncludeLineItems:) BOOL includeLineItems;

- (BOOL)includeLineItems;
- (void)setIncludeLineItems :(BOOL)newIncludeLineItems;

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.

IncludeLinkedTxns Property (ObjSearch Module)

Indicates whether to include linked transactions in the response.

Syntax

• Swift
• Objective-C

public var includeLinkedTxns: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=includeLinkedTxns,setter=setIncludeLinkedTxns:) BOOL includeLinkedTxns;

- (BOOL)includeLinkedTxns;
- (void)setIncludeLinkedTxns :(BOOL)newIncludeLinkedTxns;

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 ResultsAggregate. Passing this aggregate to the corresponding class will parse the linked transactions into their respective properties.

IterateResults Property (ObjSearch Module)

Indicates whether to perform iterative searches when QBXMLVersion = 5.0 or greater.

Syntax

• Swift
• Objective-C

public var iterateResults: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=iterateResults,setter=setIterateResults:) BOOL iterateResults;

- (BOOL)iterateResults;
- (void)setIterateResults :(BOOL)newIterateResults;

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.

MaxResults Property (ObjSearch Module)

The maximum number of results to be returned from a search.

Syntax

• Swift
• Objective-C

public var maxResults: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=maxResults,setter=setMaxResults:) int maxResults;

- (int)maxResults;
- (void)setMaxResults :(int)newMaxResults;

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.

QBConnectionString Property (ObjSearch Module)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• Swift
• Objective-C

public var qbConnectionString: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=QBConnectionString,setter=setQBConnectionString:) NSString* QBConnectionString;

- (NSString*)QBConnectionString;
- (void)setQBConnectionString :(NSString*)newQBConnectionString;

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:

QBRequestAggregate Property (ObjSearch Module)

The request aggregate.

Syntax

• Swift
• Objective-C

public var qbRequestAggregate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=QBRequestAggregate,setter=setQBRequestAggregate:) NSString* QBRequestAggregate;

- (NSString*)QBRequestAggregate;
- (void)setQBRequestAggregate :(NSString*)newQBRequestAggregate;

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

QBRequestMode Property (ObjSearch Module)

Defines whether the request is made online or stored offline.

Syntax

• Swift
• Objective-C

public var qbRequestMode: ObjsearchQBRequestModes {
  get {...}
  set {...}
}

public enum ObjsearchQBRequestModes: Int32 {
  case rmOnline = 0
  case rmOffline = 1
}

@property (nonatomic,readwrite,assign,getter=QBRequestMode,setter=setQBRequestMode:) int QBRequestMode;

- (int)QBRequestMode;
- (void)setQBRequestMode :(int)newQBRequestMode;

Default Value

0

Remarks

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

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

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

QBResponseAggregate Property (ObjSearch Module)

The last QBXML response aggregate received from QuickBooks.

Syntax

• Swift
• Objective-C

public var qbResponseAggregate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=QBResponseAggregate,setter=setQBResponseAggregate:) NSString* QBResponseAggregate;

- (NSString*)QBResponseAggregate;
- (void)setQBResponseAggregate :(NSString*)newQBResponseAggregate;

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

QBXMLVersion Property (ObjSearch Module)

The version of QBXML used in the outgoing message.

Syntax

• Swift
• Objective-C

public var qbxmlVersion: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=QBXMLVersion,setter=setQBXMLVersion:) NSString* QBXMLVersion;

- (NSString*)QBXMLVersion;
- (void)setQBXMLVersion :(NSString*)newQBXMLVersion;

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:

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

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

QueryType Property (ObjSearch Module)

The type of search to perform.

Syntax

• Swift
• Objective-C

public var queryType: ObjsearchQueryTypes {
  get {...}
  set {...}
}

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

@property (nonatomic,readwrite,assign,getter=queryType,setter=setQueryType:) int queryType;

- (int)queryType;
- (void)setQueryType :(int)newQueryType;

Default Value

0

Remarks

The type of search to perform.

The following values are permitted:

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

This property is required.

RemainingResults Property (ObjSearch Module)

Indicates the number of results left in an iterative search.

Syntax

• Swift
• Objective-C

public var remainingResults: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=remainingResults) int remainingResults;

- (int)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:

class.QueryType = qtCustomerSearch() class.MaxResults = 10 class.QBXMLVersion = "5.0" class.OpenQBConnection() class.Search() ' Process first set of results here While (class.RemainingResults > 0) class.GetNextResults() ' Process results here Wend class.CloseQBConnection()

Note that if you wish searches to operate the same way as they did with previous QBXMLVersions, you may set the IterateResults configuration setting to "False". See Config for more information.

This property is read-only.

Results Property (ObjSearch Module)

Contains a collection of search results.

Syntax

• Swift
• Objective-C

public var results: Array<ObjSearchResult> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=resultCount) int resultCount;

- (int)resultCount;

- (NSString*)resultAggregate:(int)resultIndex;

- (NSString*)resultId:(int)resultIndex;

- (NSString*)resultName:(int)resultIndex;

 

Default Value

""

Remarks

This property may be used to query QuickBooks for items supported by the QuickBooks SDK, but not by the component set.

The property should be set to the name of the object being queried for. A list of the objects supported for query operations by the SDK may be found in the SDK documentation.

When performing a special query the QueryType property should be set to qtOtherTransactionSearch or qtOtherListSearch, as appropriate. After searching, the QBObject class may be used to view and/or edit the results.

It is recommended that users using this property first read the SDK documentation.

RetrieveNamesOnly Property (ObjSearch Module)

Return only the names and Ids in the results.

Syntax

• Swift
• Objective-C

public var retrieveNamesOnly: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=retrieveNamesOnly,setter=setRetrieveNamesOnly:) BOOL retrieveNamesOnly;

- (BOOL)retrieveNamesOnly;
- (void)setRetrieveNamesOnly :(BOOL)newRetrieveNamesOnly;

Default Value

False

Remarks

If RetrieveNamesOnly is True, entity searches (Customer, Employee, etc) will return only the FullName and ListID for each result. The class will silently ignore this property if it is not applicable to the search being performed. This property requires a QBXMLVersion of "4.0" or greater, and is set to False by default.

SearchCriteria Property (ObjSearch Module)

Criteria used to limit a search to specific set of transactions.

Syntax

• Swift
• Objective-C

public var searchCriteria: SearchCriteria {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accountId,setter=setAccountId:) NSString* accountId;

- (NSString*)accountId;
- (void)setAccountId :(NSString*)newAccountId;

@property (nonatomic,readwrite,assign,getter=accountName,setter=setAccountName:) NSString* accountName;

- (NSString*)accountName;
- (void)setAccountName :(NSString*)newAccountName;

@property (nonatomic,readwrite,assign,getter=accountType,setter=setAccountType:) int accountType;

- (int)accountType;
- (void)setAccountType :(int)newAccountType;

@property (nonatomic,readwrite,assign,getter=activeStatus,setter=setActiveStatus:) int activeStatus;

- (int)activeStatus;
- (void)setActiveStatus :(int)newActiveStatus;

@property (nonatomic,readwrite,assign,getter=entityId,setter=setEntityId:) NSString* entityId;

- (NSString*)entityId;
- (void)setEntityId :(NSString*)newEntityId;

@property (nonatomic,readwrite,assign,getter=entityName,setter=setEntityName:) NSString* entityName;

- (NSString*)entityName;
- (void)setEntityName :(NSString*)newEntityName;

@property (nonatomic,readwrite,assign,getter=itemType,setter=setItemType:) int itemType;

- (int)itemType;
- (void)setItemType :(int)newItemType;

@property (nonatomic,readwrite,assign,getter=modifiedDateEnd,setter=setModifiedDateEnd:) NSString* modifiedDateEnd;

- (NSString*)modifiedDateEnd;
- (void)setModifiedDateEnd :(NSString*)newModifiedDateEnd;

@property (nonatomic,readwrite,assign,getter=modifiedDateStart,setter=setModifiedDateStart:) NSString* modifiedDateStart;

- (NSString*)modifiedDateStart;
- (void)setModifiedDateStart :(NSString*)newModifiedDateStart;

@property (nonatomic,readwrite,assign,getter=nameContains,setter=setNameContains:) NSString* nameContains;

- (NSString*)nameContains;
- (void)setNameContains :(NSString*)newNameContains;

@property (nonatomic,readwrite,assign,getter=nameEndsWith,setter=setNameEndsWith:) NSString* nameEndsWith;

- (NSString*)nameEndsWith;
- (void)setNameEndsWith :(NSString*)newNameEndsWith;

@property (nonatomic,readwrite,assign,getter=nameRangeEnd,setter=setNameRangeEnd:) NSString* nameRangeEnd;

- (NSString*)nameRangeEnd;
- (void)setNameRangeEnd :(NSString*)newNameRangeEnd;

@property (nonatomic,readwrite,assign,getter=nameRangeStart,setter=setNameRangeStart:) NSString* nameRangeStart;

- (NSString*)nameRangeStart;
- (void)setNameRangeStart :(NSString*)newNameRangeStart;

@property (nonatomic,readwrite,assign,getter=nameStartsWith,setter=setNameStartsWith:) NSString* nameStartsWith;

- (NSString*)nameStartsWith;
- (void)setNameStartsWith :(NSString*)newNameStartsWith;

@property (nonatomic,readwrite,assign,getter=paidStatus,setter=setPaidStatus:) int paidStatus;

- (int)paidStatus;
- (void)setPaidStatus :(int)newPaidStatus;

@property (nonatomic,readwrite,assign,getter=refNumber,setter=setRefNumber:) NSString* refNumber;

- (NSString*)refNumber;
- (void)setRefNumber :(NSString*)newRefNumber;

@property (nonatomic,readwrite,assign,getter=refNumberContains,setter=setRefNumberContains:) NSString* refNumberContains;

- (NSString*)refNumberContains;
- (void)setRefNumberContains :(NSString*)newRefNumberContains;

@property (nonatomic,readwrite,assign,getter=refNumberEndsWith,setter=setRefNumberEndsWith:) NSString* refNumberEndsWith;

- (NSString*)refNumberEndsWith;
- (void)setRefNumberEndsWith :(NSString*)newRefNumberEndsWith;

@property (nonatomic,readwrite,assign,getter=refNumberRangeEnd,setter=setRefNumberRangeEnd:) NSString* refNumberRangeEnd;

- (NSString*)refNumberRangeEnd;
- (void)setRefNumberRangeEnd :(NSString*)newRefNumberRangeEnd;

@property (nonatomic,readwrite,assign,getter=refNumberRangeStart,setter=setRefNumberRangeStart:) NSString* refNumberRangeStart;

- (NSString*)refNumberRangeStart;
- (void)setRefNumberRangeStart :(NSString*)newRefNumberRangeStart;

@property (nonatomic,readwrite,assign,getter=refNumberStartsWith,setter=setRefNumberStartsWith:) NSString* refNumberStartsWith;

- (NSString*)refNumberStartsWith;
- (void)setRefNumberStartsWith :(NSString*)newRefNumberStartsWith;

@property (nonatomic,readwrite,assign,getter=totalBalanceMaximum,setter=setTotalBalanceMaximum:) NSString* totalBalanceMaximum;

- (NSString*)totalBalanceMaximum;
- (void)setTotalBalanceMaximum :(NSString*)newTotalBalanceMaximum;

@property (nonatomic,readwrite,assign,getter=totalBalanceMinimum,setter=setTotalBalanceMinimum:) NSString* totalBalanceMinimum;

- (NSString*)totalBalanceMinimum;
- (void)setTotalBalanceMinimum :(NSString*)newTotalBalanceMinimum;

@property (nonatomic,readwrite,assign,getter=transactionDateEnd,setter=setTransactionDateEnd:) NSString* transactionDateEnd;

- (NSString*)transactionDateEnd;
- (void)setTransactionDateEnd :(NSString*)newTransactionDateEnd;

@property (nonatomic,readwrite,assign,getter=transactionDateStart,setter=setTransactionDateStart:) NSString* transactionDateStart;

- (NSString*)transactionDateStart;
- (void)setTransactionDateStart :(NSString*)newTransactionDateStart;

 

Default Value

""

Remarks

This property may be used to query QuickBooks for items supported by the QuickBooks SDK, but not by the component set.

The property should be set to the name of the object being queried for. A list of the objects supported for query operations by the SDK may be found in the SDK documentation.

When performing a special query the QueryType property should be set to qtOtherTransactionSearch or qtOtherListSearch, as appropriate. After searching, the QBObject class may be used to view and/or edit the results.

It is recommended that users using this property first read the SDK documentation.

SpecialQueryType Property (ObjSearch Module)

The special query type; for example ItemService.

Syntax

• Swift
• Objective-C

public var specialQueryType: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=specialQueryType,setter=setSpecialQueryType:) NSString* specialQueryType;

- (NSString*)specialQueryType;
- (void)setSpecialQueryType :(NSString*)newSpecialQueryType;

Default Value

""

Remarks

This property may be used to query QuickBooks for items supported by the QuickBooks SDK, but not by the component set.

The property should be set to the name of the object being queried for. A list of the objects supported for query operations by the SDK may be found in the SDK documentation.

When performing a special query the QueryType property should be set to qtOtherTransactionSearch or qtOtherListSearch, as appropriate. After searching, the QBObject class may be used to view and/or edit the results.

It is recommended that users using this property first read the SDK documentation.

CloseQBConnection Method (ObjSearch Module)

Closes a persistent connection to QuickBooks.

Syntax

• Swift
• Objective-C

public func closeQBConnection() throws -> Void

- (void)closeQBConnection;

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Config Method (ObjSearch Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetNextResults Method (ObjSearch Module)

Retrieves the next set of results (only applicable for iterative searches).

Syntax

• Swift
• Objective-C

public func getNextResults() throws -> Void

- (void)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:

class.QueryType = qtCustomerSearch class.MaxResults = 10 class.QBXMLVersion = "5.0" class.OpenQBConnection() class.Search() ' Process first set of results here While (class.RemainingResults > 0) class.GetNextResults() ' Process additional results here Wend class.CloseQBConnection()

Note that if you wish searches to operate the same way as they did with previous QBXMLVersions, you may set the IterateResults configuration setting to "False". See Config for more information.

ImportQBXML Method (ObjSearch Module)

Imports a QBXML response aggregate.

Syntax

• Swift
• Objective-C

public func importQBXML(xmlData: String) throws -> Void

- (void)importQBXML:(NSString*)XMLData;

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

OpenQBConnection Method (ObjSearch Module)

Opens a persistent connection to QuickBooks.

Syntax

• Swift
• Objective-C

public func openQBConnection() throws -> Void

- (void)openQBConnection;

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Reset Method (ObjSearch Module)

Resets all properties to their defaults.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

Search Method (ObjSearch Module)

Submits a query request to QuickBooks.

Syntax

• Swift
• Objective-C

public func search() throws -> Void

- (void)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 ResultsAggregate 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 Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (ObjSearch Module)

Shows the progress of the QuickBooks connection.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (ObjSearch Module)

Fired when a warning occurs.

Syntax

• Swift
• Objective-C

func onWarning(code: Int32, description: String)

- (void)onWarning:(int)code :(NSString*)description;

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

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

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

ObjSearchResult Type

Results of a search made with the OBJSEARCH component.

Remarks

This type contains a single result after issuing a search with the ObjSearch class. The field contains the XML result aggregate, which you may then pass to a corresponding class to parse.

Fields

Constructors

public init()

SearchCriteria Type

Criteria used to limit a search to specific set of transactions.

Remarks

This type is used by the ObjSearch class, and describes the transactions the user is looking for.

Fields

Constructors

public init()

Config Settings (ObjSearch Module)

Trappable Errors (ObjSearch Module)

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

ObjSearch Errors

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