Company Class

Properties   Methods   Events   Config Settings   Errors  

The Company class is used to retrieve information about the QuickBooks company.

Syntax

Company

Remarks

To retrieve information about the QuickBooks company, simply invoke Get. A variety of information will be returned, and may be accessed via read-only properties such as CompanyName, Address, etc. Note that the class allows only read-only access to company information; any changes must be done from within the QuickBooks UI.

The QuickBooks connection may be configured as with other classs in the package.

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.

Address Property (Company Class)

Company address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddress();

Unicode (Windows)
LPWSTR GetAddress();

char* inqb_company_getaddress(void* lpObj);

QString GetAddress();

Default Value

""

Remarks

The address of the QuickBooks company.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

Data Type

String

CompanyName Property (Company Class)

Company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompanyName();

Unicode (Windows)
LPWSTR GetCompanyName();

char* inqb_company_getcompanyname(void* lpObj);

QString GetCompanyName();

Default Value

""

Remarks

The name of the QuickBooks company.

This property is read-only.

Data Type

String

CompanyType Property (Company Class)

The type of company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompanyType();

Unicode (Windows)
LPWSTR GetCompanyType();

char* inqb_company_getcompanytype(void* lpObj);

QString GetCompanyType();

Default Value

""

Remarks

The type of company, as originally chosen by the QuickBooks user.

This property is read-only.

Data Type

String

EIN Property (Company Class)

The EIN of the company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEIN();

Unicode (Windows)
LPWSTR GetEIN();

char* inqb_company_getein(void* lpObj);

QString GetEIN();

Default Value

""

Remarks

The EIN (Employer Identification Number) of the company.

To retrieve this property, you must set QBXMLVersion to "2.0" or greater.

This property is read-only.

Data Type

String

Email Property (Company Class)

Company email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEmail();

Unicode (Windows)
LPWSTR GetEmail();

char* inqb_company_getemail(void* lpObj);

QString GetEmail();

Default Value

""

Remarks

The email address of the QuickBooks company.

This property is read-only.

Data Type

String

Fax Property (Company Class)

Company fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFax();

Unicode (Windows)
LPWSTR GetFax();

char* inqb_company_getfax(void* lpObj);

QString GetFax();

Default Value

""

Remarks

The fax number of the QuickBooks company.

This property is read-only.

Data Type

String

FileId Property (Company Class)

Identifies a company file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileId();

Unicode (Windows)
LPWSTR GetFileId();

char* inqb_company_getfileid(void* lpObj);

QString GetFileId();

Default Value

""

Remarks

This property will be populated after a call to Get if OwnerId was specified in the request.

This is commonly used to identify if the company file has previously been accessed by your application identified by OwnerId.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} where X is a hexadecimal digit. For example: {6B063959-81B0-4622-85D6-F548C8CCB517}

This property is read-only.

Data Type

String

FirstMonthFiscal Property (Company Class)

The first month in the company's fiscal year.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirstMonthFiscal();

Unicode (Windows)
LPWSTR GetFirstMonthFiscal();

char* inqb_company_getfirstmonthfiscal(void* lpObj);

QString GetFirstMonthFiscal();

Default Value

""

Remarks

The first month in the company's fiscal year. Will be the name of the month (i.e., "January", "February", etc.)

This property is read-only.

Data Type

String

FirstMonthTax Property (Company Class)

The first month in the company's tax year.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirstMonthTax();

Unicode (Windows)
LPWSTR GetFirstMonthTax();

char* inqb_company_getfirstmonthtax(void* lpObj);

QString GetFirstMonthTax();

Default Value

""

Remarks

The first month in the company's tax year. Will be the name of the month (i.e., "January", "February", etc.)

This property is read-only.

Data Type

String

LegalAddress Property (Company Class)

Legal company address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLegalAddress();

Unicode (Windows)
LPWSTR GetLegalAddress();

char* inqb_company_getlegaladdress(void* lpObj);

QString GetLegalAddress();

Default Value

""

Remarks

The legal address of the QuickBooks company.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

Data Type

String

LegalName Property (Company Class)

Legal company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLegalName();

Unicode (Windows)
LPWSTR GetLegalName();

char* inqb_company_getlegalname(void* lpObj);

QString GetLegalName();

Default Value

""

Remarks

The legal name of the QuickBooks company.

This property is read-only.

Data Type

String

OwnerId Property (Company Class)

The Id of an application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOwnerId();
int SetOwnerId(const char* lpszOwnerId);

Unicode (Windows)
LPWSTR GetOwnerId();
INT SetOwnerId(LPCWSTR lpszOwnerId);

char* inqb_company_getownerid(void* lpObj);
int inqb_company_setownerid(void* lpObj, const char* lpszOwnerId);

QString GetOwnerId();
int SetOwnerId(QString qsOwnerId);

Default Value

""

Remarks

This property specifies the Id of an application. It is commonly used in conjunction with the QBWCServer class to check if the application has previously communicated with the specified company file in the past.

If this property is set before calling Get, QuickBooks will return a value for FileId (if one exists). This can be compared to a known FileId value to determine if your application has previously worked with this file.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} where X is a hexadecimal digit. For example: {6B063959-81B0-4622-85D6-F548C8CCB517}

Data Type

String

Phone Property (Company Class)

Company phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPhone();

Unicode (Windows)
LPWSTR GetPhone();

char* inqb_company_getphone(void* lpObj);

QString GetPhone();

Default Value

""

Remarks

The phone number of the QuickBooks company.

This property is read-only.

Data Type

String

QBConnectionString Property (Company 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_company_getqbconnectionstring(void* lpObj);
int inqb_company_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 (Company 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_company_getqbrequestaggregate(void* lpObj);
int inqb_company_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

QBRequestMode Property (Company 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_company_getqbrequestmode(void* lpObj);
int inqb_company_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 (Company 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_company_getqbresponseaggregate(void* lpObj);
int inqb_company_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 (Company 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_company_getqbxmlversion(void* lpObj);
int inqb_company_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

ServiceCount Property (Company Class)

The number of records in the Service arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServiceCount();

Unicode (Windows)
INT GetServiceCount();

int inqb_company_getservicecount(void* lpObj);

int GetServiceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceDomain
• ServiceName
• ServiceStatus

The array indices start at 0 and end at ServiceCount - 1.

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

Data Type

Integer

ServiceDomain Property (Company Class)

Indicates the provider of the service that the company is (or has been) subscribed to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceDomain(int iServiceIndex);

Unicode (Windows)
LPWSTR GetServiceDomain(INT iServiceIndex);

char* inqb_company_getservicedomain(void* lpObj, int serviceindex);

QString GetServiceDomain(int iServiceIndex);

Default Value

""

Remarks

Indicates the provider of the service that the company is (or has been) subscribed to. For example: "Intuit".

The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

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

Data Type

String

ServiceName Property (Company Class)

The name of the Intuit service that the company is (or has been) subscribed to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceName(int iServiceIndex);

Unicode (Windows)
LPWSTR GetServiceName(INT iServiceIndex);

char* inqb_company_getservicename(void* lpObj, int serviceindex);

QString GetServiceName(int iServiceIndex);

Default Value

""

Remarks

The name of the Intuit service that the company is (or has been) subscribed to.

The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

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

Data Type

String

ServiceStatus Property (Company Class)

The status of the Intuit service that the company is (or has been) subscribed to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceStatus(int iServiceIndex);

Unicode (Windows)
LPWSTR GetServiceStatus(INT iServiceIndex);

char* inqb_company_getservicestatus(void* lpObj, int serviceindex);

QString GetServiceStatus(int iServiceIndex);

Default Value

""

Remarks

The status of the Intuit service that the company is (or has been) subscribed to.

The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

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

Data Type

String

ShipToAddress Property (Company Class)

Company shipping address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipToAddress();

Unicode (Windows)
LPWSTR GetShipToAddress();

char* inqb_company_getshiptoaddress(void* lpObj);

QString GetShipToAddress();

Default Value

""

Remarks

The shipping address of the QuickBooks company (as it will appear on purchase orders).

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

Data Type

String

SSN Property (Company Class)

The SSN of the company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSN();

Unicode (Windows)
LPWSTR GetSSN();

char* inqb_company_getssn(void* lpObj);

QString GetSSN();

Default Value

""

Remarks

The Social Security Number, used if no EIN has been issued by the government.

To retrieve this property, you must set QBXMLVersion to "2.1" or greater.

This property is read-only.

Data Type

String

TaxForm Property (Company Class)

The tax form used by the company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxForm();

Unicode (Windows)
LPWSTR GetTaxForm();

char* inqb_company_gettaxform(void* lpObj);

QString GetTaxForm();

Default Value

""

Remarks

The tax form used by the company. Will be one of the following values: "Form1120", "Form1120S", "Form1065", "Form990", "Form990PF", "Form990T", "Form1040", "OtherOrNone".

To retrieve this property, you must set QBXMLVersion to "2.1" or greater.

This property is read-only.

Data Type

String

Website Property (Company Class)

Company website URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWebsite();

Unicode (Windows)
LPWSTR GetWebsite();

char* inqb_company_getwebsite(void* lpObj);

QString GetWebsite();

Default Value

""

Remarks

The web URL of the QuickBooks company.

This property is read-only.

Data Type

String

Config Method (Company 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_company_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.

Get Method (Company Class)

Gets the company information from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get();

Unicode (Windows)
INT Get();

int inqb_company_get(void* lpObj);

int Get();

Remarks

When you invoke Get, the class will get the company information from QuickBooks, using the connection information provided in QBConnectionString, QBXMLVersion, and elsewhere. When the method returns you may retrieve the appropriate information from the relevant properties.

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

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_COMPANY_ERROR 1

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

class CompanyErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass Company and override this emitter function.
virtual int FireError(CompanyErrorEventParams *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 (Company Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_COMPANY_SSLSERVERAUTHENTICATION 2

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

class CompanySSLServerAuthenticationEventParams {
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(CompanySSLServerAuthenticationEventParams *e);

// Or, subclass Company and override this emitter function.
virtual int FireSSLServerAuthentication(CompanySSLServerAuthenticationEventParams *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 (Company Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_COMPANY_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (Company Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_COMPANY_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Warning Event (Company Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_COMPANY_WARNING 5

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

class CompanyWarningEventParams {
public:
  int Code();

  const QString &Description();

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

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

// Or, subclass Company and override this emitter function.
virtual int FireWarning(CompanyWarningEventParams *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 (Company Class)

Trappable Errors (Company 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.

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