QBConnector Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPayments.InQB.Qbconnector

Remarks

The QBConnector component is a lightweight web server which listens for HTTP requests originating from the QuickBooks Integrator components. Each request sent to the QBConnector by a QuickBooks Integrator component 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 component is easy. Simply set Listening to True, and the component 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 component 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 components can connect to the QBConnector using the QBConnectionString property of any of the components. For instance, an example using the Invoice component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AuthorizedUsers Property (QBConnector Component)

A list of clients allowed to connect to the server.

Syntax

• C#
• VB.NET

public AuthorizedUserList AuthorizedUsers { get; }

Public Property AuthorizedUsers As AuthorizedUserList

Remarks

The AuthorizedUsers property contains a list of clients allowed to connect to the QBConnector component. 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 component uses the information in the QBConnectionString to make a connection to QuickBooks.

ConnectedToQB Property (QBConnector Component)

Opens or closes a persistent connection to QuickBooks.

Syntax

• C#
• VB.NET

public bool ConnectedToQB { get; }

Public ReadOnly Property ConnectedToQB As Boolean

Default Value

False

Remarks

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

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

EnableSSL Property (QBConnector Component)

Indicates whether server starts in SSL-mode.

Syntax

• C#
• VB.NET

public bool EnableSSL { get; set; }

Public Property EnableSSL As Boolean

Default Value

False

Remarks

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

This property is not available at design time.

Listening Property (QBConnector Component)

If set to True, the component accepts incoming connections on LocalPort.

Syntax

• C#
• VB.NET

public bool Listening { get; set; }

Public Property Listening As Boolean

Default Value

False

Remarks

This property indicates whether the component is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the component is listening.

This property is not available at design time.

LocalHost Property (QBConnector Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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.

LocalPort Property (QBConnector Component)

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

Syntax

• C#
• VB.NET

public int LocalPort { get; set; }

Public Property LocalPort As Integer

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.

SSLAuthenticateClients Property (QBConnector Component)

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

Syntax

• C#
• VB.NET

public bool SSLAuthenticateClients { get; set; }

Public Property SSLAuthenticateClients As Boolean

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.

SSLCert Property (QBConnector Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component 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.

SSLProvider Property (QBConnector Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public QbconnectorSSLProviders SSLProvider { get; set; }

enum QbconnectorSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As QbconnectorSSLProviders

Enum QbconnectorSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component 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:

Additional Notes

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

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

The .NET Standard library will always use the internal implementation on all platforms.

Timeout Property (QBConnector Component)

An initial timeout value to be used by incoming connections.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

30

Remarks

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

The default value is 30 seconds.

AddUser Method (QBConnector Component)

Adds a new user to the AuthorizedUsers collection.

Syntax

• C#
• VB.NET

public void AddUser(string user, string password, string QBConnectionString, int authMode);

Public Sub AddUser(ByVal User As String, ByVal Password As String, ByVal QBConnectionString As String, ByVal AuthMode As Integer)

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 component, 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 amNormal AuthMode (default) the user's password will be checked against the Password field.

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

Config Method (QBConnector Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoEvents Method (QBConnector Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Public Sub DoEvents()

Remarks

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

Reset Method (QBConnector Component)

Clears all properties to their default values.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Shutdown Method (QBConnector Component)

Shutdown the server.

Syntax

• C#
• VB.NET

public void Shutdown();

Public Sub Shutdown()

Remarks

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

Authorization Event (QBConnector Component)

Fired when the client presents its credentials to the server.

Syntax

• C#
• VB.NET

public event OnAuthorizationHandler OnAuthorization;

public delegate void OnAuthorizationHandler(object sender, QbconnectorAuthorizationEventArgs e);

public class QbconnectorAuthorizationEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int UserIndex { get; }
  public string User { get; }
  public string Password { get; }
  public bool Accept { get; set; }
}

Public Event OnAuthorization As OnAuthorizationHandler

Public Delegate Sub OnAuthorizationHandler(sender As Object, e As QbconnectorAuthorizationEventArgs)

Public Class QbconnectorAuthorizationEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property UserIndex As Integer
  Public ReadOnly Property User As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
End Class

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

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

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, QbconnectorConnectedEventArgs e);

public class QbconnectorConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As QbconnectorConnectedEventArgs)

Public Class QbconnectorConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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

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

Syntax

• C#
• VB.NET

public event OnConnectionRequestHandler OnConnectionRequest;

public delegate void OnConnectionRequestHandler(object sender, QbconnectorConnectionRequestEventArgs e);

public class QbconnectorConnectionRequestEventArgs : EventArgs {
  public string Address { get; }
  public int Port { get; }
  public bool Accept { get; set; }
}

Public Event OnConnectionRequest As OnConnectionRequestHandler

Public Delegate Sub OnConnectionRequestHandler(sender As Object, e As QbconnectorConnectionRequestEventArgs)

Public Class QbconnectorConnectionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Address As String
  Public ReadOnly Property Port As Integer
  Public Property Accept As Boolean
End Class

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

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, QbconnectorDisconnectedEventArgs e);

public class QbconnectorDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As QbconnectorDisconnectedEventArgs)

Public Class QbconnectorDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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

This event fires information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, QbconnectorErrorEventArgs e);

public class QbconnectorErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As QbconnectorErrorEventArgs)

