Account Class

Properties   Methods   Events   Config Settings   Errors  

The Account class manages QuickBooks accounts.

Syntax

Account

Remarks

The Account class is used to represent QuickBooks accounts (such as Checking, Accounts Receivable, etc.)

Required Fields (Add): AccountName, AccountType

Supported Methods: Add, Get (Id/Name), Update, Delete

Example (Adding an account to QuickBooks) Account1.AccountName = "QuickBooks Consulting" Account1.AccountType = atIncome Account1.Add() When adding an account to QuickBooks, the important properties are AccountName and AccountType. If desired, you may specify additional information such as Parent*, IsActive, AccountNumber, BankNumber, and Description. You may also specify an opening balance by setting OpeningBalance and OpeningBalanceDate.

When retrieving account information from QuickBooks you may also retrieve the current Balance. A variety of additional information about the account is available by calling Config.

Property List

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

Method List

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

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.

Config Settings

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

AccountName Property (Account Class)

Account's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountName();
int SetAccountName(const char* lpszAccountName);

Unicode (Windows)
LPWSTR GetAccountName();
INT SetAccountName(LPCWSTR lpszAccountName);

char* inqb_account_getaccountname(void* lpObj);
int inqb_account_setaccountname(void* lpObj, const char* lpszAccountName);

QString GetAccountName();
int SetAccountName(QString qsAccountName);

Default Value

""

Remarks

The account's name.

In Account objects that are sub-accounts or jobs the AccountName will be different from the FullName. The FullName may be formed by combining AccountName with the names of all ancestors, and separating with a colon: for example, "Parent Account:Child Account".

FullName is also available as a special field, and may be accessed via Config.

This property is required.

Data Type

String

AccountNumber Property (Account Class)

Account number for this account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountNumber();
int SetAccountNumber(const char* lpszAccountNumber);

Unicode (Windows)
LPWSTR GetAccountNumber();
INT SetAccountNumber(LPCWSTR lpszAccountNumber);

char* inqb_account_getaccountnumber(void* lpObj);
int inqb_account_setaccountnumber(void* lpObj, const char* lpszAccountNumber);

QString GetAccountNumber();
int SetAccountNumber(QString qsAccountNumber);

Default Value

""

Remarks

The account number for this account. It will show up if you select the "Use Account Numbers" configuration option from within QuickBooks.

Data Type

String

AccountType Property (Account Class)

The type of account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccountType();
int SetAccountType(int iAccountType);

Unicode (Windows)
INT GetAccountType();
INT SetAccountType(INT iAccountType);

AT_UNSPECIFIED(0), 
AT_ACCOUNTS_PAYABLE(1), 
AT_ACCOUNTS_RECEIVABLE(2), 
AT_BANK(3), 
AT_COST_OF_GOODS_SOLD(4), 
AT_CREDIT_CARD(5), 
AT_EQUITY(6), 
AT_EXPENSE(7), 
AT_FIXED_ASSET(8), 
AT_INCOME(9), 
AT_LONG_TERM_LIABILITY(10), 
AT_OTHER_ASSET(11), 
AT_OTHER_CURRENT_ASSET(12), 
AT_OTHER_CURRENT_LIABILITY(13), 
AT_OTHER_EXPENSE(14), 
AT_OTHER_INCOME(15), 
AT_NON_POSTING(16)

int inqb_account_getaccounttype(void* lpObj);
int inqb_account_setaccounttype(void* lpObj, int iAccountType);

int GetAccountType();
int SetAccountType(int iAccountType);

Default Value

0

Remarks

The type of account. You must set this property (to something other than atUnspecified) before adding an account to QuickBooks.

Note that you may not create accounts of type atNonPosting through the SDK.

The following values are permitted:

Data Type

Integer

Balance Property (Account Class)

The balance of this account, including sub-accounts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalance();

Unicode (Windows)
LPWSTR GetBalance();

char* inqb_account_getbalance(void* lpObj);

QString GetBalance();

Default Value

""

Remarks

The balance of this account, which may be positive or negative. The interpretation of the sign is dependent on AccountType.

The NonInclusiveBalance special field provides the balance with sub-accounts excluded.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

BankNumber Property (Account Class)

Bank account number for this account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankNumber();
int SetBankNumber(const char* lpszBankNumber);

Unicode (Windows)
LPWSTR GetBankNumber();
INT SetBankNumber(LPCWSTR lpszBankNumber);

char* inqb_account_getbanknumber(void* lpObj);
int inqb_account_setbanknumber(void* lpObj, const char* lpszBankNumber);

QString GetBankNumber();
int SetBankNumber(QString qsBankNumber);

Default Value

""

Remarks

The bank account number for this account (or an identifying note).

Note that this is considered sensitive data. It may always be specified when adding data to QuickBooks. When retrieving data from QuickBooks, it will only be returned if QBXMLVersion is set to at least "2.0", and only if you have granted integrated applications permission to access sensitive data from within QuickBooks.

Data Type

String

Description Property (Account Class)

Description for this account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDescription();
int SetDescription(const char* lpszDescription);

