QBWCServer Class
Properties Methods Events Config Settings Errors
The QBWCServer class is used to communicate with QuickBooks Web Connector from your application.
Syntax
class inqb.QBWCServer
Remarks
The QBWCServer class 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 create_qwc_file method creates the QWC file which must be generated for each user of your application. The minimum required properties are:
- qwc_file_info_app_description
- qwc_file_info_app_name
- qwc_file_info_app_support_url
- qwc_file_info_app_url
- qwc_file_info_file_id
- qwc_file_info_owner_id
- qwc_file_info_user
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 class is designed with a server environment in mind. That is, it's typical that the class will be used in a web page, but is not required. However the HTTP request is received, it can be passed to the request_data property. After passing the request data to the class call process_request method processes the request from QuickBooks Web Connector. Processing the requests will fire one of the events.
The class 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:
- on_server_version fires. This allows you to provide an the version of your application. This is purely informational and does not need to be implemented.
- on_client_version 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.
- on_authenticate fires. This event allows verification of the user that is connecting. Here you will either accept or reject the connection.
- on_send_request fires. Within this event you will supply a QBXML request that will be passed to QuickBooks.
- on_receive_response 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.
- on_close_connection 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 on_send_request 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 class is used in the same way you would use the class 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 on_send_request event.
Processing responses is similar. You will receive the QBXML response from the e.Response parameter inside the
on_receive_response 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 class parses the
response and populates the properties of the class.
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 on_send_request event you may set e.Request to empty string to signify an error. QuickBooks Web Connector will see this and make another call and on_get_last_error will fire. on_get_last_error 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 on_connection_error will fire with information about the error received from QuickBooks.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| overwrite | Whether to overwrite QWC files. |
| qwc_file_info_app_description | A brief description of the application. |
| qwc_file_info_app_display_name | The display name of the application. |
| qwc_file_info_app_id | The application Id. |
| qwc_file_info_app_name | The name of the application. |
| qwc_file_info_app_support_url | A URL where users can find support for your product. |
| qwc_file_info_app_unique_name | If this property is set the QuickBooks Web Connector will not use its clone/replace model for the AppName and will instead use the replace routine. |
| qwc_file_info_app_url | The URL of your web application. |
| qwc_file_info_auth_flags | This property specifies which versions of QuickBooks your application supports. |
| qwc_file_info_cert_url | This property specifies a URL which is used by the QuickBooks Web Connector to obtain and validate the SSL certificate. |
| qwc_file_info_file_id | This property specifies a unique Id. |
| qwc_file_info_is_read_only | Specifies whether read or read/write access is needed. |
| qwc_file_info_notify | Determines if notification are allowed. |
| qwc_file_info_owner_id | This property specifies an Id which identifies your application. |
| qwc_file_info_personal_data_pref | This property defines the type of access to personal/sensitive data required by your application. |
| qwc_file_info_unattended_mode_pref | This property specifies whether you need to access QuickBooks in unattended mode (when QuickBooks is closed). |
| qwc_file_info_update_interval | This property specifies the desired update interval in seconds. |
| qwc_file_info_user | This property species the user. |
| request_data | The request data to process. |
| response_data | The response data. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| create_qwc_file | Creates a QWC file. |
| process_request | Processes the request. |
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.
| on_authenticate | Fired when the QuickBooks Web Connector authenticates. |
| on_client_version | Provides the QuickBooks Web Connector version information. |
| on_close_connection | Fires when the update session completes. |
| on_connection_error | Fires when QuickBooks Web Connector is unable to connect to QuickBooks. |
| on_error | Information about errors during data delivery. |
| on_get_interactive_url | Fires when the URL for an interactive session is needed. |
| on_get_last_error | Fires when QuickBooks Web Connector checks for error information. |
| on_interactive_done | This event fires when QuickBooks Web Connector checks to see if the interactive session is finished. |
| on_interactive_rejected | This event fires after a user rejects an interactive session. |
| on_receive_response | Fires when a response is received. |
| on_send_request | Fires when QuickBooks Web Connector asks for a request. |
| on_server_version | Fires when QuickBooks Web Connector requests the version of your application. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| QBType | The type of QuickBooks software the connection will be made to. |
| Style | Specifies the SOAP encoding style used in requests made by QuickBooks Web Connector. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
overwrite Property
Whether to overwrite QWC files.
Syntax
def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ...
overwrite = property(get_overwrite, set_overwrite)
Default Value
FALSE
Remarks
This determines whether existing files are overwritten when calling create_qwc_file. The default value is False.
qwc_file_info_app_description Property
A brief description of the application.
Syntax
def get_qwc_file_info_app_description() -> str: ... def set_qwc_file_info_app_description(value: str) -> None: ...
qwc_file_info_app_description = property(get_qwc_file_info_app_description, set_qwc_file_info_app_description)
Default Value
""
Remarks
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 property is required.
qwc_file_info_app_display_name Property
The display name of the application.
Syntax
def get_qwc_file_info_app_display_name() -> str: ... def set_qwc_file_info_app_display_name(value: str) -> None: ...
qwc_file_info_app_display_name = property(get_qwc_file_info_app_display_name, set_qwc_file_info_app_display_name)
Default Value
""
Remarks
The display name of the application. This is use for display purposes in the QB Web Connector UI only.
This property is optional.
qwc_file_info_app_id Property
The application Id.
Syntax
def get_qwc_file_info_app_id() -> str: ... def set_qwc_file_info_app_id(value: str) -> None: ...
qwc_file_info_app_id = property(get_qwc_file_info_app_id, set_qwc_file_info_app_id)
Default Value
""
Remarks
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 property is optional.
qwc_file_info_app_name Property
The name of the application.
Syntax
def get_qwc_file_info_app_name() -> str: ... def set_qwc_file_info_app_name(value: str) -> None: ...
qwc_file_info_app_name = property(get_qwc_file_info_app_name, set_qwc_file_info_app_name)
Default Value
""
Remarks
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 property is required.
qwc_file_info_app_support_url Property
A URL where users can find support for your product.
Syntax
def get_qwc_file_info_app_support_url() -> str: ... def set_qwc_file_info_app_support_url(value: str) -> None: ...
qwc_file_info_app_support_url = property(get_qwc_file_info_app_support_url, set_qwc_file_info_app_support_url)
Default Value
""
Remarks
A URL where users can find support for your product.
The domain name specified in this URL must match the domain name specified in qwc_file_info_app_url.
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 qwc_file_info_app_url.
The URL provided in qwc_file_info_app_url 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 property is required.
qwc_file_info_app_unique_name Property
If this property is set the QuickBooks Web Connector will not use its clone/replace model for the AppName and will instead use the replace routine.
Syntax
def get_qwc_file_info_app_unique_name() -> str: ... def set_qwc_file_info_app_unique_name(value: str) -> None: ...
qwc_file_info_app_unique_name = property(get_qwc_file_info_app_unique_name, set_qwc_file_info_app_unique_name)
Default Value
""
Remarks
If this property is set the QuickBooks Web Connector will not use its clone/replace model for the qwc_file_info_app_name and will instead use the replace routine.
This property is optional.
qwc_file_info_app_url Property
The URL of your web application.
Syntax
def get_qwc_file_info_app_url() -> str: ... def set_qwc_file_info_app_url(value: str) -> None: ...
qwc_file_info_app_url = property(get_qwc_file_info_app_url, set_qwc_file_info_app_url)
Default Value
""
Remarks
The URL of your web application.
The domain name specified in this URL must match the domain name specified in qwc_file_info_app_url.
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 qwc_file_info_app_url.
The URL provided in qwc_file_info_app_url 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 property is required.
qwc_file_info_auth_flags Property
This property specifies which versions of QuickBooks your application supports.
Syntax
def get_qwc_file_info_auth_flags() -> str: ... def set_qwc_file_info_auth_flags(value: str) -> None: ...
qwc_file_info_auth_flags = property(get_qwc_file_info_auth_flags, set_qwc_file_info_auth_flags)
Default Value
""
Remarks
This property 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 property is optional.
qwc_file_info_cert_url Property
This property specifies a URL which is used by the QuickBooks Web Connector to obtain and validate the SSL certificate.
Syntax
def get_qwc_file_info_cert_url() -> str: ... def set_qwc_file_info_cert_url(value: str) -> None: ...
qwc_file_info_cert_url = property(get_qwc_file_info_cert_url, set_qwc_file_info_cert_url)
Default Value
""
Remarks
This property 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 property is optional.
qwc_file_info_file_id Property
This property specifies a unique Id.
Syntax
def get_qwc_file_info_file_id() -> str: ... def set_qwc_file_info_file_id(value: str) -> None: ...
qwc_file_info_file_id = property(get_qwc_file_info_file_id, set_qwc_file_info_file_id)
Default Value
""
Remarks
This property 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 qwc_file_info_owner_id.
The storage of this data allows you to perform a Company query (using the Company class) to determine if you've worked with this company file previously. When the Company query is performed specify your qwc_file_info_owner_id 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 property is required.
qwc_file_info_is_read_only Property
Specifies whether read or read/write access is needed.
Syntax
def get_qwc_file_info_is_read_only() -> bool: ... def set_qwc_file_info_is_read_only(value: bool) -> None: ...
qwc_file_info_is_read_only = property(get_qwc_file_info_is_read_only, set_qwc_file_info_is_read_only)
Default Value
FALSE
Remarks
Specifies whether read or read/write access is needed.
This property 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.
qwc_file_info_notify Property
Determines if notification are allowed.
Syntax
def get_qwc_file_info_notify() -> bool: ... def set_qwc_file_info_notify(value: bool) -> None: ...
qwc_file_info_notify = property(get_qwc_file_info_notify, set_qwc_file_info_notify)
Default Value
FALSE
Remarks
Determines if notification are allowed.
This property determines if system tray notification pop-ups are allowed at the application level. The default value is False.
qwc_file_info_owner_id Property
This property specifies an Id which identifies your application.
Syntax
def get_qwc_file_info_owner_id() -> str: ... def set_qwc_file_info_owner_id(value: str) -> None: ...
qwc_file_info_owner_id = property(get_qwc_file_info_owner_id, set_qwc_file_info_owner_id)
Default Value
""
Remarks
This property 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 property is required.
qwc_file_info_personal_data_pref Property
This property defines the type of access to personal/sensitive data required by your application.
Syntax
def get_qwc_file_info_personal_data_pref() -> int: ... def set_qwc_file_info_personal_data_pref(value: int) -> None: ...
qwc_file_info_personal_data_pref = property(get_qwc_file_info_personal_data_pref, set_qwc_file_info_personal_data_pref)
Default Value
0
Remarks
This property 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. |
qwc_file_info_unattended_mode_pref Property
This property specifies whether you need to access QuickBooks in unattended mode (when QuickBooks is closed).
Syntax
def get_qwc_file_info_unattended_mode_pref() -> int: ... def set_qwc_file_info_unattended_mode_pref(value: int) -> None: ...
qwc_file_info_unattended_mode_pref = property(get_qwc_file_info_unattended_mode_pref, set_qwc_file_info_unattended_mode_pref)
Default Value
0
Remarks
This property 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. |
qwc_file_info_update_interval Property
This property specifies the desired update interval in seconds.
Syntax
def get_qwc_file_info_update_interval() -> int: ... def set_qwc_file_info_update_interval(value: int) -> None: ...
qwc_file_info_update_interval = property(get_qwc_file_info_update_interval, set_qwc_file_info_update_interval)
Default Value
0
Remarks
This property 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 property is optional.
qwc_file_info_user Property
This property species the user.
Syntax
def get_qwc_file_info_user() -> str: ... def set_qwc_file_info_user(value: str) -> None: ...
qwc_file_info_user = property(get_qwc_file_info_user, set_qwc_file_info_user)
Default Value
""
Remarks
This property species the user. When QuickBooks Web Connector connects to your application and process_request is called the on_authenticate event will fire and the user and password will be available to you for verification.
This property is required.
request_data Property
The request data to process.
Syntax
def get_request_data() -> str: ... def set_request_data(value: str) -> None: ...
request_data = property(get_request_data, set_request_data)
Default Value
""
Remarks
This property specifies the data to be processed.
Call process_request to process the data.
response_data Property
The response data.
Syntax
def get_response_data() -> str: ... def set_response_data(value: str) -> None: ...
response_data = property(get_response_data, set_response_data)
Default Value
""
Remarks
After calling process_request this property will be populated with the response to be sent back to QuickBooks Web Connector.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
create_qwc_file Method
Creates a QWC file.
Syntax
def create_qwc_file(file_path: str) -> None: ...
Remarks
This method creates a QWC file on disk at the specified FilePath.
The QWCFileInfo* properties define the specific requirements of the file.
The following properties are required:
- qwc_file_info_app_description
- qwc_file_info_app_name
- qwc_file_info_app_support_url
- qwc_file_info_app_url
- qwc_file_info_file_id
- qwc_file_info_owner_id
- qwc_file_info_user
The overwrite property determines the behavior if the file already exists.
process_request Method
Processes the request.
Syntax
def process_request() -> None: ...
Remarks
This method processes the request. A request is made by QuickBooks Web Connector to your web based application. The request must be read from the HTTP context by your application and passed to the request_data 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:
- on_authenticate
- on_client_version
- on_close_connection
- on_connection_error
- on_get_interactive_url
- on_get_last_error
- on_interactive_done
- on_interactive_rejected
- on_receive_response
- on_send_request
- on_server_version
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 response_data property will be populated. You must then send the response in your code.
When sending the response you MUST set the Content-Type header to "text/xml".
on_authenticate Event
Fired when the QuickBooks Web Connector authenticates.
Syntax
class QBWCServerAuthenticateEventParams(object): @property def user() -> str: ... @property def password() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... @property def busy() -> bool: ... @busy.setter def busy(value) -> None: ... @property def no_work() -> bool: ... @no_work.setter def no_work(value) -> None: ... @property def session_ticket() -> str: ... @session_ticket.setter def session_ticket(value) -> None: ... @property def company_file() -> str: ... @company_file.setter def company_file(value) -> None: ... @property def update_delay() -> int: ... @update_delay.setter def update_delay(value) -> None: ... @property def update_interval() -> int: ... @update_interval.setter def update_interval(value) -> None: ... # In class QBWCServer: @property def on_authenticate() -> Callable[[QBWCServerAuthenticateEventParams], None]: ... @on_authenticate.setter def on_authenticate(event_hook: Callable[[QBWCServerAuthenticateEventParams], None]) -> None: ...
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 class 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.
on_client_version Event
Provides the QuickBooks Web Connector version information.
Syntax
class QBWCServerClientVersionEventParams(object): @property def client_version() -> str: ... @property def required_version() -> str: ... @required_version.setter def required_version(value) -> None: ... @property def error_message() -> str: ... @error_message.setter def error_message(value) -> None: ... @property def warning_message() -> str: ... @warning_message.setter def warning_message(value) -> None: ... # In class QBWCServer: @property def on_client_version() -> Callable[[QBWCServerClientVersionEventParams], None]: ... @on_client_version.setter def on_client_version(event_hook: Callable[[QBWCServerClientVersionEventParams], None]) -> None: ...
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.
on_close_connection Event
Fires when the update session completes.
Syntax
class QBWCServerCloseConnectionEventParams(object): @property def session_ticket() -> str: ... @property def response_message() -> str: ... @response_message.setter def response_message(value) -> None: ... # In class QBWCServer: @property def on_close_connection() -> Callable[[QBWCServerCloseConnectionEventParams], None]: ... @on_close_connection.setter def on_close_connection(event_hook: Callable[[QBWCServerCloseConnectionEventParams], None]) -> None: ...
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.
on_connection_error Event
Fires when QuickBooks Web Connector is unable to connect to QuickBooks.
Syntax
class QBWCServerConnectionErrorEventParams(object): @property def session_ticket() -> str: ... @property def error_code() -> str: ... @property def error_message() -> str: ... @property def company_file() -> str: ... @company_file.setter def company_file(value) -> None: ... # In class QBWCServer: @property def on_connection_error() -> Callable[[QBWCServerConnectionErrorEventParams], None]: ... @on_connection_error.setter def on_connection_error(event_hook: Callable[[QBWCServerConnectionErrorEventParams], None]) -> None: ...
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.
on_error Event
Information about errors during data delivery.
Syntax
class QBWCServerErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class QBWCServer: @property def on_error() -> Callable[[QBWCServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[QBWCServerErrorEventParams], None]) -> None: ...
Remarks
The on_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.
on_get_interactive_url Event
Fires when the URL for an interactive session is needed.
Syntax
class QBWCServerGetInteractiveURLEventParams(object): @property def session_ticket() -> str: ... @property def url() -> str: ... @url.setter def url(value) -> None: ... # In class QBWCServer: @property def on_get_interactive_url() -> Callable[[QBWCServerGetInteractiveURLEventParams], None]: ... @on_get_interactive_url.setter def on_get_interactive_url(event_hook: Callable[[QBWCServerGetInteractiveURLEventParams], None]) -> None: ...
Remarks
This event fires when QuickBooks Web Connector requests the URL for an interactive session.
If you set the InteractiveMode parameter in the on_get_last_error 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.
on_get_last_error Event
Fires when QuickBooks Web Connector checks for error information.
Syntax
class QBWCServerGetLastErrorEventParams(object): @property def session_ticket() -> str: ... @property def pause() -> bool: ... @pause.setter def pause(value) -> None: ... @property def interactive_mode() -> bool: ... @interactive_mode.setter def interactive_mode(value) -> None: ... @property def error_message() -> str: ... @error_message.setter def error_message(value) -> None: ... # In class QBWCServer: @property def on_get_last_error() -> Callable[[QBWCServerGetLastErrorEventParams], None]: ... @on_get_last_error.setter def on_get_last_error(event_hook: Callable[[QBWCServerGetLastErrorEventParams], None]) -> None: ...
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 on_send_request fires.
- You set the Request parameter inside on_send_request to empty string.
- QuickBooks Web Connector determines the empty request as an error and makes a call which fires the on_get_last_error 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 on_send_request 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 on_get_interactive_url event will fire. If the user declines, QuickBooks Web Connector will report this and the on_interactive_rejected event will fire.
ErrorMessage may be set to any string which will be reported to the QuickBooks Web Connector.
on_interactive_done Event
This event fires when QuickBooks Web Connector checks to see if the interactive session is finished.
Syntax
class QBWCServerInteractiveDoneEventParams(object): @property def session_ticket() -> str: ... @property def response() -> str: ... @response.setter def response(value) -> None: ... # In class QBWCServer: @property def on_interactive_done() -> Callable[[QBWCServerInteractiveDoneEventParams], None]: ... @on_interactive_done.setter def on_interactive_done(event_hook: Callable[[QBWCServerInteractiveDoneEventParams], None]) -> None: ...
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.
on_interactive_rejected Event
This event fires after a user rejects an interactive session.
Syntax
class QBWCServerInteractiveRejectedEventParams(object): @property def session_ticket() -> str: ... @property def reason_message() -> str: ... @property def response_message() -> str: ... @response_message.setter def response_message(value) -> None: ... # In class QBWCServer: @property def on_interactive_rejected() -> Callable[[QBWCServerInteractiveRejectedEventParams], None]: ... @on_interactive_rejected.setter def on_interactive_rejected(event_hook: Callable[[QBWCServerInteractiveRejectedEventParams], None]) -> None: ...
Remarks
This event fires after a user rejects an interactive session. After requesting an interactive session within on_get_last_error 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.
on_receive_response Event
Fires when a response is received.
Syntax
class QBWCServerReceiveResponseEventParams(object): @property def session_ticket() -> str: ... @property def response() -> str: ... @property def error_code() -> str: ... @property def error_message() -> str: ... @property def success() -> bool: ... @property def percent_done() -> int: ... @percent_done.setter def percent_done(value) -> None: ... # In class QBWCServer: @property def on_receive_response() -> Callable[[QBWCServerReceiveResponseEventParams], None]: ... @on_receive_response.setter def on_receive_response(event_hook: Callable[[QBWCServerReceiveResponseEventParams], None]) -> None: ...
Remarks
This event fires after on_send_request 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 classs 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 on_send_request 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 on_get_last_error to fire.
The default value is 100, which indicates there is no more work to do for this session.
on_send_request Event
Fires when QuickBooks Web Connector asks for a request.
Syntax
class QBWCServerSendRequestEventParams(object): @property def session_ticket() -> str: ... @property def company_response() -> str: ... @property def host_response() -> str: ... @property def prefs_response() -> str: ... @property def company_file() -> str: ... @property def qbxml_country() -> str: ... @property def qbxml_major_version() -> int: ... @property def qbxml_minor_version() -> int: ... @property def request() -> str: ... @request.setter def request(value) -> None: ... # In class QBWCServer: @property def on_send_request() -> Callable[[QBWCServerSendRequestEventParams], None]: ... @on_send_request.setter def on_send_request(event_hook: Callable[[QBWCServerSendRequestEventParams], None]) -> None: ...
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 class. 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 class. 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 class. 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 classs 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 on_get_last_error will fire. This approach may be used if you wish to return an error, request interactive mode, or introduce a brief pause.
on_server_version Event
Fires when QuickBooks Web Connector requests the version of your application.
Syntax
class QBWCServerServerVersionEventParams(object): @property def version() -> str: ... @version.setter def version(value) -> None: ... # In class QBWCServer: @property def on_server_version() -> Callable[[QBWCServerServerVersionEventParams], None]: ... @on_server_version.setter def on_server_version(event_hook: Callable[[QBWCServerServerVersionEventParams], None]) -> None: ...
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.
QBWCServer Config Settings
The class 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 class, 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 create_qwc_file. It specifies whether the application
will connect to QuickBooks, or QuickBooks POS (Point of Sale). Possible values are:
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 create_qwc_file. It specifies the SOAP encoding
style used in the requests made by QuickBooks Web Connector.
When using the QBWCServer class to process requests this should not be set.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to True tells the class 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. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
QBWCServer Errors
ErrorsThe following errors may be generated by the class. 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 qb_request_id 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 qbxml_version 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. |