Public Class QbconnectorErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the component throws an exception.

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

HTTP headers sent by the client.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, QbconnectorHeaderEventArgs e);

public class QbconnectorHeaderEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Header { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As QbconnectorHeaderEventArgs)

Public Class QbconnectorHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Header As String
  Public ReadOnly Property Value As String
End Class

Remarks

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

Request Event (QBConnector Component)

Fired when a client sends a request to the component.

Syntax

• C#
• VB.NET

public event OnRequestHandler OnRequest;

public delegate void OnRequestHandler(object sender, QbconnectorRequestEventArgs e);

public class QbconnectorRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int UserIndex { get; }
  public string Request { get; }
}

Public Event OnRequest As OnRequestHandler

Public Delegate Sub OnRequestHandler(sender As Object, e As QbconnectorRequestEventArgs)

Public Class QbconnectorRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property UserIndex As Integer
  Public ReadOnly Property Request As String
End Class

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 AuthorizedUsers collection. 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 Component)

Fired when the component sends a response to the client.

Syntax

• C#
• VB.NET

public event OnResponseHandler OnResponse;

public delegate void OnResponseHandler(object sender, QbconnectorResponseEventArgs e);

public class QbconnectorResponseEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int UserIndex { get; }
  public string Response { get; }
}

Public Event OnResponse As OnResponseHandler

Public Delegate Sub OnResponseHandler(sender As Object, e As QbconnectorResponseEventArgs)

Public Class QbconnectorResponseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property UserIndex As Integer
  Public ReadOnly Property Response As String
End Class

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 AuthorizedUsers collection. 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 Component)

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

Syntax

• C#
• VB.NET

public event OnSSLClientAuthenticationHandler OnSSLClientAuthentication;

public delegate void OnSSLClientAuthenticationHandler(object sender, QbconnectorSSLClientAuthenticationEventArgs e);

public class QbconnectorSSLClientAuthenticationEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLClientAuthentication As OnSSLClientAuthenticationHandler

Public Delegate Sub OnSSLClientAuthenticationHandler(sender As Object, e As QbconnectorSSLClientAuthenticationEventArgs)

Public Class QbconnectorSSLClientAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

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

Syntax

• C#
• VB.NET

public event OnSSLConnectionRequestHandler OnSSLConnectionRequest;

public delegate void OnSSLConnectionRequestHandler(object sender, QbconnectorSSLConnectionRequestEventArgs e);

public class QbconnectorSSLConnectionRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string SupportedCipherSuites { get; }
  public string SupportedSignatureAlgs { get; }
  public int CertStoreType { get; set; }
  public string CertStore { get; set; }
  public string CertPassword { get; set; }
  public string CertSubject { get; set; }
}

Public Event OnSSLConnectionRequest As OnSSLConnectionRequestHandler

Public Delegate Sub OnSSLConnectionRequestHandler(sender As Object, e As QbconnectorSSLConnectionRequestEventArgs)

Public Class QbconnectorSSLConnectionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property SupportedCipherSuites As String
  Public ReadOnly Property SupportedSignatureAlgs As String
  Public Property CertStoreType As Integer
  Public Property CertStore As String
  Public Property CertPassword As String
  Public Property CertSubject As String
End Class

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 component 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 component supports both public and private keys in a variety of formats. When the cstAuto value is used the component 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 are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 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 displayed below.

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

SSLStatus Event (QBConnector Component)

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

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, QbconnectorSSLStatusEventArgs e);

public class QbconnectorSSLStatusEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As QbconnectorSSLStatusEventArgs)

Public Class QbconnectorSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Message As String
End Class

Remarks

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

Status Event (QBConnector Component)

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

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, QbconnectorStatusEventArgs e);

public class QbconnectorStatusEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As QbconnectorStatusEventArgs)

Public Class QbconnectorStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only.

AuthorizedUser Type

Client login, password, and QuickBooks connection information.

Remarks

The AuthorizedUser type contains the User and Password of a client that is allowed to connect to the QBConnector component. 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 component uses the information in the QBConnectionString to make a connection to QuickBooks.

Fields

Constructors

• C#
• VB.NET

public AuthorizedUser();

Public AuthorizedUser()

• C#
• VB.NET

public AuthorizedUser(string user, string password);

Public AuthorizedUser(ByVal User As String, ByVal Password As String)

• C#
• VB.NET

public AuthorizedUser(string user, string password, string QBConnectionString);

Public AuthorizedUser(ByVal User As String, ByVal Password As String, ByVal QBConnectionString As String)

• C#
• VB.NET

public AuthorizedUser(string user, string password, string QBConnectionString, AuthModes authMode);

Public AuthorizedUser(ByVal User As String, ByVal Password As String, ByVal QBConnectionString As String, ByVal AuthMode As AuthModes)

Certificate Type

This is the digital certificate being used.

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.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Config Settings (QBConnector Component)

QBConnector Config Settings

Base Config Settings

Trappable Errors (QBConnector Component)

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

QBConnector Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   IPDaemon is already listening.
	106   Cannot change LocalPort when IPDaemon is Listening.
	107   Cannot change LocalHost when IPDaemon is Listening.
	108   Cannot change MaxConnections when IPDaemon is Listening.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	126   Invalid ConnectionId.
	135   Operation would block.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).