Unicode (Windows)
LPWSTR GetDescription();
INT SetDescription(LPCWSTR lpszDescription);

char* inqb_account_getdescription(void* lpObj);
int inqb_account_setdescription(void* lpObj, const char* lpszDescription);

QString GetDescription();
int SetDescription(QString qsDescription);

Default Value

""

Remarks

A textual description for this account.

Data Type

String

IsActive Property (Account Class)

Whether or not entity is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsActive();
int SetIsActive(int bIsActive);

Unicode (Windows)
BOOL GetIsActive();
INT SetIsActive(BOOL bIsActive);

int inqb_account_getisactive(void* lpObj);
int inqb_account_setisactive(void* lpObj, int bIsActive);

bool GetIsActive();
int SetIsActive(bool bIsActive);

Default Value

TRUE

Remarks

This property indicates whether this object is currently enabled for use by QuickBooks.

This property is allowed in Add operations, and the QBXMLVersion must be set to "3.0" or higher for this to be used in Update operations.

Data Type

Boolean

OpeningBalance Property (Account Class)

The opening balance of this account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOpeningBalance();
int SetOpeningBalance(const char* lpszOpeningBalance);

Unicode (Windows)
LPWSTR GetOpeningBalance();
INT SetOpeningBalance(LPCWSTR lpszOpeningBalance);

char* inqb_account_getopeningbalance(void* lpObj);
int inqb_account_setopeningbalance(void* lpObj, const char* lpszOpeningBalance);

QString GetOpeningBalance();
int SetOpeningBalance(QString qsOpeningBalance);

Default Value

""

Remarks

The opening balance of this account (by default zero). Note that this property is only used when adding new accounts to QuickBooks, and will not be returned when retrieving account information from QuickBooks.

The amount should be formatted as a string in dollars.

Data Type

String

OpeningBalanceDate Property (Account Class)

The opening balance date of this account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOpeningBalanceDate();
int SetOpeningBalanceDate(const char* lpszOpeningBalanceDate);

Unicode (Windows)
LPWSTR GetOpeningBalanceDate();
INT SetOpeningBalanceDate(LPCWSTR lpszOpeningBalanceDate);

char* inqb_account_getopeningbalancedate(void* lpObj);
int inqb_account_setopeningbalancedate(void* lpObj, const char* lpszOpeningBalanceDate);

QString GetOpeningBalanceDate();
int SetOpeningBalanceDate(QString qsOpeningBalanceDate);

Default Value

""

Remarks

The opening balance date of this account. Note that this property is only used when adding new accounts to QuickBooks, and will not be returned when retrieving account information from QuickBooks.

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.

Data Type

String

ParentId Property (Account Class)

Reference to parent Account .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParentId();
int SetParentId(const char* lpszParentId);

Unicode (Windows)
LPWSTR GetParentId();
INT SetParentId(LPCWSTR lpszParentId);

char* inqb_account_getparentid(void* lpObj);
int inqb_account_setparentid(void* lpObj, const char* lpszParentId);

QString GetParentId();
int SetParentId(QString qsParentId);

Default Value

""

Remarks

This is a reference to a parent Account. If Parent is set to a nonempty string, then this Account is a sub-account or job of its Parent.

Data Type

String

ParentName Property (Account Class)

Reference to parent Account .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParentName();
int SetParentName(const char* lpszParentName);

Unicode (Windows)
LPWSTR GetParentName();
INT SetParentName(LPCWSTR lpszParentName);

char* inqb_account_getparentname(void* lpObj);
int inqb_account_setparentname(void* lpObj, const char* lpszParentName);

QString GetParentName();
int SetParentName(QString qsParentName);

Default Value

""

Remarks

This is a reference to a parent Account. If Parent is set to a nonempty string, then this Account is a sub-account its Parent.

Data Type

String

QBConnectionString Property (Account Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString);

Unicode (Windows)
LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);

char* inqb_account_getqbconnectionstring(void* lpObj);
int inqb_account_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);

QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);

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:

Data Type

String

QBRequestAggregate Property (Account Class)

The request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate);

Unicode (Windows)
LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);

char* inqb_account_getqbrequestaggregate(void* lpObj);
int inqb_account_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);

QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);

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.

This property is not available at design time.

Data Type

String

QBRequestId Property (Account Class)

The Id of the next message to be sent to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestId();
int SetQBRequestId(const char* lpszQBRequestId);

Unicode (Windows)
LPWSTR GetQBRequestId();
INT SetQBRequestId(LPCWSTR lpszQBRequestId);

char* inqb_account_getqbrequestid(void* lpObj);
int inqb_account_setqbrequestid(void* lpObj, const char* lpszQBRequestId);

QString GetQBRequestId();
int SetQBRequestId(QString qsQBRequestId);

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (Account Class)

Defines whether the request is made online or stored offline.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Unicode (Windows)
INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);

RM_ONLINE(0), 
RM_OFFLINE(1)

int inqb_account_getqbrequestmode(void* lpObj);
int inqb_account_setqbrequestmode(void* lpObj, int iQBRequestMode);

