QuickBooks Integrator 2020 Node.js Edition

Questions / Feedback?

Address Class

Properties   Methods   Events   Configuration Settings   Errors  

An Address represents a geographical address.

Syntax

inqb.address()

Remarks

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

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

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

ErrorInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class 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 Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the 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.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Node.js Edition - Version 20.0 [Build 7941]