Address Control
Properties Methods Events Config Settings Errors
An Address represents a geographical address.
Syntax
Address
Remarks
Address is a utility object which allows the user to easily edit and copy addresses. It is designed to interact with other controls, rather than QuickBooks.
To add an address to another control, such as a Customer, first instantiate an Address control, and set any or all of the properties: Line1, Line2, Line3, Line4, Line5, City, State, PostalCode, and Country. Then, the Aggregate property may be used to construct an aggregate of the entire address. This aggregate should be passed to the other control.
Example
Address1.Line1 = "100 Main Street"
Address1.City = "Anytown"
Address1.State = "CA"
Customer1.BillingAddress = Address1.Aggregate
The same process may be used in reverse to get an address from another control.
For example, this pseudocode will get the address of a Vendor:
Vendor.Get("ACME Inc.")
Address.Aggregate = Vendor.Address
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| Aggregate | The entire address. |
| City | The city. |
| Country | The country. |
| Line1 | The first line of the address. |
| Line2 | The second line of the address. |
| Line3 | The third line of the address. |
| Line4 | The fourth line of the address. |
| Line5 | The fifth line of the address. |
| Note | Note line of the address aggregate. |
| PostalCode | The postal code. |
| State | The state. |
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. |
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. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| 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. |
| Name | The name associated with the address. |
| 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. |
| 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. |
Aggregate Property (Address Control)
The entire address.
Syntax
addresscontrol.Aggregate[=string]
Default Value
""
Remarks
An aggregate consisting of the entire address, formatted as XML without end tags. Address properties of the various controls accept and return data in this format exclusively.
When this property is read, an aggregate is formed from the value of all the other properties. When the property is written, the input is parsed and the various properties are set. Reading or writing the value of this property will also escape or unescape special characters such as '&', as appropriate.
There is generally no need to generate or inspect the value of Aggregate by hand. This property allows the user to easily pass data between instances of an Address control, or between an Address control and a QuickBooks object control.
It is, however, possible, to generate the value by hand, and use this value directly in other controls as an alternative to using the Address control. The formatting is as in QBXML; any or all fields may be left out:
<Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>
Data Type
String
City Property (Address Control)
The city.
Syntax
addresscontrol.City[=string]
Default Value
""
Remarks
The city in the address.
Data Type
String
Country Property (Address Control)
The country.
Syntax
addresscontrol.Country[=string]
Default Value
""
Remarks
The country. If not specified, assumed to be the United States.
Data Type
String
Line1 Property (Address Control)
The first line of the address.
Syntax
addresscontrol.Line1[=string]
Default Value
""
Remarks
The first line of the address.
Data Type
String
Line2 Property (Address Control)
The second line of the address.
Syntax
addresscontrol.Line2[=string]
Default Value
""
Remarks
The second line of the address.
Data Type
String
Line3 Property (Address Control)
The third line of the address.
Syntax
addresscontrol.Line3[=string]
Default Value
""
Remarks
The third line of the address.
Data Type
String
Line4 Property (Address Control)
The fourth line of the address.
Syntax
addresscontrol.Line4[=string]
Default Value
""
Remarks
The fourth line of the address. Requires QuickBooks 2003. Used when parsing block addresses.
Data Type
String
Line5 Property (Address Control)
The fifth line of the address.
Syntax
addresscontrol.Line5[=string]
Default Value
""
Remarks
The fifth line of the address. This line is only applicable when QBXMLVersion is "6.0" or greater in the control using the address aggregate.
Data Type
String
Note Property (Address Control)
Note line of the address aggregate.
Syntax
addresscontrol.Note[=string]
Default Value
""
Remarks
Not all controls support this Note line in the address aggregate. For those that do, QBXMLVersion must be "6.0" or greater to use this property.
Data Type
String
PostalCode Property (Address Control)
The postal code.
Syntax
addresscontrol.PostalCode[=string]
Default Value
""
Remarks
The postal or zip code.
Data Type
String
State Property (Address Control)
The state.
Syntax
addresscontrol.State[=string]
Default Value
""
Remarks
The state in the address.
In the Employee control State must be a valid two-letter abbreviation for a U.S. state.
For Canadian editions of QuickBooks, State represents the province instead.
Data Type
String
Config Method (Address Control)
Sets or retrieves a configuration setting.
Syntax
addresscontrol.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.
Error Event (Address Control)
Information about errors during data delivery.
Syntax
Sub addresscontrol_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.
Config Settings (Address 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.Address Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name: The name associated with the address.Use this config to include a Name in the address aggregate. Required for ShipTo addresses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Address Control)
ErrorsAddress Errors
| 20813 The address is invalid. |