int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

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.

Data Type

Integer

QBResponseAggregate Property (Account Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate);

Unicode (Windows)
LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);

char* inqb_account_getqbresponseaggregate(void* lpObj);
int inqb_account_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);

QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);

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.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (Account Class)

The version of QBXML used in the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion);

Unicode (Windows)
LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);

char* inqb_account_getqbxmlversion(void* lpObj);
int inqb_account_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);

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.

This property is not available at design time.

Data Type

String

RefId Property (Account Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_account_getrefid(void* lpObj);

QString GetRefId();

Default Value

""

Remarks

A RefId is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is required in Update operations, and not used in Add operations.

This property is read-only and not available at design time.

Data Type

String

Add Method (Account Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_account_add(void* lpObj);

int Add();

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckRequestStatus Method (Account Class)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CheckRequestStatus(const char* lpszRequestId);

Unicode (Windows)
LPWSTR CheckRequestStatus(LPCWSTR lpszRequestId);

char* inqb_account_checkrequeststatus(void* lpObj, const char* lpszRequestId);

QString CheckRequestStatus(const QString& qsRequestId);

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CloseQBConnection Method (Account Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_account_closeqbconnection(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Account Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_account_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (Account Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_account_delete(void* lpObj);

int Delete();

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Get Method (Account Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get(const char* lpszId);

Unicode (Windows)
INT Get(LPCWSTR lpszId);

int inqb_account_get(void* lpObj, const char* lpszId);

int Get(const QString& qsId);

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any class, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetByName Method (Account Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetByName(const char* lpszFullName);

Unicode (Windows)
INT GetByName(LPCWSTR lpszFullName);

int inqb_account_getbyname(void* lpObj, const char* lpszFullName);

int GetByName(const QString& qsFullName);

Remarks

GetByName may be used to retrieve a single object from QuickBooks, based on its full Name. For Employee and Vendor objects, and for most Customer objects, the full name is given by the Name (CustomerName, VendorName, or EmployeeName property. For Customer objects that represent jobs or sub-customers, the full name will include the parent objects' name(s), and is given by the FullName special field. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The full name of any class may be used for the parameter. So, for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.GetByName( Invoice.CustomerName )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose name is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportQBXML Method (Account Class)

Imports a QBXML response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportQBXML(const char* lpszXMLData);

Unicode (Windows)
INT ImportQBXML(LPCWSTR lpszXMLData);

int inqb_account_importqbxml(void* lpObj, const char* lpszXMLData);

int ImportQBXML(const QString& qsXMLData);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OpenQBConnection Method (Account Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_account_openqbconnection(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Account Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_account_reset(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Update Method (Account Class)

Updates the account in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_account_update(void* lpObj);

int Update();

Remarks

This method will account the bill in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The account will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "6.0" or greater to update an account. Moreover, QBXMLVersion should be set to the same value when retrieving the account from QuickBooks (either through ObjSearch or through the Get method).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (Account Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AccountErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AccountErrorEventParams;


Unicode (Windows)
virtual INT FireError(AccountErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AccountErrorEventParams;

#define EID_ACCOUNT_ERROR 1

virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AccountErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AccountErrorEventParams *e);

// Or, subclass Account and override this emitter function.
virtual int FireError(AccountErrorEventParams *e) {...}

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 (Account Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AccountSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AccountSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AccountSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AccountSSLServerAuthenticationEventParams;

#define EID_ACCOUNT_SSLSERVERAUTHENTICATION 2

virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AccountSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AccountSSLServerAuthenticationEventParams *e);

// Or, subclass Account and override this emitter function.
virtual int FireSSLServerAuthentication(AccountSSLServerAuthenticationEventParams *e) {...}

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 (Account Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AccountSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AccountSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AccountSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AccountSSLStatusEventParams;

#define EID_ACCOUNT_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

class AccountSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AccountSSLStatusEventParams *e);

// Or, subclass Account and override this emitter function.
virtual int FireSSLStatus(AccountSSLStatusEventParams *e) {...}

Remarks

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

Status Event (Account Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(AccountStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AccountStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(AccountStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AccountStatusEventParams;

#define EID_ACCOUNT_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

class AccountStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(AccountStatusEventParams *e);

// Or, subclass Account and override this emitter function.
virtual int FireStatus(AccountStatusEventParams *e) {...}

Remarks

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

Warning Event (Account Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(AccountWarningEventParams *e);

typedef struct {
  int Code;
  const char *Description;
  int reserved;
} AccountWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(AccountWarningEventParams *e);

typedef struct {
  INT Code;
  LPCWSTR Description;
  INT reserved;
} AccountWarningEventParams;

#define EID_ACCOUNT_WARNING 5

virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);

class AccountWarningEventParams {
public:
  int Code();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Warning(AccountWarningEventParams *e);

// Or, subclass Account and override this emitter function.
virtual int FireWarning(AccountWarningEventParams *e) {...}

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.

Config Settings (Account Class)

Trappable Errors (Account Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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.

Account 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.