Address Class
Properties Methods Events Configuration Settings Errors
An Address represents a geographical address.
Syntax
class 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, postal_code, 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.AggregateThe 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.
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. |
postal_code | The postal code. |
state | The 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.
config | Sets 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.
on_error | Information 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.
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 Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the 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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |