QuickBooks Integrator 2022 C++ Builder Edition
Version 22.0 [Build 8594]

Address Component

Properties   Methods   Events   Config Settings   Errors  

An Address represents a geographical address.

Syntax

TiqbAddress

Remarks

Address is a utility object which allows the user to easily edit and copy addresses. It is designed to interact with other components, rather than QuickBooks.

To add an address to another component, such as a Customer, first instantiate an Address component, 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 component.

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 component. 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 component with short descriptions. Click on the links for further details.

AggregateThe entire address.
CityThe city.
CountryThe country.
Line1The first line of the address.
Line2The second line of the address.
Line3The third line of the address.
Line4The fourth line of the address.
Line5The fifth line of the address.
NoteNote line of the address aggregate.
PostalCodeThe postal code.
StateThe state.

Method List


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

ConfigSets or retrieves a configuration setting.

Event List


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

ErrorInformation about errors during data delivery.

Config Settings


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

AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
NameThe name associated with the address.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SSLAcceptServerCertThe SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFileThe SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Aggregate Property (Address Component)

The entire address.

Syntax

__property String Aggregate = { read=FAggregate, write=FSetAggregate };

Default Value

""

Remarks

An aggregate consisting of the entire address, formatted as XML without end tags. Address properties of the various components 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 component, or between an Address component and a QuickBooks object component.

It is, however, possible, to generate the value by hand, and use this value directly in other components as an alternative to using the Address component. 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 Component)

The city.

Syntax

__property String City = { read=FCity, write=FSetCity };

Default Value

""

Remarks

The city in the address.

Data Type

String

Country Property (Address Component)

The country.

Syntax

__property String Country = { read=FCountry, write=FSetCountry };

Default Value

""

Remarks

The country. If not specified, assumed to be the United States.

Data Type

String

Line1 Property (Address Component)

The first line of the address.

Syntax

__property String Line1 = { read=FLine1, write=FSetLine1 };

Default Value

""

Remarks

The first line of the address.

Data Type

String

Line2 Property (Address Component)

The second line of the address.

Syntax

__property String Line2 = { read=FLine2, write=FSetLine2 };

Default Value

""

Remarks

The second line of the address.

Data Type

String

Line3 Property (Address Component)

The third line of the address.

Syntax

__property String Line3 = { read=FLine3, write=FSetLine3 };

Default Value

""

Remarks

The third line of the address.

Data Type

String

Line4 Property (Address Component)

The fourth line of the address.

Syntax

__property String Line4 = { read=FLine4, write=FSetLine4 };

Default Value

""

Remarks

The fourth line of the address. Requires QuickBooks 2003. Used when parsing block addresses.

Data Type

String

Line5 Property (Address Component)

The fifth line of the address.

Syntax

__property String Line5 = { read=FLine5, write=FSetLine5 };

Default Value

""

Remarks

The fifth line of the address. This line is only applicable when QBXMLVersion is "6.0" or greater in the component using the address aggregate.

Data Type

String

Note Property (Address Component)

Note line of the address aggregate.

Syntax

__property String Note = { read=FNote, write=FSetNote };

Default Value

""

Remarks

Not all components 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 Component)

The postal code.

Syntax

__property String PostalCode = { read=FPostalCode, write=FSetPostalCode };

Default Value

""

Remarks

The postal or zip code.

Data Type

String

State Property (Address Component)

The state.

Syntax

__property String State = { read=FState, write=FSetState };

Default Value

""

Remarks

The state in the address.

In the Employee component 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 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Event (Address Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiqbAddressErrorEventParams;
typedef void __fastcall (__closure *TiqbAddressErrorEvent)(System::TObject* Sender, TiqbAddressErrorEventParams *e);
__property TiqbAddressErrorEvent OnError = { read=FOnError, write=FOnError };

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

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

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

"" or 0Do not send any auth flags
0x01Support QB Simple Start
0x02Support QB Pro
0x04Support QB Premier
0x08Support QB Enterprise
0x80000000Force Auth Dialog

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

pdpOptionalCauses the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data.
pdpRequiredCauses the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data.
pdpNotNeededCauses the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data.

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:

0Don't Care
1Single-User Mode
2Multi-User Mode

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 component will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are:

0 The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open.
1 The company file will not accept the connection. This indicates a different company file is already open.

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

umpOptionalCauses the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode.
umpRequiredCauses the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode).

The default value is umpOptional.

WarningCodes:   A comma-separated list of QuickBooks warning codes that should not result in an exception.

By default, the component 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

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

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

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

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

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

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

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to false by default on all platforms.

Trappable Errors (Address Component)

Errors

Address Errors

812   The address is invalid.

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