QuickBooks Integrator 2022 .NET Edition
Version 22.0 [Build 8594]

QBWCServer Component

Properties   Methods   Events   Config Settings   Errors  

The QBWCServer component is used to communicate with QuickBooks Web Connector from your application.

Syntax

DPayments.InQB.Qbwcserver

Remarks

The QBWCServer component is designed to process requests from QuickBooks Web Connector and fire events that allow you to provide information to, and get information from QuickBooks Web Connector.

This allows you to create an application that can communicate with a remote copy of QuickBooks without worrying about directly accessing the machine where QuickBooks is running. For more information on the design of this approach refer to the Intuit website for QuickBooks Web Connector.

QWC Files

The first step in establishing a relationship between your application and a remote instance of QuickBooks is to create a QWC file. This file specifies information about your application its requirements, as well as the access you need. The CreateQWCFile method creates the QWC file which must be generated for each user of your application. The minimum required properties are:

Once the file is generated the end user will obtain the file from your website, and you will assign a password for that user at that time. The password is not part of the QWC file but the user will provide this directly in QuickBooks Web Connector and it will be sent to your web application during the connection for verification purposes.

Request Processing

The component is designed with a server environment in mind. That is, it's typical that the component will be used in a web page, but is not required. However the HTTP request is received, it can be passed to the RequestData property. After passing the request data to the component call ProcessRequest method processes the request from QuickBooks Web Connector. Processing the requests will fire one of the events.

The component provides various events to interact with QuickBooks Web Connector. QuickBooks Web Connector will make a sequence of calls for any given session, and the events correspond to these calls. Within the events you control the response which dictates what QuickBooks Web Connector will do next.

A session ticket is provided so you can keep track of a particular session over the course of multiple calls. An example of a typical session:

  1. ServerVersion fires. This allows you to provide an the version of your application. This is purely informational and does not need to be implemented.
  2. ClientVersion fires. This provides version information about the QuickBooks Web Connector. It may be used to reject a connection based on minimum required versions, but in most cases no action would be taken in your code and the session proceeds.
  3. Authenticate fires. This event allows verification of the user that is connecting. Here you will either accept or reject the connection.
  4. SendRequest fires. Within this event you will supply a QBXML request that will be passed to QuickBooks.
  5. ReceiveResponse fires. QuickBooks Web Connector returns the QBXML response from the request you gave it in the previous step, or error information about why the request failed.
  6. CloseConnection fires. This is the last event in the session. You may provide a message that will be displayed in QuickBooks Web Connector, but in most cases you would not take any action in this event.

Preparing Requests and Parsing Responses

The SendRequest event requires that you provide a QBXML request. This can be generated using the other components in this toolkit. To do so, simply set the QBRequestMode property to rmOffline before making a method call. For instance: Customer customer = new Customer(); customer.QBRequestMode = CustomerQBRequestModes.rmOffline; customer.GetByName("John Doe"); e.Request = customer.QBRequestAggregate; In the above code the component is used in the same way you would use the component if you were communicating directly with QuickBooks with the exception that QBRequestMode is set to rmOffline. When the GetByName method is called instead of attempting to communicate with QuickBooks only the QBRequestAggregate property is populated. This QBXML aggregate should be passed to the e.Request parameter inside the SendRequest event.

Processing responses is similar. You will receive the QBXML response from the e.Response parameter inside the ReceiveResponse event. You may then pass the response to the QBResponseAggregate property, or InputQBXML method of other components in the toolkit. For instance: Customer customer = new Customer(); customer.QBResponseAggregate = e.Response; string myAccountNumber = customer.AccountNumber; Setting QBResponseAggregate and calling InputQBXML do the exact same thing. The component parses the response and populates the properties of the component.

Error Handling

There are two basic types of errors when dealing with QuickBooks Web Connector. The first are errors that originate from your application and are reported to QuickBooks Web Connector. These are driven by the actions you take inside events. For instance in the SendRequest event you may set e.Request to empty string to signify an error. QuickBooks Web Connector will see this and make another call and GetLastError will fire. GetLastError is fired when QuickBooks Web Connector is asking from error information from your application. Here you may provide details about the error.

