Company Control
Properties Methods Events Config Settings Errors
The Company control is used to retrieve information about the QuickBooks company.
Syntax
Company
Remarks
To retrieve information about the QuickBooks company, simply invoke Get. A variety of information will be returned, and may be accessed via read-only properties such as CompanyName, Address, etc. Note that the control allows only read-only access to company information; any changes must be done from within the QuickBooks UI.
The QuickBooks connection may be configured as with other controls in the package.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| Address | Company address. |
| CompanyName | Company name. |
| CompanyType | The type of company. |
| EIN | The EIN of the company. |
| Company email address. | |
| Fax | Company fax number. |
| FileId | Identifies a company file. |
| FirstMonthFiscal | The first month in the company's fiscal year. |
| FirstMonthTax | The first month in the company's tax year. |
| LegalAddress | Legal company address. |
| LegalName | Legal company name. |
| OwnerId | The Id of an application. |
| Phone | Company phone number. |
| QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
| QBRequestAggregate | The request aggregate. |
| QBRequestMode | Defines whether the request is made online or stored offline. |
| QBResponseAggregate | The last QBXML response aggregate received from QuickBooks. |
| QBXMLVersion | The version of QBXML used in the outgoing message. |
| ServiceCount | The number of records in the Service arrays. |
| ServiceDomain | Indicates the provider of the service that the company is (or has been) subscribed to. |
| ServiceName | The name of the Intuit service that the company is (or has been) subscribed to. |
| ServiceStatus | The status of the Intuit service that the company is (or has been) subscribed to. |
| ShipToAddress | Company shipping address. |
| SSN | The SSN of the company. |
| TaxForm | The tax form used by the company. |
| Website | Company website URL. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Get | Gets the company information from QuickBooks. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Shows the progress of the QuickBooks connection. |
| Warning | Fired when a warning occurs. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
| GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
| GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| QBConnectionMode | The mode of connection to QuickBooks. |
| QBFileStatus | The status of the company file as it pertains to accepting connections. |
| QBOpenCompanyFile | The file currently open in QuickBooks. |
| SendRawXML | Sends specified XML to quickbooks without modification. |
| SSLAcceptServerCert | The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector). |
| SSLAcceptServerCertFile | The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector). |
| StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
| UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
| WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |
Address Property (Company Control)
Company address.
Syntax
companycontrol.Address
Default Value
""
Remarks
The address of the QuickBooks company.
The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.
To read an address, set the Aggregate property of an Address control to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.
To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>
This property is read-only.
Data Type
String
CompanyName Property (Company Control)
Company name.
Syntax
companycontrol.CompanyName
Default Value
""
Remarks
The name of the QuickBooks company.
This property is read-only.
Data Type
String
CompanyType Property (Company Control)
The type of company.
Syntax
companycontrol.CompanyType
Default Value
""
Remarks
The type of company, as originally chosen by the QuickBooks user.
This property is read-only.
Data Type
String
EIN Property (Company Control)
The EIN of the company.
Syntax
companycontrol.EIN
Default Value
""
Remarks
The EIN (Employer Identification Number) of the company.
To retrieve this property, you must set QBXMLVersion to "2.0" or greater.
This property is read-only.
Data Type
String
Email Property (Company Control)
Company email address.
Syntax
companycontrol.Email
Default Value
""
Remarks
The email address of the QuickBooks company.
This property is read-only.
Data Type
String
Fax Property (Company Control)
Company fax number.
Syntax
companycontrol.Fax
Default Value
""
Remarks
The fax number of the QuickBooks company.
This property is read-only.
Data Type
String
FileId Property (Company Control)
Identifies a company file.
Syntax
companycontrol.FileId
Default Value
""
Remarks
This property will be populated after a call to Get if OwnerId was specified in the request.
This is commonly used to identify if the company file has previously been accessed by your application identified by OwnerId.
This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is
{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}
where X is a hexadecimal digit. For example:
{6B063959-81B0-4622-85D6-F548C8CCB517}
This property is read-only.
Data Type
String
FirstMonthFiscal Property (Company Control)
The first month in the company's fiscal year.
Syntax
companycontrol.FirstMonthFiscal
Default Value
""
Remarks
The first month in the company's fiscal year. Will be the name of the month (i.e., "January", "February", etc.)
This property is read-only.
Data Type
String
FirstMonthTax Property (Company Control)
The first month in the company's tax year.
Syntax
companycontrol.FirstMonthTax
Default Value
""
Remarks
The first month in the company's tax year. Will be the name of the month (i.e., "January", "February", etc.)
This property is read-only.
Data Type
String
LegalAddress Property (Company Control)
Legal company address.
Syntax
companycontrol.LegalAddress
Default Value
""
Remarks
The legal address of the QuickBooks company.
The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.
To read an address, set the Aggregate property of an Address control to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.
To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>
This property is read-only.
Data Type
String
LegalName Property (Company Control)
Legal company name.
Syntax
companycontrol.LegalName
Default Value
""
Remarks
The legal name of the QuickBooks company.
This property is read-only.
Data Type
String
OwnerId Property (Company Control)
The Id of an application.
Syntax
companycontrol.OwnerId[=string]
Default Value
""
Remarks
This property specifies the Id of an application. It is commonly used in conjunction with the QBWCServer control to check if the application has previously communicated with the specified company file in the past.
If this property is set before calling Get, QuickBooks will return a value for FileId (if one exists). This can be compared to a known FileId value to determine if your application has previously worked with this file.
This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is
{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}
where X is a hexadecimal digit. For example:
{6B063959-81B0-4622-85D6-F548C8CCB517}
Data Type
String
Phone Property (Company Control)
Company phone number.
Syntax
companycontrol.Phone
Default Value
""
Remarks
The phone number of the QuickBooks company.
This property is read-only.
Data Type
String
QBConnectionString Property (Company Control)
An aggregate consisting of various QuickBooks connection properties.
Syntax
companycontrol.QBConnectionString[=string]
Default Value
""
Remarks
QBConnectionString allows the user to customize the application's interaction with QuickBooks.
The connection properties should be formatted in a sequence as follows:
propertyname = "propertyvalue" propertyname = "propertyvalue" ...
The order is irrelevant, and the whitespace around the equal sign is optional.
The following properties are currently supported:
| ApplicationName | The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access. |
| CompanyFile | The name of the company file to open. If QuickBooks is not currently open with a company
file, QuickBooks will be automatically opened in the background with the file specified.
Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the
application UI, only that company file may be used.
This setting is not applicable when communicating with QB Connector. |
| URL | The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the control will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the control's request to QuickBooks, and return the response. |
| User | A username for the Remote Connector connection (if required on the Connector side) |
| Password | A password for the Remote Connector connection (if required on the Connector side) |
| Timeout | A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the control will generate an exception instead of hanging. |
| DelayAfterClose | A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem. |
| FirewallHost | Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting. |
| FirewallPassword | Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error. |
| FirewallPort | Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value. |
| FirewallType | Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080. |
| FirewallUser | Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error. |
| ProxyAuthorization | Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication. |
| ProxyPassword | Contains a password if authentication is to be used for the proxy. |
| ProxyPort | Contains the TCP port for a ProxyServer; (default 80). |
| ProxySSL | Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy. |
| ProxyServer | If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned. |
| ProxyUser | Contains a user name, if authentication is to be used for the proxy. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the control binds. |
| UseRDS | Whether to connect using Remote Data Sharing (RDS). If set to True, the control will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False. |
Data Type
String
QBRequestAggregate Property (Company Control)
The request aggregate.
Syntax
companycontrol.QBRequestAggregate[=string]
Default Value
""
Remarks
This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer control to generate requests to be sent to QuickBooks Web Connector.
This property is not available at design time.
Data Type
String
QBRequestMode Property (Company Control)
Defines whether the request is made online or stored offline.
Syntax
companycontrol.QBRequestMode[=integer]
Possible Values
rmOnline(0), rmOffline(1)
Default Value
0
Remarks
This property defines the behavior of the control when calling a method. Possible values are:
| 0 (rmOnline - default) | The request is made normally. |
| 1 (rmOffline) | The request is generated but not sent, and QBRequestAggregate is populated. |
For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.
Data Type
Integer
QBResponseAggregate Property (Company Control)
The last QBXML response aggregate received from QuickBooks.
Syntax
companycontrol.QBResponseAggregate[=string]
Default Value
""
Remarks
The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.
This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the control will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.
This property is not available at design time.
Data Type
String
QBXMLVersion Property (Company Control)
The version of QBXML used in the outgoing message.
Syntax
companycontrol.QBXMLVersion[=string]
Default Value
"3.0"
Remarks
The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.
With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:
| QuickBooks 2002 | 1.0, 1.1 |
| QuickBooks 2003 | 2.0 |
| QuickBooks 2004 | 3.0 |
| QuickBooks 2005 | 4.0, 4.1 |
| QuickBooks 2006 | 5.0 |
| QuickBooks 2007 | 6.0 |
| QuickBooks 2008 | 7.0 |
| QuickBooks 2009 | 8.0 |
| QuickBooks 2010 | 9.0 |
| QuickBooks 2011 | 10.0 |
| QuickBooks 2012 | 11.0 |
| QuickBooks 2013 | 12.0 |
| QuickBooks 2014 | 13.0 |
| QuickBooks 2015 | 14.0 |
| QuickBooks 2016 | 15.0 |
| QuickBooks Canadian 2003 | CA2.0 |
| QuickBooks Canadian 2004 to 2007 | CA3.0 |
| QuickBooks UK 2003 | UK2.0 |
| QuickBooks UK 2004 to 2007 | UK3.0 |
| QuickBooks Australian 2003 | OZ2.0 |
| QuickBooks Australian 2004 to 2007 | AU3.0 |
This property is not available at design time.
Data Type
String
ServiceCount Property (Company Control)
The number of records in the Service arrays.
Syntax
companycontrol.ServiceCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServiceCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ServiceDomain Property (Company Control)
Indicates the provider of the service that the company is (or has been) subscribed to.
Syntax
companycontrol.ServiceDomain(ServiceIndex)
Default Value
""
Remarks
Indicates the provider of the service that the company is (or has been) subscribed to. For example: "Intuit".
The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.
This property is read-only and not available at design time.
Data Type
String
ServiceName Property (Company Control)
The name of the Intuit service that the company is (or has been) subscribed to.
Syntax
companycontrol.ServiceName(ServiceIndex)
Default Value
""
Remarks
The name of the Intuit service that the company is (or has been) subscribed to.
The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.
This property is read-only and not available at design time.
Data Type
String
ServiceStatus Property (Company Control)
The status of the Intuit service that the company is (or has been) subscribed to.
Syntax
companycontrol.ServiceStatus(ServiceIndex)
Default Value
""
Remarks
The status of the Intuit service that the company is (or has been) subscribed to.
The ServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.
This property is read-only and not available at design time.
Data Type
String
ShipToAddress Property (Company Control)
Company shipping address.
Syntax
companycontrol.ShipToAddress
Default Value
""
Remarks
The shipping address of the QuickBooks company (as it will appear on purchase orders).
The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.
To read an address, set the Aggregate property of an Address control to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.
To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>
This property is read-only.
Data Type
String
SSN Property (Company Control)
The SSN of the company.
Syntax
companycontrol.SSN
Default Value
""
Remarks
The Social Security Number, used if no EIN has been issued by the government.
To retrieve this property, you must set QBXMLVersion to "2.1" or greater.
This property is read-only.
Data Type
String
TaxForm Property (Company Control)
The tax form used by the company.
Syntax
companycontrol.TaxForm
Default Value
""
Remarks
The tax form used by the company. Will be one of the following values: "Form1120", "Form1120S", "Form1065", "Form990", "Form990PF", "Form990T", "Form1040", "OtherOrNone".
To retrieve this property, you must set QBXMLVersion to "2.1" or greater.
This property is read-only.
Data Type
String
Website Property (Company Control)
Company website URL.
Syntax
companycontrol.Website
Default Value
""
Remarks
The web URL of the QuickBooks company.
This property is read-only.
Data Type
String
Config Method (Company Control)
Sets or retrieves a configuration setting.
Syntax
companycontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.
Get Method (Company Control)
Gets the company information from QuickBooks.
Syntax
companycontrol.Get
Remarks
When you invoke Get, the control will get the company information from QuickBooks, using the connection information provided in QBConnectionString, QBXMLVersion, and elsewhere. When the method returns you may retrieve the appropriate information from the relevant properties.
Error Event (Company Control)
Information about errors during data delivery.
Syntax
Sub companycontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
SSLServerAuthentication Event (Company Control)
Fired after the server presents its certificate to the client.
Syntax
Sub companycontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Company Control)
Shows the progress of the secure connection.
Syntax
Sub companycontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Status Event (Company Control)
Shows the progress of the QuickBooks connection.
Syntax
Sub companycontrol_Status(Message As String)
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Warning Event (Company Control)
Fired when a warning occurs.
Syntax
Sub companycontrol_Warning(Code As Integer, Description As String)
Remarks
The Warning event is fired when the control has produced, or will produce, possibly unexpected results.
Warnings may be generated by QuickBooks or the control. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.
| 510* | Object added successfully, but cannot now be read. |
| 520* | Insufficient permissions to get all data. |
| 801 | Unable to update field (name). |
| 802 | Unable to parse name. |
Warning 801 will be thrown if the user attempts to Update properties
that cannot be updated. For example, the following code will cause this warning
to be fired:
Customer1.GetByName("Joe Smith")
Customer1.Email = "joe@abc.com" 'ok
Customer1.CreditLimit = "200.00" 'Not used in Update operations!
Customer1.Update()
Only the email address will be updated, and the credit limit will be unchanged.
Each property description for entity objects lists whether or not it is used
in Update operations.
Config Settings (Company Control)
The control 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 control, access to these internal properties is provided through the Config method.Company Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AppendAfter: Appends an XML tag after the specified QBXML element.Write-only; Appends the specified text after the specified QBXML element (whether the QBXML element is present). This may be useful to extend the functionality of the component beyond what is provided. Example: Control1.Config("AppendAfter:ListID=<WeirdNewField>abc</WeirdNewField>") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthFlags:
Connection Flags (use for QuickBooks Simple Start).Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By
default, the control can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks
Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does
not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.
A list of allowable AuthFlags is provided below.
To specify support for multiple editions, OR together the values for each edition. NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EnforceMaxLength: Indicates whether to enforce max lengths for QB Fields.If you change this setting to False, the control will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GetHighestVersion: Highest QBXMLVersion supported by the installed instance of QuickBooks.If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to QuickBooks. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GetRequestProcessorDLLVersion: Returns the version of the QB Request Processor that is installed on your system. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GetSupportedVersions: Returns a list of QBXMLVersions that are supported by QuickBooks.If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IsReadOnly: This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.The default value is false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PersonalDataPref:
Whether the connecting application will require access to personal data such as SSN or credit card information.This setting allows you to let the user know immediately whether your application requires access to personal data or not.
A list of available values is provided below.
The default value is pdpOptional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QBConnectionMode:
The mode of connection to QuickBooks.Specifies whether the integrated application logs in using single-user or multi-user mode.
The following values are permitted:
About Single-User and Multi-User Modes If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well. If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out. If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode. About Integrated and Automatic Login Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection. Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified. By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically. For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QBFileStatus:
The status of the company file as it pertains to accepting connections.This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When
queried the control will attempt to determine whether a subsequent connection using the provided QBConnectionString
value would succeed. Possible return values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QBOpenCompanyFile:
The file currently open in QuickBooks.The name of the file currently open in QuickBooks, specified completely with
the path. This field is read-only.
A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs. If the value of this property is nonempty, the control may interact exclusively with the open file. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SendRawXML: Sends specified XML to quickbooks without modification.Available for write only. Immediately sends the specified XML over the current or default QuickBooks connection (as specified elsewhere), and returns the QBXML response. Syntax: Control1.Config("SendRawXML=<?xml version="1.0" ?>...") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLAcceptServerCert:
The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
The Base-64 encoded certificate being used by the Remote Connector (you may get this
certificate from the Remote Connector by going to the Security tab, and clicking Export.)
This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLAcceptServerCertFile:
The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
If your public key certificate is stored in a file, you may set this configuration setting
to the full path of the certificate, and it will be immediately read from disk and stored in
SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.
Reading the value of this setting will return an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StopOnError: Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UnattendedModePref:
Whether connecting while QuickBooks is closed is required or optional for the user.This setting allows you to let the user know immediately whether your application
requires the ability to access QuickBooks while QuickBooks is closed.
A list of available values is provided below.
The default value is umpOptional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.By default, the control will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 to mask sensitive data. The default is .
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the control whether or not to use the system security libraries or an internal implementation.
When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the control to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms. |
Trappable Errors (Company Control)
ErrorsThe following errors may be generated by the control. Note that frequently the error message will contain more specific information than what is listed here.
Company Errors
| 20102 String too long. | |
| 20104 Invalid date format (YYYY-MM-DD is standard). | |
| 20105 Invalid value for enumerated field. | |
| 20106 Invalid integer. | |
| 20107 Invalid dollar amount. | |
| 20108 Invalid boolean value (must be 'true' or 'false'). | |
| 20109 Invalid number. | |
| 20112 Invalid special characters in string. | |
| 20113 Invalid special field syntax. | |
| 20182 Could not load certificate file. | |
| 20202 Required field unspecified. | |
| 20212 Unsupported field specified. | |
| 20302 Array line count must be nonnegative. | |
| 20303 Array index out of bounds. | |
| 20304 Invalid field index. | |
| 20402 Field not accessible as a special field. | |
| 20403 Write access attempted of readonly field. | |
| 20404 Read access attempted of writeonly field. | |
| 20422 The object cannot be modified. | |
| 20512 The QBRequestId has been previously used. Please generate a new one. | |
| 20602 Could not access QuickBooks. | |
| 20603 Could not open specified file. | |
| 20604 The version of QuickBooks currently being used is not supported. | |
| 20605 QuickBooks has not been installed properly. | |
| 20606 The specified file was of an incorrect version. | |
| 20607 Could not start QuickBooks. | |
| 20608 QuickBooks is open in a mode different than the one requested. | |
| 20609 QuickBooks cannot currently be accessed. | |
| 20610 An application name must be specified. | |
| 20611 A file name must be specified if one is not currently open in QuickBooks. | |
| 20612 Access denied. | |
| 20613 QuickBooks is busy and cannot open your application in the mode requested. | |
| 20700 The connection to QuickBooks has failed for an unknown reason. | |
| 20703 The object requested does not exist in QuickBooks. | |
| 20752 Unsupported QBXML version. | |
| 20753 The QBXMLVersion chosen is insufficient to execute the request. | |
| 20802 A QuickBooks internal error has occurred. | |
| 20803 QuickBooks is not available due to a system-related problem. | |
| 20804 The Id specified is invalid. | |
| 20805 Invalid object name. | |
| 20806 The name already exists in QuickBooks. | |
| 20808 An object could not be found in QuickBooks. | |
| 20809 A reference did not refer to an object that exists in QuickBooks. | |
| 20810 The object is currently in use by the QuickBooks end user. | |
| 20811 The object may not be added. | |
| 20812 The object may not be updated because it is obsolete. | |
| 20813 The address is invalid. | |
| 20814 Permission to perform this operation is not granted. | |
| 20815 The request has not been processed. | |
| 20816 Time creation mismatch. | |
| 20817 The feature is turned off or not enabled. | |
| 20818 Permission level configured is insufficient for access. | |
| 20819 The item specified was of an unknown type. | |
| 20820 The object may not be changed. | |
| 20821 An internal QuickBooks error has occurred. | |
| 20822 An attempt was made to use a connection that was not properly initiated. | |
| 20823 An attempt was made to use a connection that is invalid or was previously closed. | |
| 20824 Not enough memory. | |
| 20825 Unable to lock the necessary information to allow this application access to the company file. Try again later. | |
| 20851 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit. | |
| 20852 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system. | |
| 20862 Server error on WebExport (details follow). | |
| 20863 The WebExport is impossible: an HTTP context was not found. | |
| 20872 You may not set the value of QBConnectionTicket. This value is readonly. | |
| 20881 Interrupted by the user. | |
| 20882 An error has occurred connecting to a remote machine. | |
| 20900 An unknown QuickBooks error has occurred. The message contains more details. | |
| 20902 XML Parser Error. Should not occur under normal circumstances. |