Customer Control
Properties Methods Events Config Settings Errors
A Customer is anyone who buys goods or services from the QuickBooks company.
Syntax
Customer
Remarks
A Customer is anyone who buys goods or services from the QuickBooks company. A Customer may also be used to represent a sub-customer or Job.
Required Fields (Add): CustomerName
Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete
Example (Adding a customer to QuickBooks)
Customer1.CustomerName = "John Doe"
Customer1.Add()
Contact Information: Contact information may be added, retrieved, or changed.
The key property is CustomerName. CompanyName, ContactName, and AltContactName
may be used to specify additional names/contacts for the customer.
BillingAddress, ShippingAddress, Fax, Email, Phone, and AltPhone
may all be set or changed as well.
Categorization and Financial Information: the following properties are not used in Update operations, and may only be modified from within the QuickBooks UI.
| CustomerType* | The type of customer: residential, commercial, etc. |
| SalesRep* | A sales rep for the customer. |
| TaxItem*, TaxCode* | Taxation information for the customer. |
| Terms* | Terms on which the customer will be billed. |
Tracking Customer Balances:
The Customer control may be used to track the outstanding balances of customers. After invoking Get, simply inspect the Balance property;. The ObjSearch control can be used to find unpaid and paid Invoices tied to this customer.
When a customer is added to QuickBooks, the CreditLimit may be set, and the OpeningBalance (special field) may be set, if there is one. Once a customer is added to QuickBooks, there is no way to modify Balance directly! Instead, Invoices or CreditMemos should be added referencing this customer.
Sub-Customers (Jobs)
QuickBooks allows the user to define customers hierarchically. This allows the QuickBooks user to track transactions involving the Job separately.
To add a job to QuickBooks, set the Parent* property to the parent customer. Then, detailed job information may be provided using Config. When a job is retrieved from QuickBooks, Parent* will refer to the parent customer.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| AccountNumber | Account number for this entity. |
| AltContactName | Alternate contact person for entity. |
| AltPhone | Alternate phone number of entity. |
| Balance | Money owed by this Customer , including sub-customers. |
| BillingAddress | Billing address for customer. |
| CompanyName | Company name of customer or vendor. |
| ContactName | Contact person for a customer or vendor. |
| CreditCardAddress | The address associated with the Number on file for this customer. |
| CreditCardExpMonth | The expiration month associated with the Number on file for this customer. |
| CreditCardExpYear | The expiration year associated with the Number on file for this customer. |
| CreditCardNameOnCard | The name as it appears on the customer's credit card Number . |
| CreditCardNumber | The credit card number on file for this customer. |
| CreditCardPostalCode | The postal code associated with the Address and Number on file for this customer. |
| CreditLimit | Credit limit for this entity. |
| CustomerName | Customer's name. |
| CustomerTypeId | Reference to type of customer. |
| CustomerTypeName | Reference to type of customer. |
| Email address of entity. | |
| Fax | Fax number of entity. |
| IsActive | Whether or not entity is active. |
| Notes | Notes for this transaction. |
| ParentId | Reference to parent Customer . |
| ParentName | Reference to parent Customer . |
| Phone | Phone number of entity. |
| QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
| QBRequestAggregate | The request aggregate. |
| QBRequestId | The Id of the next message to be sent to QuickBooks. |
| 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. |
| RefId | An alphanumerical identifier generated by the server. |
| ResaleNumber | Resale number. |
| SalesRepId | Reference to (initials of) sales rep. |
| SalesRepName | Reference to (initials of) sales rep. |
| ShippingAddress | Shipping address for customer. |
| TaxCodeId | Whether or not transactions with customer are taxable. |
| TaxCodeName | Whether or not transactions with customer are taxable. |
| TaxItemId | Reference to detailed taxation information. |
| TaxItemName | Reference to detailed taxation information. |
| TermsId | Reference to terms of payment. |
| TermsName | Reference to terms of payment. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Add | Adds the record into QuickBooks. |
| CheckRequestStatus | Checks whether or not the specified request was processed by QuickBooks. |
| CloseQBConnection | Closes a persistent connection to QuickBooks. |
| Config | Sets or retrieves a configuration setting. |
| Delete | Deletes the record from QuickBooks. |
| Get | Gets a single record from QuickBooks. |
| GetByName | Gets a single record from QuickBooks. |
| GetCustomField | Gets a custom field value from QuickBooks. |
| ImportQBXML | Imports a QBXML response aggregate. |
| OpenQBConnection | Opens a persistent connection to QuickBooks. |
| Reset | Resets all properties to their defaults. |
| SetCustomField | Sets a custom field value within QuickBooks. |
| Update | Updates the entity object in 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.
| AdditionalContactRefContactName[i] | The name of the additional contact reference. |
| AdditionalContactRefContactValue[i] | The value of the additional contact reference. |
| AdditionalContactRefCount | The count of additional contact references returned. |
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| CurrencyId | The type of currency to use. |
| CurrencyName | The type of currency to use. |
| EditSequence | An identifier for this copy of the object. |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| FirstName | A first name. |
| FullName | The name of the customer. |
| 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. |
| IncludePreferredDeliveryMethod | Whether to include the preferred delivery method. |
| IsActive | Indicates whether the object is currently enabled for use by QuickBooks. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| JobDescription | Description of the job. |
| JobEndDate | Actual end date of the job, YYYY-MM-DD. |
| JobProjectedEndDate | Projected end date of the job, YYYY-MM-DD. |
| JobStartDate | Start date of the job, YYYY-MM-DD. |
| JobStatus | The status of the job. |
| JobTypeId | Reference to the type of job. |
| JobTypeName | Reference to the type of job. |
| LastName | A last name. |
| MiddleInitial | A middle initial. |
| NonInclusiveBalance | The Balance of the Customer, not including sub-customers. |
| OpeningBalance | The opening balance for the customer or vendor. Not used in Update operations. |
| OpeningBalanceDate | The opening balance date for the customer or vendor. Not used in Update operations. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| PreferredDeliveryMethod | The preferred delivery method. |
| PreferredPaymentMethodId | The preferred method of payment. |
| PreferredPaymentMethodName | The preferred method of payment. |
| PriceLevelId | Reference to a price level for the customer. |
| PriceLevelName | Reference to a price level for the customer. |
| 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. |
| Salutation | A salutation, such as Mr., Mrs., etc. |
| SendRawXML | Sends specified XML to quickbooks without modification. |
| SeparateContact | A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName. |
| ShipToAddressAggregate | A list of all shipping addresses associated with a customer. |
| ShipToAddressCount | A count of all shipping addresses associated with a customer. |
| 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. |
| Sublevel | The number of ancestors this Customer has. |
| TimeCreated | The time the object was created. |
| TimeModified | The time the object was created. |
| 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. |
AccountNumber Property (Customer Control)
Account number for this entity.
Syntax
customercontrol.AccountNumber[=string]
Default Value
""
Remarks
The account number for this customer, vendor, or employee.
Data Type
String
AltContactName Property (Customer Control)
Alternate contact person for entity.
Syntax
customercontrol.AltContactName[=string]
Default Value
""
Remarks
An alternate contact person for the customer, vendor, or employee.
Data Type
String
AltPhone Property (Customer Control)
Alternate phone number of entity.
Syntax
customercontrol.AltPhone[=string]
Default Value
""
Remarks
An alternate phone number for the customer, vendor, or employee.
Data Type
String
Balance Property (Customer Control)
Money owed by this Customer , including sub-customers.
Syntax
customercontrol.Balance
Default Value
"0"
Remarks
The amount of money owed by this Customer. Includes money owed by sub-customers (jobs). The NonInclusiveBalance special field provides the balance excluding sub-customers.
The amount should be formatted as a string in dollars.
This property is read-only.
Data Type
String
BillingAddress Property (Customer Control)
Billing address for customer.
Syntax
customercontrol.BillingAddress[=string]
Default Value
""
Remarks
The billing address for the customer.
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>
Data Type
String
CompanyName Property (Customer Control)
Company name of customer or vendor.
Syntax
customercontrol.CompanyName[=string]
Default Value
""
Remarks
The company name of the customer or vendor. If specified, can be identical to the CustomerName or VendorName property.
Data Type
String
ContactName Property (Customer Control)
Contact person for a customer or vendor.
Syntax
customercontrol.ContactName[=string]
Default Value
""
Remarks
The name of a contact person for a customer or vendor.
The name will automatically be parsed and appear in two places in the QuickBooks user interface: in the Contact field, and in the First Name, M.I., Last Name, and Mr./Mrs./... fields. These fields may also be edited separately using Config.
Data Type
String
CreditCardAddress Property (Customer Control)
The address associated with the Number on file for this customer.
Syntax
customercontrol.CreditCardAddress[=string]
Default Value
""
Remarks
The address associated with the CreditCardNumber on file for this customer.
Data Type
String
CreditCardExpMonth Property (Customer Control)
The expiration month associated with the Number on file for this customer.
Syntax
customercontrol.CreditCardExpMonth[=integer]
Default Value
1
Remarks
The expiration month associated with the CreditCardNumber on file for this customer.
Data Type
Integer
CreditCardExpYear Property (Customer Control)
The expiration year associated with the Number on file for this customer.
Syntax
customercontrol.CreditCardExpYear[=integer]
Default Value
0
Remarks
The expiration year associated with the CreditCardNumber on file for this customer.
Data Type
Integer
CreditCardNameOnCard Property (Customer Control)
The name as it appears on the customer's credit card Number .
Syntax
customercontrol.CreditCardNameOnCard[=string]
Default Value
""
Remarks
The name as it appears on the customer's credit card CreditCardNumber.
Data Type
String
CreditCardNumber Property (Customer Control)
The credit card number on file for this customer.
Syntax
customercontrol.CreditCardNumber[=string]
Default Value
""
Remarks
The credit card number on file for this customer.
Data Type
String
CreditCardPostalCode Property (Customer Control)
The postal code associated with the Address and Number on file for this customer.
Syntax
customercontrol.CreditCardPostalCode[=string]
Default Value
""
Remarks
The postal code associated with the CreditCardAddress and CreditCardNumber on file for this customer.
Data Type
String
CreditLimit Property (Customer Control)
Credit limit for this entity.
Syntax
customercontrol.CreditLimit[=string]
Default Value
"0"
Remarks
The credit limit for this customer or vendor. If it is equal to 0, there is no credit limit.
The amount should be formatted as a string in dollars.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
CustomerName Property (Customer Control)
Customer's name.
Syntax
customercontrol.CustomerName[=string]
Default Value
""
Remarks
The customer's name.
In Customer objects that are sub-customers or jobs the CustomerName will be different from the FullName. The FullName may be formed by combining CustomerName with the names of all ancestors, and separating with a colon: for example, "Parent Customer:Full Customer".
FullName is also available as a special field, and may be accessed via Config.
This property is required in Add operations only.
Data Type
String
CustomerTypeId Property (Customer Control)
Reference to type of customer.
Syntax
customercontrol.CustomerTypeId[=string]
Default Value
""
Remarks
CustomerType refers to a predefined customer type within QuickBooks. Typical customer types, if defined, might be "Commercial", "Residential", etc.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
CustomerTypeName Property (Customer Control)
Reference to type of customer.
Syntax
customercontrol.CustomerTypeName[=string]
Default Value
""
Remarks
CustomerType refers to a predefined customer type within QuickBooks. Typical customer types, if defined, might be "Commercial", "Residential", etc.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
Email Property (Customer Control)
Email address of entity.
Syntax
customercontrol.Email[=string]
Default Value
""
Remarks
The email address of the customer, vendor, or employee.
Data Type
String
Fax Property (Customer Control)
Fax number of entity.
Syntax
customercontrol.Fax[=string]
Default Value
""
Remarks
The fax number of the customer or vendor.
Data Type
String
IsActive Property (Customer Control)
Whether or not entity is active.
Syntax
customercontrol.IsActive[=boolean]
Default Value
True
Remarks
This property indicates whether this object is currently enabled for use by QuickBooks.
This property is allowed in Add operations, and the QBXMLVersion must be set to "3.0" or higher for this to be used in Update operations.
Data Type
Boolean
Notes Property (Customer Control)
Notes for this transaction.
Syntax
customercontrol.Notes[=string]
Default Value
""
Remarks
This property may contain any notes you wish to make concerning the transaction.
Data Type
String
ParentId Property (Customer Control)
Reference to parent Customer .
Syntax
customercontrol.ParentId[=string]
Default Value
""
Remarks
This is a reference to a parent Customer. If Parent is set to a nonempty string, then this Customer is a sub-customer or job of its Parent.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
ParentName Property (Customer Control)
Reference to parent Customer .
Syntax
customercontrol.ParentName[=string]
Default Value
""
Remarks
This is a reference to a parent Customer. If Parent is set to a nonempty string, then this Customer is a sub-customer or job of its Parent.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
Phone Property (Customer Control)
Phone number of entity.
Syntax
customercontrol.Phone[=string]
Default Value
""
Remarks
The phone number of the customer, vendor, or employee.
Data Type
String
QBConnectionString Property (Customer Control)
An aggregate consisting of various QuickBooks connection properties.
Syntax
customercontrol.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 (Customer Control)
The request aggregate.
Syntax
customercontrol.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
QBRequestId Property (Customer Control)
The Id of the next message to be sent to QuickBooks.
Syntax
customercontrol.QBRequestId[=string]
Default Value
""
Remarks
The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.
This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.
QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.
To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.
Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.
This property is not available at design time.
Data Type
String
QBRequestMode Property (Customer Control)
Defines whether the request is made online or stored offline.
Syntax
customercontrol.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 (Customer Control)
The last QBXML response aggregate received from QuickBooks.
Syntax
customercontrol.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 (Customer Control)
The version of QBXML used in the outgoing message.
Syntax
customercontrol.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
RefId Property (Customer Control)
An alphanumerical identifier generated by the server.
Syntax
customercontrol.RefId
Default Value
""
Remarks
A RefId is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.
This property is required in Update operations, and not used in Add operations.
This property is read-only and not available at design time.
Data Type
String
ResaleNumber Property (Customer Control)
Resale number.
Syntax
customercontrol.ResaleNumber[=string]
Default Value
""
Remarks
The resale number of the Customer, if he/she has one.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
SalesRepId Property (Customer Control)
Reference to (initials of) sales rep.
Syntax
customercontrol.SalesRepId[=string]
Default Value
""
Remarks
A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.
Data Type
String
SalesRepName Property (Customer Control)
Reference to (initials of) sales rep.
Syntax
customercontrol.SalesRepName[=string]
Default Value
""
Remarks
A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.
Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string.
This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.
Data Type
String
ShippingAddress Property (Customer Control)
Shipping address for customer.
Syntax
customercontrol.ShippingAddress[=string]
Default Value
""
Remarks
The shipping address for the customer.
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>
Data Type
String
TaxCodeId Property (Customer Control)
Whether or not transactions with customer are taxable.
Syntax
customercontrol.TaxCodeId[=string]
Default Value
""
Remarks
This is a reference to a sales tax code predefined within QuickBooks.
By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
Not used with Canadian editions of QuickBooks.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
TaxCodeName Property (Customer Control)
Whether or not transactions with customer are taxable.
Syntax
customercontrol.TaxCodeName[=string]
Default Value
""
Remarks
This is a reference to a sales tax code predefined within QuickBooks.
By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.
Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string.
Not used with Canadian editions of QuickBooks.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
TaxItemId Property (Customer Control)
Reference to detailed taxation information.
Syntax
customercontrol.TaxItemId[=string]
Default Value
""
Remarks
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.
Not used with Canadian editions of QuickBooks.
Data Type
String
TaxItemName Property (Customer Control)
Reference to detailed taxation information.
Syntax
customercontrol.TaxItemName[=string]
Default Value
""
Remarks
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.
Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string.
This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.
Data Type
String
TermsId Property (Customer Control)
Reference to terms of payment.
Syntax
customercontrol.TermsId[=string]
Default Value
""
Remarks
A reference to terms of payment for this Customer or Vendor. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
TermsName Property (Customer Control)
Reference to terms of payment.
Syntax
customercontrol.TermsName[=string]
Default Value
""
Remarks
A reference to terms of payment for this Customer or Vendor. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.
Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
Add Method (Customer Control)
Adds the record into QuickBooks.
Syntax
customercontrol.Add
Remarks
Add is used to add the object to QuickBooks.
If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.
If QuickBooks is not able to add the object, a trappable error will occur.
CheckRequestStatus Method (Customer Control)
Checks whether or not the specified request was processed by QuickBooks.
Syntax
customercontrol.CheckRequestStatus RequestId
Remarks
This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.
QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.
The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."
See QBRequestId for more information on error recovery.
CloseQBConnection Method (Customer Control)
Closes a persistent connection to QuickBooks.
Syntax
customercontrol.CloseQBConnection
Remarks
Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the control will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.
In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.
Be sure to always invoke this method after calling OpenQBConnection.
Config Method (Customer Control)
Sets or retrieves a configuration setting.
Syntax
customercontrol.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.
Delete Method (Customer Control)
Deletes the record from QuickBooks.
Syntax
customercontrol.Delete
Remarks
Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.
The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.
A typical example:
Customer.GetByName("John Smith") 'this will assign the RefId
Customer.Delete()
Deleting entity objects (Customer, Employee, and Vendor) requires that
QuickBooks be open in single-user mode. Transaction objects, however, may be deleted
while QuickBooks is in any mode.
Use this method with caution, as there is no way to recover deleted objects.
Get Method (Customer Control)
Gets a single record from QuickBooks.
Syntax
customercontrol.Get Id
Remarks
Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the control will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
The RefId of any control, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:
Customer.Get( Invoice.CustomerId )
The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch control may be used.
GetByName Method (Customer Control)
Gets a single record from QuickBooks.
Syntax
customercontrol.GetByName FullName
Remarks
GetByName may be used to retrieve a single object from QuickBooks, based on its full Name. For Employee and Vendor objects, and for most Customer objects, the full name is given by the Name (CustomerName, VendorName, or EmployeeName property. For Customer objects that represent jobs or sub-customers, the full name will include the parent objects' name(s), and is given by the FullName special field. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the control will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
The full name of any control may be used for the parameter. So, for example, the following pseudocode would get customer information for a Customer listed on an Invoice:
Customer.GetByName( Invoice.CustomerName )
The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose name is not known, or to perform more advanced searches the ObjSearch control may be used.
GetCustomField Method (Customer Control)
Gets a custom field value from QuickBooks.
Syntax
customercontrol.GetCustomField FieldName
Remarks
This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.
To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.
You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.
ImportQBXML Method (Customer Control)
Imports a QBXML response aggregate.
Syntax
customercontrol.ImportQBXML XMLData
Remarks
This method imports a QBXML response aggregate. When called with 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.
OpenQBConnection Method (Customer Control)
Opens a persistent connection to QuickBooks.
Syntax
customercontrol.OpenQBConnection
Remarks
Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.
The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the control communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.
After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.
Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.
Reset Method (Customer Control)
Resets all properties to their defaults.
Syntax
customercontrol.Reset
Remarks
This method resets the values of all properties (and all special fields) to their defaults.
After calling this method, the control may be reused as if it were newly created.
SetCustomField Method (Customer Control)
Sets a custom field value within QuickBooks.
Syntax
customercontrol.SetCustomField FieldName, FieldValue
Remarks
This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".
This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).
Note that invoking this method will create a connection to QuickBooks if one is not already in place.
Update Method (Customer Control)
Updates the entity object in QuickBooks.
Syntax
customercontrol.Update
Remarks
This method is used to update entity (Customer, Vendor, and Employee) records in QuickBooks.
When the method is called, an Update request will be submitted to QuickBooks. The object represented by RefId will have its information updated based on the various property values.
If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
One condition must be met for an Update operation to succeed: QuickBooks checks a property called EditSequence. EditSequence is similar to RefId, but is changed every time the object is changed. When an Updateoperation is submitted, the server compares EditSequence with its own EditSequence for the object. If they match, this means that the client program has the latest copy of the object, and the Update operation is permitted. If they don't match, an error will be returned.
If this object represents a value returned from QuickBooks (i.e., a Get or Add call has been made, or the QBResponseAggregate property has been set), the EditSequence will be automatically set. Otherwise this value may be accessed through Config.
Error Event (Customer Control)
Information about errors during data delivery.
Syntax
Sub customercontrol_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 (Customer Control)
Fired after the server presents its certificate to the client.
Syntax
Sub customercontrol_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 (Customer Control)
Shows the progress of the secure connection.
Syntax
Sub customercontrol_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 (Customer Control)
Shows the progress of the QuickBooks connection.
Syntax
Sub customercontrol_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 (Customer Control)
Fired when a warning occurs.
Syntax
Sub customercontrol_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 (Customer 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.Customer Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AdditionalContactRefContactName[i]:
The name of the additional contact reference.This configuration setting returns the name of the additional contact reference (e.g. Mobile Phone, Fax, etc.).
The size of the array is controlled by AdditionalContactRefCount QBXMLVersion must be 12.0 or higher to return these values. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AdditionalContactRefContactValue[i]:
The value of the additional contact reference.This configuration setting returns the value of the additional contact reference (e.g. Mobile Phone, Fax, etc.).
The size of the array is controlled by AdditionalContactRefCount QBXMLVersion must be 12.0 or higher to return these values. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AdditionalContactRefCount:
The count of additional contact references returned.This configuration setting returns the number of additional contact references returned in the response from QuickBooks.
QBXMLVersion must be 12.0 or higher to return these values. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CurrencyId: The type of currency to use.Refers to the Id of a Currency object. QBXMLVersion must be 8.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CurrencyName: The type of currency to use.Refers to the name of a Currency object. QBXMLVersion must be 8.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EditSequence: An identifier for this copy of the object.Indicates the state of an object when doing an Update. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirstName: A first name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FullName: The name of the customer.This configuration setting indicates the name of the Customer, including any ancestors. If this object has a Parent, this is the version of the name that should be used in Get operations. This setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IncludePreferredDeliveryMethod:
Whether to include the preferred delivery method.The PreferredDeliveryMethod value of "Mail" is valid for responses received
from QuickBooks, but not valid for requests made to some versions of QuickBooks.
The default value of this setting is False which means the PreferredDeliveryMethod is not included in the Add or Update request. To include the PreferredDeliveryMethod in the request set this to True. Note: This is only applicable when QBXMLVersion is 12.0 or higher. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IsActive: Indicates whether the object is currently enabled for use by QuickBooks.The default value is true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobDescription: Description of the job. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobEndDate: Actual end date of the job, YYYY-MM-DD. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobProjectedEndDate: Projected end date of the job, YYYY-MM-DD. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobStartDate: Start date of the job, YYYY-MM-DD. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobStatus: The status of the job.Valid values include: "None" (1), "Pending" (2), "Awarded" (3), "InProgress" (4), "Closed" (5), or "NotAwarded" (6). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobTypeId: Reference to the type of job. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobTypeName: Reference to the type of job. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LastName: A last name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MiddleInitial: A middle initial. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NonInclusiveBalance:
The Balance of the Customer, not including sub-customers.This setting is read-only.
The following special fields are defined for Customer control's that represent jobs (typically, these will have a Parent). None are used in Update operations. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpeningBalance: The opening balance for the customer or vendor. Not used in Update operations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpeningBalanceDate: The opening balance date for the customer or vendor. Not used in Update operations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PreferredDeliveryMethod: The preferred delivery method.Refers to the customer's preferred delivery method. QBXMLVersion must be 12.0 or higher to use this configuration setting. Possible values are "Email", "None", and "Mail". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PreferredPaymentMethodId: The preferred method of payment.Refers to the Id of a PaymentMethod object. QBXMLVersion must be 3.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PreferredPaymentMethodName: The preferred method of payment.Refers to the name of a PaymentMethod object. QBXMLVersion must be 3.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PriceLevelId: Reference to a price level for the customer.QBXMLVersion must be 4.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PriceLevelName: Reference to a price level for the customer.QBXMLVersion must be 4.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Salutation: A salutation, such as Mr., Mrs., etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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" ?>...") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SeparateContact: A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ShipToAddressAggregate: A list of all shipping addresses associated with a customer.This will return the aggregate response from QuickBooks containing all available shipping addresses associated with a customer. You can access each address individually with ShipToAddressAggregate[i]. These aggregates can be assigned to the Aggregate property of an Address component. QBXMLVersion must be 12.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ShipToAddressCount: A count of all shipping addresses associated with a customer.This will return the number of available shipping addresses associated with a customer. QBXMLVersion must be 12.0 or higher to use this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Sublevel: The number of ancestors this Customer has.This setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TimeCreated: The time the object was created.This config setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TimeModified: The time the object was created.This config setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Customer 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.
Customer 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. |