The second type of error is a communication error between QuickBooks Web Connector and QuickBooks itself. When this happens QuickBooks Web Connector will make a call and ConnectionError will fire with information about the error received from QuickBooks.

Property List

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

OverwriteWhether to overwrite QWC files.
QWCFileInfoSpecifies the specific requirements for the QWC file.
RequestDataThe request data to process.
ResponseDataThe response data.

Method List

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

ConfigSets or retrieves a configuration setting.
CreateQWCFileCreates a QWC file.
ProcessRequestProcesses the request.
ReadRequestReads the request from the HTTP context.
SendResponseSends the response.
SetRequestStreamSet's the request stream.
SetResponseStreamSet's the response stream.

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.

AuthenticateFired when the QuickBooks Web Connector authenticates.
ClientVersionProvides the QuickBooks Web Connector version information.
CloseConnectionFires when the update session completes.
ConnectionErrorFires when QuickBooks Web Connector is unable to connect to QuickBooks.
ErrorInformation about errors during data delivery.
GetInteractiveURLFires when the URL for an interactive session is needed.
GetLastErrorFires when QuickBooks Web Connector checks for error information.
InteractiveDoneThis event fires when QuickBooks Web Connector checks to see if the interactive session is finished.
InteractiveRejectedThis event fires after a user rejects an interactive session.
ReceiveResponseFires when a response is received.
SendRequestFires when QuickBooks Web Connector asks for a request.
ServerVersionFires when QuickBooks Web Connector requests the version of your application.

Config Settings

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

QBTypeThe type of QuickBooks software the connection will be made to.
StyleSpecifies the SOAP encoding style used in requests made by QuickBooks Web Connector.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Overwrite Property (QBWCServer Component)

Whether to overwrite QWC files.

Syntax

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

This determines whether existing files are overwritten when calling CreateQWCFile. The default value is False.

QWCFileInfo Property (QBWCServer Component)

Specifies the specific requirements for the QWC file.

Syntax

public QWCFileInfo QWCFileInfo { get; set; }

Public Property QWCFileInfo As QWCFileInfo

Remarks

This property specifies the details of the QWC file. To create the file call CreateQWCFile.

RequestData Property (QBWCServer Component)

The request data to process.

Syntax

public string RequestData { get; set; }

Public Property RequestData As String

Default Value

""

Remarks

This property specifies the data to be processed. Additional options for reading the request are discussed in the ProcessRequest method.

Call ProcessRequest to process the data.

This property is not available at design time.

ResponseData Property (QBWCServer Component)

The response data.

Syntax

public string ResponseData { get; set; }

Public Property ResponseData As String

Default Value

""

Remarks

After calling ProcessRequest this property will be populated with the response to be sent back to QuickBooks Web Connector. See ProcessRequest for different ways to return the response.

This property is not available at design time.

Config Method (QBWCServer Component)

Sets or retrieves a configuration setting.

Syntax

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.

CreateQWCFile Method (QBWCServer Component)

Creates a QWC file.

Syntax

public void CreateQWCFile(string filePath);

Public Sub CreateQWCFile(ByVal FilePath As String)

Remarks

This method creates a QWC file on disk at the specified FilePath.

The QWCFileInfo property defines the specific requirements of the file.

The following properties are required:

The Overwrite property determines the behavior if the file already exists.

ProcessRequest Method (QBWCServer Component)

Processes the request.

Syntax

public void ProcessRequest();

Public Sub ProcessRequest()

Remarks

This method processes the request. A request is made by QuickBooks Web Connector to your web based application. The request may be supplied to the component in a variety of ways. You may simply call ReadRequest to read the request directly from the HTTP context. You may call SetRequestStream to specify the request stream. You may read the request yourself and supply it to the RequestData property.

After providing the request, call this method to process the request. The event which corresponds to the call made by QuickBooks Web Connector will fire and allow you to get or set information. Possible events that may fire when this method is called are:

Only one of these events will fire, this is because QuickBooks Web Connector only makes one call at a time. The events provide a SessionTicket so that you can identify which events belong to which session.

After this method returns, the ResponseData property will be populated. To send the response you may either send the response yourself, call the SendResponse method, or set SetResponseStream prior to calling this method.

When sending the response you MUST set the Content-Type header to "text/xml".

Example #1: Process a request and let the component read from the HTTP context and write the response. QWCServer1.ReadRequest(); QWCServer1.ProcessRequest(); QWCServer1.SendResponse(); Note: The Content-Type header is automatically set to "text/xml" and the Response is closed by the component.

Example #2: Pass streams to the component for the request and response. QWCServer1.SetRequestStream(Request.InputStream); QWCServer1.SetResponseStream(Response.OutputStream); QWCServer1.ProcessRequest(); Response.ContentType = "text/xml"; Response.Flush(); Response.End(); Note: ContentType must be set to "text/xml" and the Response must be closed.

Example #3: Read the request and send the response outside of the component. byte[] reqBytes = Request.BinaryRead(Request.ContentLength); QWCServer1.RequestData = System.Text.Encoding.Default.GetString(reqBytes); QWCServer1.ProcessRequest(); Response.ContentType = "text/xml"; Response.Write(QWCServer1.ResponseData); Response.Flush(); Response.End(); Note: ContentType must be set to "text/xml" and the Response must be closed.

ReadRequest Method (QBWCServer Component)

Reads the request from the HTTP context.

Syntax

public void ReadRequest();

Public Sub ReadRequest()

Remarks

This method reads the request from the HTTP context. You may alternatively set RequestData or call SetInputStream to provide the request. After calling this method, call ProcessRequest.

SendResponse Method (QBWCServer Component)

Sends the response.

Syntax

public void SendResponse();

Public Sub SendResponse()

Remarks

This method sends the response and closes the response stream. This makes use of the HTTP context. This method is not applicable when SetResponseStream has been called.

SetRequestStream Method (QBWCServer Component)

Set's the request stream.

Syntax

public void SetRequestStream(System.IO.Stream requestStream);

Public Sub SetRequestStream(ByVal RequestStream As System.IO.Stream)

Remarks

This method specifies the stream from which the request data will be read. When ProcessRequest is called the request data will be read from this stream.

SetResponseStream Method (QBWCServer Component)

Set's the response stream.

Syntax

public void SetResponseStream(System.IO.Stream responseStream);

Public Sub SetResponseStream(ByVal ResponseStream As System.IO.Stream)

Remarks

This method specifies a response stream to which data will be written when ProcessRequest is called. The Content-Type header MUST still be set to "text/xml" in your code. Additionally you must flush/end the response in your code after ProcessRequest returns.

Authenticate Event (QBWCServer Component)

Fired when the QuickBooks Web Connector authenticates.

Syntax

public event OnAuthenticateHandler OnAuthenticate;

public delegate void OnAuthenticateHandler(object sender, QbwcserverAuthenticateEventArgs e);

public class QbwcserverAuthenticateEventArgs : EventArgs {
  public string User { get; }
  public string Password { get; }
  public bool Accept { get; set; }
  public bool Busy { get; set; }
  public bool NoWork { get; set; }
  public string SessionTicket { get; set; }
  public string CompanyFile { get; set; }
  public int UpdateDelay { get; set; }
  public int UpdateInterval { get; set; }
}

Public Event OnAuthenticate As OnAuthenticateHandler

Public Delegate Sub OnAuthenticateHandler(sender As Object, e As QbwcserverAuthenticateEventArgs)

Public Class QbwcserverAuthenticateEventArgs Inherits EventArgs
  Public ReadOnly Property User As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
  Public Property Busy As Boolean
  Public Property NoWork As Boolean
  Public Property SessionTicket As String
  Public Property CompanyFile As String
  Public Property UpdateDelay As Integer
  Public Property UpdateInterval As Integer
End Class

Remarks

This event fires when the QuickBooks Web Connector attempts authentication.

You may use this event to accept the connection, reject the connection, postpone the update, or skip the update. The parameters are as follows:

User is the username that is presented by QuickBooks Web Connector.

Password is the password that is presented for the user.

Accept determines whether the connection request is accepted. The values of User and Password should be verified within this event to determine if the user credentials are valid. The default value is True.

Busy may be set to True to inform QuickBooks Web Connector that the application is busy and to try again later. The default is False. When set to True it is not necessary to set Accept to False.

NoWork may be set to True to inform QuickBoooks Web Connector that there is no work to process and to stop the update. When set to True it is not necessary to set Accept to False.

SessionTicket is a string value which identifies the session and will be available within other events. The component populates this with a GUID but you may choose to set your own value.

CompanyFile should be set to the full path to the company file on the system running QuickBooks which you want to work with. Leave this set to empty string to indicate that the currently opened company file should be used.

UpdateDelay allows you to postpone the update for the specified number of seconds. When set to True it is not necessary to set Accept to False.

UpdateInterval may be set to specify the interval in seconds at which the QuickBooks Web Connector will begin an update. If the user has enabled the "Auto-Run" option on QuickBooks Web Connector this will update the "Every_Min" field. Note that the user may choose to change the value. If the user has not enabled "Auto-Run" this is not applicable, but will not cause an error.

ClientVersion Event (QBWCServer Component)

Provides the QuickBooks Web Connector version information.

Syntax

public event OnClientVersionHandler OnClientVersion;

public delegate void OnClientVersionHandler(object sender, QbwcserverClientVersionEventArgs e);

public class QbwcserverClientVersionEventArgs : EventArgs {
  public string ClientVersion { get; }
  public string RequiredVersion { get; set; }
  public string ErrorMessage { get; set; }
  public string WarningMessage { get; set; }
}

Public Event OnClientVersion As OnClientVersionHandler

Public Delegate Sub OnClientVersionHandler(sender As Object, e As QbwcserverClientVersionEventArgs)

Public Class QbwcserverClientVersionEventArgs Inherits EventArgs
  Public ReadOnly Property ClientVersion As String
  Public Property RequiredVersion As String
  Public Property ErrorMessage As String
  Public Property WarningMessage As String
End Class

Remarks

This event fires with the version information for QuickBooks Web Connector.

In most cases you do not need to do anything within this event. If no action is taken the session will proceed normally. You may optionally set parameters in this event to return an error, warning, or version requirement. The parameters are as follow:

ClientVersion holds the version of QuickBooks Web Connector that is connecting to your application. For instance "2.1.0.30".

RequiredVersion specifies the required version of QuickBooks Web Connector. You may set this to a value like "2.0". This is the minimum supported version of QuickBooks Web Connector which you will allow.

ErrorMessage may be set to return an error to QuickBooks Web Connector.

WarningMessage may be set to return a warning to QuickBooks Web Connector. The user will be prompted to continue or cancel the update.

CloseConnection Event (QBWCServer Component)

Fires when the update session completes.

Syntax

public event OnCloseConnectionHandler OnCloseConnection;

public delegate void OnCloseConnectionHandler(object sender, QbwcserverCloseConnectionEventArgs e);

public class QbwcserverCloseConnectionEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string ResponseMessage { get; set; }
}

Public Event OnCloseConnection As OnCloseConnectionHandler

Public Delegate Sub OnCloseConnectionHandler(sender As Object, e As QbwcserverCloseConnectionEventArgs)

Public Class QbwcserverCloseConnectionEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public Property ResponseMessage As String
End Class

Remarks

This event fires when QuickBooks Web Connector notifies your application that the update is complete. This is the last event to fire in a session. Parameters are as follows:

SessionTicket identifies the session.

ResponseMessage may be set to a message that will be displayed in the "Last result" field in QuickBooks Web Connector.

ConnectionError Event (QBWCServer Component)

Fires when QuickBooks Web Connector is unable to connect to QuickBooks.

Syntax

public event OnConnectionErrorHandler OnConnectionError;

public delegate void OnConnectionErrorHandler(object sender, QbwcserverConnectionErrorEventArgs e);

public class QbwcserverConnectionErrorEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string ErrorCode { get; }
  public string ErrorMessage { get; }
  public string CompanyFile { get; set; }
}

Public Event OnConnectionError As OnConnectionErrorHandler

Public Delegate Sub OnConnectionErrorHandler(sender As Object, e As QbwcserverConnectionErrorEventArgs)

Public Class QbwcserverConnectionErrorEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public ReadOnly Property ErrorCode As String
  Public ReadOnly Property ErrorMessage As String
  Public Property CompanyFile As String
End Class

Remarks

