QBConnector Class

Properties   Methods   Events   Config Settings   Errors  

The QBCONNECTOR class is a utility that allows you to connect your QuickBooks Integrator applications to remote QuickBooks instances.

Syntax

QBConnector

Remarks

The QBConnector class is a lightweight web server which listens for HTTP requests originating from the QuickBooks Integrator classs. Each request sent to the QBConnector by a QuickBooks Integrator class contains the XML data to be communicated to QuickBooks as well as configuration settings specifying how the connection is to be opened. The QBConnector then communicates with QuickBooks via COM, and returns the QuickBooks response (or an error message) in the HTTP reply.

Using the QBConnector class is easy. Simply set Listening to True, and the class will begin listening for incoming messages on the specified LocalPort. The messages will be processed by the QuickBooks application that is running on the same machine as the QBConnector, and the results will automatically be returned to the requesting client.

Basic authentication is enabled by default, meaning the connecting clients must present a user name and password in the QBConnectionString of the class they're using. The supplied user name and password are checked against the list of AuthorizedUsers. If no user in the list matches the supplied credentials, the Authorization event will fire with the Accept parameter set to false. If the user was found in the list of AuthorizedUsers then the parameter will be set to True. You may override this functionality by setting the Accept parameter inside the Authorization event manually. If no "Authorization" header supplied in the request, the Authorization event will fire with blank User and Password parameters.

Note that the QBConnectionString will be used to make the connection to QuickBooks for a user found in the AuthorizedUsers collection.

Any of the QuickBooks Integrator classs can connect to the QBConnector using the QBConnectionString property of any of the classs. For instance, an example using the Invoice class follows: Invoice.QBConnectionString = "URL='http://www.foo.com:2080'" User='Foo' Password='Bar'";

Using SSL along with a digital certificate greatly increases the security of the Remote Connector. SSL will encrypt all data transmitted across the network, ensuring that only the Connector can read incoming requests, and that only the requesting client can read the QuickBooks responses. This prevents unauthorized parties from accessing your QuickBooks data. You should use a full digital certificate on the server (Connector) side, and this will contain a public key and a private key. This version of your certificate should be kept private. You may export a version of the certificate containing the public key only, and distribute this to all clients that need to communicate with the Connector.

To use this functionality, set the SSLCert with a valid certificate and then change the SSLStartMode to sslImplicit. Now all clients must post to the QBConnector using HTTPS. eg: Invoice.QBConnectionString = "URL='https://www.foo.com:2080' User='Foo' Password='Bar'"; // https instead of http

The client (in these examples Invoice) has an SSLServerAuthentication event that will fire when the server presents its certificate. If the public key presented by the QBConnector is trusted by the system, the Accept parameter will be True. If it is not trusted by the system (Accept is False), you should inspect the certificate and if valid, override by setting Accept to True.

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.

AuthorizedUsers Property (QBConnector Class)

A list of clients allowed to connect to the server.

Syntax

• C++
• C
• Qt

InQBList<InQBAuthorizedUser>* GetAuthorizedUsers();
int SetAuthorizedUsers(InQBList<InQBAuthorizedUser>* val);

int inqb_qbconnector_getauthorizedusercount(void* lpObj);
int inqb_qbconnector_setauthorizedusercount(void* lpObj, int iAuthorizedUserCount);

int inqb_qbconnector_getauthorizedauthmode(void* lpObj, int authorizeduserindex);
int inqb_qbconnector_setauthorizedauthmode(void* lpObj, int authorizeduserindex, int iAuthorizedAuthMode);

char* inqb_qbconnector_getauthorizeduserpassword(void* lpObj, int authorizeduserindex);
int inqb_qbconnector_setauthorizeduserpassword(void* lpObj, int authorizeduserindex, const char* lpszAuthorizedUserPassword);

char* inqb_qbconnector_getauthorizeduserqbconnectionstring(void* lpObj, int authorizeduserindex);
int inqb_qbconnector_setauthorizeduserqbconnectionstring(void* lpObj, int authorizeduserindex, const char* lpszAuthorizedUserQBConnectionString);

char* inqb_qbconnector_getauthorizeduser(void* lpObj, int authorizeduserindex);
int inqb_qbconnector_setauthorizeduser(void* lpObj, int authorizeduserindex, const char* lpszAuthorizedUser);

int GetAuthorizedUserCount();
int SetAuthorizedUserCount(int iAuthorizedUserCount);

int GetAuthorizedAuthMode(int iAuthorizedUserIndex);
int SetAuthorizedAuthMode(int iAuthorizedUserIndex, int iAuthorizedAuthMode);

QString GetAuthorizedUserPassword(int iAuthorizedUserIndex);
int SetAuthorizedUserPassword(int iAuthorizedUserIndex, QString qsAuthorizedUserPassword);

QString GetAuthorizedUserQBConnectionString(int iAuthorizedUserIndex);
int SetAuthorizedUserQBConnectionString(int iAuthorizedUserIndex, QString qsAuthorizedUserQBConnectionString);

QString GetAuthorizedUser(int iAuthorizedUserIndex);
int SetAuthorizedUser(int iAuthorizedUserIndex, QString qsAuthorizedUser);

Remarks

The AuthorizedUsers property contains a list of clients allowed to connect to the QBConnector class. If the user name and password supplied in the HTTP authorization header must match the User and Password fields, the Authorization event will fire with the Accept parameter set to True. If the user cannot be found, or the password does not match, the Authorization event will fire with the Accept parameter set to False;. If a match is found, the class uses the information in the QBConnectionString to make a connection to QuickBooks.

Data Type

InQBAuthorizedUser

ConnectedToQB Property (QBConnector Class)

Opens or closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectedToQB();

Unicode (Windows)
BOOL GetConnectedToQB();

int inqb_qbconnector_getconnectedtoqb(void* lpObj);

bool GetConnectedToQB();

Default Value

FALSE

Remarks

You may use this property to determine whether the class is currently connected to QuickBooks.

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

Data Type

Boolean

EnableSSL Property (QBConnector Class)

Indicates whether server starts in SSL-mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEnableSSL();
int SetEnableSSL(int bEnableSSL);

Unicode (Windows)
BOOL GetEnableSSL();
INT SetEnableSSL(BOOL bEnableSSL);

int inqb_qbconnector_getenablessl(void* lpObj);
int inqb_qbconnector_setenablessl(void* lpObj, int bEnableSSL);

bool GetEnableSSL();
int SetEnableSSL(bool bEnableSSL);

Default Value

FALSE

Remarks

This property must be set before setting Listening to True. When EnableSSL is True, plaintext connections to the class will be rejected.

This property is not available at design time.

Data Type

Boolean

Listening Property (QBConnector Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();

int inqb_qbconnector_getlistening(void* lpObj);

bool GetListening();

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (QBConnector Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* inqb_qbconnector_getlocalhost(void* lpObj);
int inqb_qbconnector_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (QBConnector Class)

The TCP port in the local host where the class listens.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int inqb_qbconnector_getlocalport(void* lpObj);
int inqb_qbconnector_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

2080

Remarks

The LocalPort property must be set before QBConnector starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the LocalPort property after Listening is set to True.

The service port is not shared among servers (i.e. there can be only one QBConnector 'listening' on a particular port at one time).

The default value for LocalPort is 2080.

Data Type

Integer

SSLAuthenticateClients Property (QBConnector Class)

If set to True, the server asks the client(s) for a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int inqb_qbconnector_getsslauthenticateclients(void* lpObj);
int inqb_qbconnector_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

Default Value

FALSE

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCert Property (QBConnector Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

InQBCertificate* GetSSLCert();
int SetSSLCert(InQBCertificate* val);

char* inqb_qbconnector_getsslcerteffectivedate(void* lpObj);

char* inqb_qbconnector_getsslcertexpirationdate(void* lpObj);

char* inqb_qbconnector_getsslcertextendedkeyusage(void* lpObj);

char* inqb_qbconnector_getsslcertfingerprint(void* lpObj);

char* inqb_qbconnector_getsslcertfingerprintsha1(void* lpObj);

char* inqb_qbconnector_getsslcertfingerprintsha256(void* lpObj);

char* inqb_qbconnector_getsslcertissuer(void* lpObj);

char* inqb_qbconnector_getsslcertprivatekey(void* lpObj);

int inqb_qbconnector_getsslcertprivatekeyavailable(void* lpObj);

char* inqb_qbconnector_getsslcertprivatekeycontainer(void* lpObj);

char* inqb_qbconnector_getsslcertpublickey(void* lpObj);

char* inqb_qbconnector_getsslcertpublickeyalgorithm(void* lpObj);

int inqb_qbconnector_getsslcertpublickeylength(void* lpObj);

char* inqb_qbconnector_getsslcertserialnumber(void* lpObj);

char* inqb_qbconnector_getsslcertsignaturealgorithm(void* lpObj);

int inqb_qbconnector_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inqb_qbconnector_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* inqb_qbconnector_getsslcertstorepassword(void* lpObj);
int inqb_qbconnector_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int inqb_qbconnector_getsslcertstoretype(void* lpObj);
int inqb_qbconnector_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* inqb_qbconnector_getsslcertsubjectaltnames(void* lpObj);

char* inqb_qbconnector_getsslcertthumbprintmd5(void* lpObj);

char* inqb_qbconnector_getsslcertthumbprintsha1(void* lpObj);

char* inqb_qbconnector_getsslcertthumbprintsha256(void* lpObj);

char* inqb_qbconnector_getsslcertusage(void* lpObj);

int inqb_qbconnector_getsslcertusageflags(void* lpObj);

char* inqb_qbconnector_getsslcertversion(void* lpObj);

char* inqb_qbconnector_getsslcertsubject(void* lpObj);
int inqb_qbconnector_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int inqb_qbconnector_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inqb_qbconnector_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

InQBCertificate

SSLProvider Property (QBConnector Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int inqb_qbconnector_getsslprovider(void* lpObj);
int inqb_qbconnector_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

Timeout Property (QBConnector Class)

An initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int inqb_qbconnector_gettimeout(void* lpObj);
int inqb_qbconnector_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

Timeout is used by the class to set the operational timeout value of all inbound connections once they are established.

The default value is 30 seconds.

Data Type

Integer

AddUser Method (QBConnector Class)

Adds a new user to the AuthorizedUsers collection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUser(const char* lpszUser, const char* lpszPassword, const char* lpszQBConnectionString, int iAuthMode);

Unicode (Windows)
INT AddUser(LPCWSTR lpszUser, LPCWSTR lpszPassword, LPCWSTR lpszQBConnectionString, INT iAuthMode);

int inqb_qbconnector_adduser(void* lpObj, const char* lpszUser, const char* lpszPassword, const char* lpszQBConnectionString, int iAuthMode);

int AddUser(const QString& qsUser, const QString& qsPassword, const QString& qsQBConnectionString, int iAuthMode);

Remarks

Please refer to the AuthorizedUsers collection for more information.

User specifies the user which will be allowed to connect.

Password specifies the password of the user. This is not applicable when AuthMode is set to 1 (amWindows).

QBConnectionString sets the connection properties for the user. See QBConnectionString for details.

AuthMode defines how the user will be authenticated. There are two ways that the user may be authorized, against the user list defined in the class, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:

When using the amWindows AuthMode the class will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

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 (QBConnector 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_qbconnector_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.

DoEvents Method (QBConnector Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int inqb_qbconnector_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

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

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_qbconnector_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

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

Shutdown Method (QBConnector Class)

Shutdown the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int inqb_qbconnector_shutdown(void* lpObj);

int Shutdown();

Remarks

When this method is called, the class will stop Listening, break all active connections, and disconnect from QuickBooks.

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

Authorization Event (QBConnector Class)

Fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAuthorization(QBConnectorAuthorizationEventParams *e);

typedef struct {
  int ConnectionId;
  int UserIndex;
  const char *User;
  const char *Password;
  int Accept;
  int reserved;
} QBConnectorAuthorizationEventParams;


Unicode (Windows)
virtual INT FireAuthorization(QBConnectorAuthorizationEventParams *e);

typedef struct {
  INT ConnectionId;
  INT UserIndex;
  LPCWSTR User;
  LPCWSTR Password;
  BOOL Accept;
  INT reserved;
} QBConnectorAuthorizationEventParams;

#define EID_QBCONNECTOR_AUTHORIZATION 1

virtual INT INQB_CALL FireAuthorization(INT &iConnectionId, INT &iUserIndex, LPSTR &lpszUser, LPSTR &lpszPassword, BOOL &bAccept);

class QBConnectorAuthorizationEventParams {
public:
  int ConnectionId();

  int UserIndex();

  const QString &User();

  const QString &Password();

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

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireAuthorization(QBConnectorAuthorizationEventParams *e) {...}

Remarks

This is where the server can decide whether to continue or not, based on the supplied User and Password.

To accept or reject a connection set Accept to True of False.

The Accept parameter defaults to True if User is found in the AuthorizedUsers collection and Password matches, and False otherwise. The UserIndex parameter indicates the index at which the authorized user was found in the collection.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Connected Event (QBConnector Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(QBConnectorConnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} QBConnectorConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(QBConnectorConnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} QBConnectorConnectedEventParams;

#define EID_QBCONNECTOR_CONNECTED 2

virtual INT INQB_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class QBConnectorConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireConnected(QBConnectorConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (QBConnector Class)

This event is fired when a request for connection comes from a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(QBConnectorConnectionRequestEventParams *e);

typedef struct {
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} QBConnectorConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(QBConnectorConnectionRequestEventParams *e);

typedef struct {
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} QBConnectorConnectionRequestEventParams;

#define EID_QBCONNECTOR_CONNECTIONREQUEST 3

virtual INT INQB_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class QBConnectorConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

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

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireConnectionRequest(QBConnectorConnectionRequestEventParams *e) {...}

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (QBConnector Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(QBConnectorDisconnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} QBConnectorDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(QBConnectorDisconnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} QBConnectorDisconnectedEventParams;

#define EID_QBCONNECTOR_DISCONNECTED 4

virtual INT INQB_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class QBConnectorDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireDisconnected(QBConnectorDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (QBConnector Class)

This event fires information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} QBConnectorErrorEventParams;

#define EID_QBCONNECTOR_ERROR 5

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

class QBConnectorErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.

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.

ConnectionId indicates the connection for which the error is applicable.

Header Event (QBConnector Class)

HTTP headers sent by the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(QBConnectorHeaderEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Header;
  const char *Value;
  int reserved;
} QBConnectorHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(QBConnectorHeaderEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Header;
  LPCWSTR Value;
  INT reserved;
} QBConnectorHeaderEventParams;

#define EID_QBCONNECTOR_HEADER 6

virtual INT INQB_CALL FireHeader(INT &iConnectionId, LPSTR &lpszHeader, LPSTR &lpszValue);

class QBConnectorHeaderEventParams {
public:
  int ConnectionId();

  const QString &Header();

  const QString &Value();

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireHeader(QBConnectorHeaderEventParams *e) {...}

Remarks

When a client connects, this event will fire for each HTTP header received.

Request Event (QBConnector Class)

Fired when a client sends a request to the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRequest(QBConnectorRequestEventParams *e);

typedef struct {
  int ConnectionId;
  int UserIndex;
  const char *Request;
  int reserved;
} QBConnectorRequestEventParams;


Unicode (Windows)
virtual INT FireRequest(QBConnectorRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  INT UserIndex;
  LPCWSTR Request;
  INT reserved;
} QBConnectorRequestEventParams;

#define EID_QBCONNECTOR_REQUEST 7

virtual INT INQB_CALL FireRequest(INT &iConnectionId, INT &iUserIndex, LPSTR &lpszRequest);

class QBConnectorRequestEventParams {
public:
  int ConnectionId();

  int UserIndex();

  const QString &Request();

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireRequest(QBConnectorRequestEventParams *e) {...}

Remarks

This event will fire with the raw XML data received from the client, which is to be processed by QuickBooks.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the User array property. Request is the QBXML Request sent from the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Response Event (QBConnector Class)

Fired when the class sends a response to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResponse(QBConnectorResponseEventParams *e);

typedef struct {
  int ConnectionId;
  int UserIndex;
  const char *Response;
  int reserved;
} QBConnectorResponseEventParams;


Unicode (Windows)
virtual INT FireResponse(QBConnectorResponseEventParams *e);

typedef struct {
  INT ConnectionId;
  INT UserIndex;
  LPCWSTR Response;
  INT reserved;
} QBConnectorResponseEventParams;

#define EID_QBCONNECTOR_RESPONSE 8

virtual INT INQB_CALL FireResponse(INT &iConnectionId, INT &iUserIndex, LPSTR &lpszResponse);

class QBConnectorResponseEventParams {
public:
  int ConnectionId();

  int UserIndex();

  const QString &Response();

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireResponse(QBConnectorResponseEventParams *e) {...}

Remarks

This event will fire with the raw XML retrieved from QuickBooks and sent to the client.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the User array property. Response is the QBXML Response from QuickBooks, which is being transmitted back to the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

SSLClientAuthentication Event (QBConnector Class)

This event is fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(QBConnectorSSLClientAuthenticationEventParams *e);

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


Unicode (Windows)
virtual INT FireSSLClientAuthentication(QBConnectorSSLClientAuthenticationEventParams *e);

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

#define EID_QBCONNECTOR_SSLCLIENTAUTHENTICATION 9

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

class QBConnectorSSLClientAuthenticationEventParams {
public:
  int ConnectionId();

  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 SSLClientAuthentication(QBConnectorSSLClientAuthenticationEventParams *e);

// Or, subclass QBConnector and override this emitter function.
virtual int FireSSLClientAuthentication(QBConnectorSSLClientAuthenticationEventParams *e) {...}

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (QBConnector Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLConnectionRequest(QBConnectorSSLConnectionRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *SupportedCipherSuites;
  const char *SupportedSignatureAlgs;
  int CertStoreType;
  char *CertStore;
  char *CertPassword;
  char *CertSubject;
  int reserved;
} QBConnectorSSLConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireSSLConnectionRequest(QBConnectorSSLConnectionRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR SupportedCipherSuites;
  LPCWSTR SupportedSignatureAlgs;
  INT CertStoreType;
  LPWSTR CertStore;
  LPWSTR CertPassword;
  LPWSTR CertSubject;
  INT reserved;
} QBConnectorSSLConnectionRequestEventParams;

#define EID_QBCONNECTOR_SSLCONNECTIONREQUEST 10

virtual INT INQB_CALL FireSSLConnectionRequest(INT &iConnectionId, LPSTR &lpszSupportedCipherSuites, LPSTR &lpszSupportedSignatureAlgs, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);

class QBConnectorSSLConnectionRequestEventParams {
public:
  int ConnectionId();

  const QString &SupportedCipherSuites();

  const QString &SupportedSignatureAlgs();

  int CertStoreType();
  void SetCertStoreType(int iCertStoreType);

  const QString &CertStore();
  void SetCertStore(const QString &qsCertStore);

  const QString &CertPassword();
  void SetCertPassword(const QString &qsCertPassword);

  const QString &CertSubject();
  void SetCertSubject(const QString &qsCertSubject);

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

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

// Or, subclass QBConnector and override this emitter function.
virtual int FireSSLConnectionRequest(QBConnectorSSLConnectionRequestEventParams *e) {...}

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLStatus Event (QBConnector Class)

This event is fired to show the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} QBConnectorSSLStatusEventParams;


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

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} QBConnectorSSLStatusEventParams;

#define EID_QBCONNECTOR_SSLSTATUS 11

virtual INT INQB_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);

class QBConnectorSSLStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

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

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

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

Remarks

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

Status Event (QBConnector Class)

Shows the status of the server as clients connect and transactions are made.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} QBConnectorStatusEventParams;


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

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} QBConnectorStatusEventParams;

#define EID_QBCONNECTOR_STATUS 12

virtual INT INQB_CALL FireStatus(INT &iConnectionId, LPSTR &lpszMessage);

class QBConnectorStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

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

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

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

Remarks

The event is fired for informational and logging purposes only.

AuthorizedUser Type

Client login, password, and QuickBooks connection information.

Syntax

InQBAuthorizedUser (declared in inqb.h)

Remarks

The AuthorizedUser type contains the User and Password of a client that is allowed to connect to the QBConnector class. When a client connects, the user name and password supplied in the HTTP authorization header are compared to the credentials of each authorized user. If a match is found, the class uses the information in the QBConnectionString to make a connection to QuickBooks.

• AuthMode
• Password
• QBConnectionString
• User

Fields

Constructors

AuthorizedUser()

AuthorizedUser(const char* lpszUser, const char* lpszPassword)

AuthorizedUser(const char* lpszUser, const char* lpszPassword, const char* lpszQBConnectionString)

AuthorizedUser(const char* lpszUser, const char* lpszPassword, const char* lpszQBConnectionString, int iAuthMode)

Certificate Type

This is the digital certificate being used.

Syntax

InQBCertificate (declared in inqb.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

InQBList Type

Syntax

InQBList<T> (declared in inqb.h)

Remarks

InQBList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the QBConnector class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (QBConnector Class)

QBConnector Config Settings

Base Config Settings

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

QBConnector Errors

SSL Errors

TCP/IP Errors