This event fires when QuickBooks Web Connector is unable to connect to QuickBooks. The event parameters provide the error details, and also allow you to specify an alternate company file to retry the connection with. If an alternate company file is not specified the session is ended. The parameters are as follows:

ErrorCode is the error code (HResult) returned by QuickBooks. This value is read-only.

ErrorMessage is the error message returned by QuickBooks. This value is read-only.

CompanyFile may be set to the full path of an alternate company file. If specified, the QuickBooks Web Connector will retry the connection to QuickBooks using this company file. Leave this parameter empty to end the session.

Error Event (QBWCServer Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class QbwcserverErrorEventArgs Inherits EventArgs
  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.

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.

GetInteractiveURL Event (QBWCServer Component)

Fires when the URL for an interactive session is needed.

Syntax

public event OnGetInteractiveURLHandler OnGetInteractiveURL;

public delegate void OnGetInteractiveURLHandler(object sender, QbwcserverGetInteractiveURLEventArgs e);

public class QbwcserverGetInteractiveURLEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string URL { get; set; }
}

Public Event OnGetInteractiveURL As OnGetInteractiveURLHandler

Public Delegate Sub OnGetInteractiveURLHandler(sender As Object, e As QbwcserverGetInteractiveURLEventArgs)

Public Class QbwcserverGetInteractiveURLEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public Property URL As String
End Class

Remarks

This event fires when QuickBooks Web Connector requests the URL for an interactive session.

If you set the InteractiveMode parameter in the GetLastError event this event will then fire so that you may provide the URL for the interactive session. The available parameters are:

SessionTicket identifies the session.

URL specifies the URL for the interactive session on your site. This must be a secure (https://) URL.

GetLastError Event (QBWCServer Component)

Fires when QuickBooks Web Connector checks for error information.

Syntax

public event OnGetLastErrorHandler OnGetLastError;

public delegate void OnGetLastErrorHandler(object sender, QbwcserverGetLastErrorEventArgs e);

public class QbwcserverGetLastErrorEventArgs : EventArgs {
  public string SessionTicket { get; }
  public bool Pause { get; set; }
  public bool InteractiveMode { get; set; }
  public string ErrorMessage { get; set; }
}

Public Event OnGetLastError As OnGetLastErrorHandler

Public Delegate Sub OnGetLastErrorHandler(sender As Object, e As QbwcserverGetLastErrorEventArgs)

Public Class QbwcserverGetLastErrorEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public Property Pause As Boolean
  Public Property InteractiveMode As Boolean
  Public Property ErrorMessage As String
End Class

Remarks

This event allows you to report an error to QuickBooks Web Connector. It will be fired whenever QuickBooks Web Connector detects an error condition and asks your application for details. The parameters are as follows:

SessionTicket identifies the session.

Pause may be set to True to introduce a brief delay, after which QuickBooks Web Connector will retry the previous operation. For instance, the following sequence of events may occur:

  • QuickBooks Web Connector makes a call and SendRequest fires.
  • You set the Request parameter inside SendRequest to empty string.
  • QuickBooks Web Connector determines the empty request as an error and makes a call which fires the GetLastError event.
  • You set the Pause parameter inside this event to True.
  • QuickBooks Web Connector reads the response and waits 5 seconds.
  • QuickBooks Web Connector retries the previous operation and makes a call which fires SendRequest again.

InteractiveMode may be set to request interactive mode. When set to True the QuickBooks Web Connector will prompt the user to accept an interactive session. If the user agrees, QuickBooks Web Connector will make a call and the GetInteractiveURL event will fire. If the user declines, QuickBooks Web Connector will report this and the InteractiveRejected event will fire.

ErrorMessage may be set to any string which will be reported to the QuickBooks Web Connector.

InteractiveDone Event (QBWCServer Component)

This event fires when QuickBooks Web Connector checks to see if the interactive session is finished.

Syntax

public event OnInteractiveDoneHandler OnInteractiveDone;

public delegate void OnInteractiveDoneHandler(object sender, QbwcserverInteractiveDoneEventArgs e);

public class QbwcserverInteractiveDoneEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string Response { get; set; }
}

Public Event OnInteractiveDone As OnInteractiveDoneHandler

Public Delegate Sub OnInteractiveDoneHandler(sender As Object, e As QbwcserverInteractiveDoneEventArgs)

Public Class QbwcserverInteractiveDoneEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public Property Response As String
End Class

Remarks

While the interactive session is open QuickBooks Web Connector will periodically poll your application to see if the session is finished. The response you provide determines if the session has ended or is still open.

SessionTicket identifies the session.

Response specifies whether the session has ended or not. Set this to empty string to "Done" to indicate the session has finished. Set this to any other value such as "Continue" to indicate the session is still ongoing.

InteractiveRejected Event (QBWCServer Component)

This event fires after a user rejects an interactive session.

Syntax

public event OnInteractiveRejectedHandler OnInteractiveRejected;

public delegate void OnInteractiveRejectedHandler(object sender, QbwcserverInteractiveRejectedEventArgs e);

public class QbwcserverInteractiveRejectedEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string ReasonMessage { get; }
  public string ResponseMessage { get; set; }
}

Public Event OnInteractiveRejected As OnInteractiveRejectedHandler

Public Delegate Sub OnInteractiveRejectedHandler(sender As Object, e As QbwcserverInteractiveRejectedEventArgs)

Public Class QbwcserverInteractiveRejectedEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public ReadOnly Property ReasonMessage As String
  Public Property ResponseMessage As String
End Class

Remarks

This event fires after a user rejects an interactive session. After requesting an interactive session within GetLastError the user may reject the request. If the request is rejected this event will fire with the reason and allow you to send a message back which will be displayed in QuickBooks Web Connector. The parameters are as follows:

SessionTicket identifies the session.

ReasonMessage is the reason for the rejection as reported by QuickBooks Web Connector. This will be text like "User rejected interactive mode".

ResponseMessage may be set to a string that will be displayed as the "Last Result" in QuickBooks Web Connector.

ReceiveResponse Event (QBWCServer Component)

Fires when a response is received.

Syntax

public event OnReceiveResponseHandler OnReceiveResponse;

public delegate void OnReceiveResponseHandler(object sender, QbwcserverReceiveResponseEventArgs e);

public class QbwcserverReceiveResponseEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string Response { get; }
  public string ErrorCode { get; }
  public string ErrorMessage { get; }
  public bool Success { get; }
  public int PercentDone { get; set; }
}

Public Event OnReceiveResponse As OnReceiveResponseHandler

Public Delegate Sub OnReceiveResponseHandler(sender As Object, e As QbwcserverReceiveResponseEventArgs)

Public Class QbwcserverReceiveResponseEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public ReadOnly Property Response As String
  Public ReadOnly Property ErrorCode As String
  Public ReadOnly Property ErrorMessage As String
  Public ReadOnly Property Success As Boolean
  Public Property PercentDone As Integer
End Class

Remarks

This event fires after SendRequest to provide the response of the request. The parameters are as follows:

SessionTicket identifies the session.

Response holds the qbXML response. This may be passed to the QBResponseAggregate property or InputQBXML method of other components in this toolkit to parse the response. In the case of an error this parameter will be empty. This value is read-only.

ErrorCode holds the error code (HResult) returned by QuickBooks. This value is read-only.

ErrorMessage holds the error message returned by QuickBooks. This value is read-only.

Success indicates whether the request was processed successfully by QuickBooks. If this value is False check HResult and Message for details. This value is read-only.

PercentDone indicates the current progress to QuickBooks Web Connector. A value of 100 means there are no more requests to be processed for this session.

A positive value less than 100 indicates there is still more work to do in this session and QuickBooks Web Connector will make another call and SendRequest will fire again. There is no limit to the number of requests in a session, so you may continue to set this value to a positive number less than 100 to continue the session.

A negative value indicates and error and will cause GetLastError to fire.

The default value is 100, which indicates there is no more work to do for this session.

SendRequest Event (QBWCServer Component)

Fires when QuickBooks Web Connector asks for a request.

Syntax

public event OnSendRequestHandler OnSendRequest;

public delegate void OnSendRequestHandler(object sender, QbwcserverSendRequestEventArgs e);

public class QbwcserverSendRequestEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string CompanyResponse { get; }
  public string HostResponse { get; }
  public string PrefsResponse { get; }
  public string CompanyFile { get; }
  public string QBXMLCountry { get; }
  public int QBXMLMajorVersion { get; }
  public int QBXMLMinorVersion { get; }
  public string Request { get; set; }
}

Public Event OnSendRequest As OnSendRequestHandler

Public Delegate Sub OnSendRequestHandler(sender As Object, e As QbwcserverSendRequestEventArgs)

Public Class QbwcserverSendRequestEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public ReadOnly Property CompanyResponse As String
  Public ReadOnly Property HostResponse As String
  Public ReadOnly Property PrefsResponse As String
  Public ReadOnly Property CompanyFile As String
  Public ReadOnly Property QBXMLCountry As String
  Public ReadOnly Property QBXMLMajorVersion As Integer
  Public ReadOnly Property QBXMLMinorVersion As Integer
  Public Property Request As String
End Class

Remarks

This event fires when QuickBooks Web Connector is ready to accept a request. The purpose of the event is to provide a request to QuickBooks Web Connector. The parameters are as follows:

SessionTicket identifies the session. This value is read-only.

CompanyResponse holds a QBXML response to a Company Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

HostResponse holds a QBXML response to a Host Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

PrefsResponse holds a QBXML response to a Preferences Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

CompanyFile specifies the path to the company file that will be used in the data exchange. This value is read-only.

QBXMLCountry is the country version of QuickBooks. For instance "US", "CA", or "UK". This value is read-only.

QBXMLMajorVersion is the major version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "6". This value is read-only.

QBXMLMinorVersion is the minor version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "0". This value is read-only.

Request specifies the qbXML request that will be sent to QuickBooks Web Connector. This may be obtained from other components in the toolkit by setting the QBRequestMode property to Offline. See the help for QBRequestMode for mode details.

Note: If the Request parameter is left empty QuickBooks Web Connector will then make a call and GetLastError will fire. This approach may be used if you wish to return an error, request interactive mode, or introduce a brief pause.

ServerVersion Event (QBWCServer Component)

Fires when QuickBooks Web Connector requests the version of your application.

Syntax

public event OnServerVersionHandler OnServerVersion;

public delegate void OnServerVersionHandler(object sender, QbwcserverServerVersionEventArgs e);

public class QbwcserverServerVersionEventArgs : EventArgs {
  public string Version { get; set; }
}

Public Event OnServerVersion As OnServerVersionHandler

Public Delegate Sub OnServerVersionHandler(sender As Object, e As QbwcserverServerVersionEventArgs)

Public Class QbwcserverServerVersionEventArgs Inherits EventArgs
  Public Property Version As String
End Class

Remarks

This event fires when QuickBooks Web Connector requests the version of your application.

Version may be set to any string value. The value you specify will be displayed to the user when they click the more information link in QuickBooks Web Connector.

QWCFileInfo Type

This type holds details of the QWC file which will be created.

Remarks

The fields below define the requirements for the QWC file. Call CreateQWCFile to create the file.

Fields

AppDescription
String

A brief description of the application. This will be displayed in the QB Web Connector UI. For the best results use a value less than 80 characters in length.

This field is required.

AppDisplayName
String

The display name of the application. This is use for display purposes in the QB Web Connector UI only.

This field is optional.

AppId
String

The application Id. This value is passed to QuickBooks or QuickBooks POS when a connection is opened, however it is not used at the time of this writing.

This field is optional.

AppName
String

The name of the application. This name is displayed in the QB Web Connector UI. It is also the name supplied to QuickBooks when a connection is created.

This field is required.

AppSupportURL
String

A URL where users can find support for your product.

The domain name specified in this URL must match the domain name specified in AppURL.

During development you may specify "localhost" or a machine name in place of the domain name. If a machine name is specified, it must match the machine name specified in AppURL.

The URL provided in AppURL must be a https:// URL. The only exception to this is when using "localhost" for development, in that case a http:// URL may be used.

This field is required.

AppUniqueName
String

If this field is set the QuickBooks Web Connector will not use its clone/replace model for the AppName and will instead use the replace routine.

This field is optional.

AppURL
String

The URL of your web application.

The domain name specified in this URL must match the domain name specified in AppURL.

During development you may specify "localhost" or a machine name in place of the domain name. If a machine name is specified, it must match the machine name specified in AppURL.

The URL provided in AppURL must be a https:// URL. The only exception to this is when using "localhost" for development, in that case a http:// URL may be used.

This field is required.

AuthFlags
String

This field specifies which versions of QuickBooks your application supports. By default all editions are supported, including Simple Start.

This property is optional. If this is not set the QuickBooks Web Connector will support all versions. In most cases it is recommended to leave this value as empty string unless you need to restrict which versions of QuickBooks your application supports.

Possible values are:

0x0 All
0x1 QuickBooks Simple Start
0x2 QuickBooks Professional
0x4 QuickBooks Premier
0x8 QuickBooks Enterprise

If you need to support multiple editions you may AND the desired values together.

This field is optional.

CertURL
String

This field specifies a URL which is used by the QuickBooks Web Connector to obtain and validate the SSL certificate. This is typically only used when the *rpCertURL; is not the web server where your application is running.

This field is optional.

FileId
String

This field specifies a unique Id. The first time the QuickBooks Web Connector connects to the company this Id is stored as an extension to the company record along with OwnerId.

The storage of this data allows you to perform a Company query (using the Company component) to determine if you've worked with this company file previously. When the Company query is performed specify your OwnerId and validate the FileId in the response.

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 field is required.

IsReadOnly
Boolean

Specifies whether read or read/write access is needed.

This field specifies whether your application will need read or read/write access to the company file. The default value is False, meaning both read and write access is required.

Notify
Boolean

Determines if notification are allowed.

This field determines if system tray notification pop-ups are allowed at the application level. The default value is False.

OwnerId
String

This field specifies an Id which identifies your application.

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 field is required.

PersonalDataPref
PersonalDataPrefTypes

This field defines the type of access to personal/sensitive data required by your application. Possible values are:

0 (pdpNotNeeded - default) Access to personal data is not needed.
1 (pdpOptional) Access to personal data is optional.
2 (pdpRequired) Access to personal data is required.
UnattendedModePref
UnattendedModePrefTypes

This field specifies whether you need to access QuickBooks in unattended mode (when QuickBooks is closed). Possible values are:

0 (umpOptional - default) Access to QuickBooks when it is closed is not required. The user may still grant access.
1 (umpRequired) Access to QuickBooks when it is closed is required.
UpdateInterval
Integer

This field specifies the desired update interval in seconds. If set to a positive value the QuickBooks Web Connector will automatically enable the "Auto-Run" option when adding the application, and the "Every_Min" value will be set to the nearest minute value. The default value is 0, which means this option will not be included in the created file.

This field is optional.

User
String

This field species the user. When QuickBooks Web Connector connects to your application and ProcessRequest is called the Authenticate event will fire and the user and password will be available to you for verification.

This field is required.

Constructors

public QWCFileInfo();

Public QWCFileInfo()

Config Settings (QBWCServer Component)

The component accepts one or more of the following configuration settings. Configuration 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.

QBWCServer Config Settings

QBType:   The type of QuickBooks software the connection will be made to.

This setting is applicable when calling CreateQWCFile. It specifies whether the application will connect to QuickBooks, or QuickBooks POS (Point of Sale). Possible values are:

0 (default) QuickBooks
1 QuickBooks POS

You should only set this when generating a QWC file designed for an application that will connect to QuickBooks POS.

Style:   Specifies the SOAP encoding style used in requests made by QuickBooks Web Connector.

This setting is applicable when calling CreateQWCFile. It specifies the SOAP encoding style used in the requests made by QuickBooks Web Connector. When using the QBWCServer component to process requests this should not be set. Possible values are:

Document (default) Standard .NET web service format.
DocWrapped Axis web services built using WSDL2Java.
RPC Axis web services built using Java2WSDL or JWS.

This setting should only be set if there is a specific need to define a value other than the default.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to true.

Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (QBWCServer Component)

Errors

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.

QBWCServer 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.
899   An XML or other QuickBooks error has occurred.

Copyright (c) 2023 4D Payments Inc.
QuickBooks Integrator 2022 .NET Edition - Version 22.0 [Build 8594]