Employee Control
Properties Methods Events Config Settings Errors
An Employee is anyone who works for the QuickBooks company.
Syntax
Employee
Remarks
The Employee control represents a company employee.
Required Fields (Add): EmployeeName
Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete
Example (Adding an employee to QuickBooks)
Employee1.EmployeeName = "John Smith"
Employee1.Add()
EmployeeName will automatically be parsed into a first name, last name, etc. by the control,
so setting EmployeeName to "Smith, John" or to "John Smith" will have the same effect.
Other contact information such as Address, Phone, and Email may be set
or modified as well.
The SSN may be set when an employee is Added, but it may not be modified or even seen afterward, as it is considered sensitive information.
To retrieve an Employee, call the Get method with the employee's name as a parameter. This parameter will automatically be parsed in the same way as EmployeeName, so calling Get on "Smith, Mary A." will successfully retrieve "Mary A. Smith". The customer will be downloaded from QuickBooks, and all properties (except SSN) will be set.
The control may also be used to update contact information or to delete an employee by using the Update and Delete methods, respectively. To update contact information, first load the employee's information using Get or the ObjSearch control. Then change the value of one or more of the properties, and call Update to update the information. Note that not all properties can be updated using the control.
To search for Employees, the ObjSearch Control may be used.
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. |
| Address | Address of employee. |
| AltPhone | Alternate phone number of entity. |
| EarningsCount | The number of records in the Earnings arrays. |
| EarningsRate | Amount employee has earned for this period. |
| EarningsRatePercent | Percentage employee has earned for this period. |
| EarningsWageId | Id of the wage type. |
| EarningsWageName | Name of the wage type. |
| Email address of entity. | |
| EmployeeName | Employee's name. |
| EmployeeType | Type of employee. |
| Gender | Gender of Employee . |
| HiredDate | Date employee was hired. |
| IsActive | Whether or not entity is active. |
| Notes | Notes for this transaction. |
| PayPeriod | Payroll property: Indicates how often employees are paid. |
| PayrollClassId | Payroll property: class of the employee payroll info. |
| PayrollClassName | Payroll property: class of the employee payroll info. |
| 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. |
| ReleasedDate | Date employee was released. |
| SickTimeAccrualPeriod | Indicates how an employee accrues time off. |
| SickTimeAccrualStartDate | Indicates the start date from which an employee accrues time off. |
| SickTimeAccrued | The time off that the employee will accrue per AccrualPeriod . |
| SickTimeAvailable | The total time off currently available for the employee to use. |
| SickTimeMaximumTime | The maximum time off that the employee can accrue. |
| SickTimeResetsEachYear | Indicates whether or not the accrued time off resets to zero at the beginning of the new year. |
| SickTimeUsed | The time off that the employee has used in the current AccrualPeriod . |
| SSN | Social security number. |
| UseTimeDataToCreatePaychecks | Payroll property: Indicates whether time data is used to create paychecks for this employee. |
| VacationTimeAccrualPeriod | Indicates how an employee accrues time off. |
| VacationTimeAccrualStartDate | Indicates the start date from which an employee accrues time off. |
| VacationTimeAccrued | The time off that the employee will accrue per AccrualPeriod . |
| VacationTimeAvailable | The total time off currently available for the employee to use. |
| VacationTimeMaximumTime | The maximum time off that the employee can accrue. |
| VacationTimeResetsEachYear | Indicates whether or not the accrued time off resets to zero at the beginning of the new year. |
| VacationTimeUsed | The time off that the employee has used in the current AccrualPeriod . |
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.
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| BirthDate | The employee's date of birth. |
| ClearEarningsFlag | Clears all employee earning records. |
| EditSequence | An identifier for this copy of the object. |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| Fax | The employee's fax number. |
| FirstName | A first name. |
| 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. |
| 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. |
| JobTitle | The employee's job title. |
| LastName | A last name. |
| MiddleInitial | A middle initial. |
| Mobile | The employee's mobile phone number. |
| Pager | The employee's pager number. |
| PagerPIN | A personal identification number for the employee's pager. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| PrintAs | The name to be printed. |
| 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. |
| 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. |
| 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 (Employee Control)
Account number for this entity.
Syntax
employeecontrol.AccountNumber[=string]
Default Value
""
Remarks
The account number for this customer, vendor, or employee.
Data Type
String
Address Property (Employee Control)
Address of employee.
Syntax
employeecontrol.Address[=string]
Default Value
""
Remarks
The mailing address of the employee.
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
AltPhone Property (Employee Control)
Alternate phone number of entity.
Syntax
employeecontrol.AltPhone[=string]
Default Value
""
Remarks
An alternate phone number for the customer, vendor, or employee.
Data Type
String
EarningsCount Property (Employee Control)
The number of records in the Earnings arrays.
Syntax
employeecontrol.EarningsCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at EarningsCount - 1.This property is not available at design time.
Data Type
Integer
EarningsRate Property (Employee Control)
Amount employee has earned for this period.
Syntax
employeecontrol.EarningsRate(EarningsIndex)[=string]
Default Value
""
Remarks
Amount employee has earned for this period.
This property contains the dollar amount that the employee has earned for this Earnings item.
The EarningsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EarningsCount property.
This property is not available at design time.
Data Type
String
EarningsRatePercent Property (Employee Control)
Percentage employee has earned for this period.
Syntax
employeecontrol.EarningsRatePercent(EarningsIndex)[=string]
Default Value
""
Remarks
Percentage employee has earned for this period.
This property contains the percentage that the employee has earned for this Earnings item.
The EarningsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EarningsCount property.
This property is not available at design time.
Data Type
String
EarningsWageId Property (Employee Control)
Id of the wage type.
Syntax
employeecontrol.EarningsWageId(EarningsIndex)[=string]
Default Value
""
Remarks
Id of the wage type.
Each payroll wage item describes and names a payment scheme, for example: "Regular Pay" or "Overtime Pay". A EarningsWageName or EarningsWageId refers to one of these wage items.
Within QuickBooks, a timesheet can specify a payroll wage item only if the following criteria are met:
- The name on the timesheet (which corresponds to the EntityRef in the TimeTracking object) is on the QuickBooks Employee list, and
- The "Use time data to create paychecks" preference turned on in the Payroll Info window that gives information about that employee in QuickBooks.
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.
The EarningsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EarningsCount property.
This property is not available at design time.
Data Type
String
EarningsWageName Property (Employee Control)
Name of the wage type.
Syntax
employeecontrol.EarningsWageName(EarningsIndex)[=string]
Default Value
""
Remarks
Name of the wage type.
Each payroll wage item describes and names a payment scheme, for example: "Regular Pay" or "Overtime Pay". A EarningsWageName or EarningsWageId refers to one of these wage items.
Within QuickBooks, a timesheet can specify a payroll wage item only if the following criteria are met:
- The name on the timesheet (which corresponds to the EntityRef in the TimeTracking object) is on the QuickBooks Employee list, and
- The "Use time data to create paychecks" preference turned on in the Payroll Info window that gives information about that employee in QuickBooks.
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.
The EarningsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EarningsCount property.
This property is not available at design time.
Data Type
String
Email Property (Employee Control)
Email address of entity.
Syntax
employeecontrol.Email[=string]
Default Value
""
Remarks
The email address of the customer, vendor, or employee.
Data Type
String
EmployeeName Property (Employee Control)
Employee's name.
Syntax
employeecontrol.EmployeeName[=string]
Default Value
""
Remarks
The name of the employee.
The name will automatically be parsed into a first name, middle initial, last name, and salutation, and will appear in those fields respectively. These fields may be edited separately using Config.
This property is required in Add operations only.
Data Type
String
EmployeeType Property (Employee Control)
Type of employee.
Syntax
employeecontrol.EmployeeType[=integer]
Possible Values
etUnspecified(0), etRegular(1), etOfficer(2), etStatutory(3), etOwner(4)
Default Value
0
Remarks
The type of employee. A default value of etRegular will be assigned after Add operations if the field is not specified.
The following types are permitted:
| etUnspecified | 0 |
| etRegular | 1 |
| etOfficer | 2 |
| etStatutory | 3 |
| etOwner | 4 |
Data Type
Integer
Gender Property (Employee Control)
Gender of Employee .
Syntax
employeecontrol.Gender[=integer]
Possible Values
gUnspecified(0), gMale(1), gFemale(2)
Default Value
0
Remarks
The gender of the Employee: gMale or gFemale.
The value of Gender may be left as gUnspecified if the gender is unknown or unimportant.
The following values are permitted:
| gUnspecified | 0 |
| gMale | 1 |
| gFemale | 2 |
Data Type
Integer
HiredDate Property (Employee Control)
Date employee was hired.
Syntax
employeecontrol.HiredDate[=string]
Default Value
""
Remarks
The date the employee was hired.
The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.
When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
IsActive Property (Employee Control)
Whether or not entity is active.
Syntax
employeecontrol.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 (Employee Control)
Notes for this transaction.
Syntax
employeecontrol.Notes[=string]
Default Value
""
Remarks
This property may contain any notes you wish to make concerning the transaction.
Data Type
String
PayPeriod Property (Employee Control)
Payroll property: Indicates how often employees are paid.
Syntax
employeecontrol.PayPeriod[=integer]
Possible Values
ppNotSet(0), ppDaily(1), ppWeekly(2), ppBiweekly(3), ppSemimonthly(4), ppMonthly(5), ppQuarterly(6), ppYearly(7)
Default Value
0
Remarks
Indicates how often employees are paid. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. This property is required for an Update request.
Data Type
Integer
PayrollClassId Property (Employee Control)
Payroll property: class of the employee payroll info.
Syntax
employeecontrol.PayrollClassId[=string]
Default Value
""
Remarks
A reference to the class into which this employee payroll falls. 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.
Data Type
String
PayrollClassName Property (Employee Control)
Payroll property: class of the employee payroll info.
Syntax
employeecontrol.PayrollClassName[=string]
Default Value
""
Remarks
A reference to the class into which this employee payroll falls. 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.
Data Type
String
Phone Property (Employee Control)
Phone number of entity.
Syntax
employeecontrol.Phone[=string]
Default Value
""
Remarks
The phone number of the customer, vendor, or employee.
Data Type
String
QBConnectionString Property (Employee Control)
An aggregate consisting of various QuickBooks connection properties.
Syntax
employeecontrol.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 (Employee Control)
The request aggregate.
Syntax
employeecontrol.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 (Employee Control)
The Id of the next message to be sent to QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Defines whether the request is made online or stored offline.
Syntax
employeecontrol.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 (Employee Control)
The last QBXML response aggregate received from QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
The version of QBXML used in the outgoing message.
Syntax
employeecontrol.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 (Employee Control)
An alphanumerical identifier generated by the server.
Syntax
employeecontrol.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
ReleasedDate Property (Employee Control)
Date employee was released.
Syntax
employeecontrol.ReleasedDate[=string]
Default Value
""
Remarks
The date the employee was released (if he/she was released).
This property is allowed in Add operations, and not used in Update operations.
Data Type
String
SickTimeAccrualPeriod Property (Employee Control)
Indicates how an employee accrues time off.
Syntax
employeecontrol.SickTimeAccrualPeriod[=integer]
Possible Values
stNone(0), stBeginningOfYear(1), stEveryHourOnPaycheck(2), stEveryPaycheck(3)
Default Value
0
Remarks
Indicates how an employee accrues time off. If sending time off hours data in an Update request, SickTimeAccrualPeriod is a required property, and cannot be set to stNone. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.
Valid values:
| stNone (0) | No value set. |
| stBeginningOfYear (1) | Time off is added at the beginning of each year. |
| stEveryHourOnPaycheck (2) | Time off is calculated by the employee's working hours. |
| stEveryPaycheck (3) | Time off is accumulated for every paycheck. |
Data Type
Integer
SickTimeAccrualStartDate Property (Employee Control)
Indicates the start date from which an employee accrues time off.
Syntax
employeecontrol.SickTimeAccrualStartDate[=string]
Default Value
""
Remarks
Indicates the start date from which an employee accrues time off. This property requires QBXMLVersion to be set to "5.0" or greater.
The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.
When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.
Data Type
String
SickTimeAccrued Property (Employee Control)
The time off that the employee will accrue per AccrualPeriod .
Syntax
employeecontrol.SickTimeAccrued[=string]
Default Value
""
Remarks
The time off that the employee will accrue per SickTimeAccrualPeriod. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
SickTimeAvailable Property (Employee Control)
The total time off currently available for the employee to use.
Syntax
employeecontrol.SickTimeAvailable[=string]
Default Value
""
Remarks
The total time off currently available for the employee to use. If this value is empty it will default to 0.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
SickTimeMaximumTime Property (Employee Control)
The maximum time off that the employee can accrue.
Syntax
employeecontrol.SickTimeMaximumTime[=string]
Default Value
""
Remarks
The maximum time off that the employee can accrue. (QuickBooks itself does not enforce this limit, however. SickTimeAvailable time can be greater than SickTimeMaximumTime.) The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
SickTimeResetsEachYear Property (Employee Control)
Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
Syntax
employeecontrol.SickTimeResetsEachYear[=boolean]
Default Value
False
Remarks
Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
Data Type
Boolean
SickTimeUsed Property (Employee Control)
The time off that the employee has used in the current AccrualPeriod .
Syntax
employeecontrol.SickTimeUsed[=string]
Default Value
""
Remarks
The time off that the employee has used in the current SickTimeAccrualPeriod. This property requires QBXMLVersion to be set to "5.0" or greater.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
SSN Property (Employee Control)
Social security number.
Syntax
employeecontrol.SSN[=string]
Default Value
""
Remarks
The social security number of the employee. Must include dashes.
As this information is considered sensitive, there is no way to change or retrieve the SSN of an Employee. This property may be specified when adding a record to QuickBooks, but it is impossible to determine the SSN of an employee already in QuickBooks.
Data Type
String
UseTimeDataToCreatePaychecks Property (Employee Control)
Payroll property: Indicates whether time data is used to create paychecks for this employee.
Syntax
employeecontrol.UseTimeDataToCreatePaychecks[=integer]
Possible Values
tdNotSet(0), tdUseTimeData(1), tdDoNotUseTimeData(2)
Default Value
0
Remarks
Indicates whether time data is used to create paychecks for this employee.
Data Type
Integer
VacationTimeAccrualPeriod Property (Employee Control)
Indicates how an employee accrues time off.
Syntax
employeecontrol.VacationTimeAccrualPeriod[=integer]
Possible Values
stNone(0), stBeginningOfYear(1), stEveryHourOnPaycheck(2), stEveryPaycheck(3)
Default Value
0
Remarks
Indicates how an employee accrues time off. If sending time off hours data in an Update request, VacationTimeAccrualPeriod is a required property, and cannot be set to stNone. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.
Valid values:
| stNone (0) | No value set. |
| stBeginningOfYear (1) | Time off is added at the beginning of each year. |
| stEveryHourOnPaycheck (2) | Time off is calculated by the employee's working hours. |
| stEveryPaycheck (3) | Time off is accumulated for every paycheck. |
Data Type
Integer
VacationTimeAccrualStartDate Property (Employee Control)
Indicates the start date from which an employee accrues time off.
Syntax
employeecontrol.VacationTimeAccrualStartDate[=string]
Default Value
""
Remarks
Indicates the start date from which an employee accrues time off. This property requires QBXMLVersion to be set to "5.0" or greater.
The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.
When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.
Data Type
String
VacationTimeAccrued Property (Employee Control)
The time off that the employee will accrue per AccrualPeriod .
Syntax
employeecontrol.VacationTimeAccrued[=string]
Default Value
""
Remarks
The time off that the employee will accrue per VacationTimeAccrualPeriod. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
VacationTimeAvailable Property (Employee Control)
The total time off currently available for the employee to use.
Syntax
employeecontrol.VacationTimeAvailable[=string]
Default Value
""
Remarks
The total time off currently available for the employee to use. If this value is empty it will default to 0.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
VacationTimeMaximumTime Property (Employee Control)
The maximum time off that the employee can accrue.
Syntax
employeecontrol.VacationTimeMaximumTime[=string]
Default Value
""
Remarks
The maximum time off that the employee can accrue. (QuickBooks itself does not enforce this limit, however. VacationTimeAvailable time can be greater than VacationTimeMaximumTime.) The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
VacationTimeResetsEachYear Property (Employee Control)
Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
Syntax
employeecontrol.VacationTimeResetsEachYear[=boolean]
Default Value
False
Remarks
Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
Data Type
Boolean
VacationTimeUsed Property (Employee Control)
The time off that the employee has used in the current AccrualPeriod .
Syntax
employeecontrol.VacationTimeUsed[=string]
Default Value
""
Remarks
The time off that the employee has used in the current VacationTimeAccrualPeriod. This property requires QBXMLVersion to be set to "5.0" or greater.
Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.
Data Type
String
Add Method (Employee Control)
Adds the record into QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Checks whether or not the specified request was processed by QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Closes a persistent connection to QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Sets or retrieves a configuration setting.
Syntax
employeecontrol.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 (Employee Control)
Deletes the record from QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Gets a single record from QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Gets a single record from QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Gets a custom field value from QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Imports a QBXML response aggregate.
Syntax
employeecontrol.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 (Employee Control)
Opens a persistent connection to QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Resets all properties to their defaults.
Syntax
employeecontrol.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 (Employee Control)
Sets a custom field value within QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Updates the entity object in QuickBooks.
Syntax
employeecontrol.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 (Employee Control)
Information about errors during data delivery.
Syntax
Sub employeecontrol_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 (Employee Control)
Fired after the server presents its certificate to the client.
Syntax
Sub employeecontrol_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 (Employee Control)
Shows the progress of the secure connection.
Syntax
Sub employeecontrol_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 (Employee Control)
Shows the progress of the QuickBooks connection.
Syntax
Sub employeecontrol_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 (Employee Control)
Fired when a warning occurs.
Syntax
Sub employeecontrol_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 (Employee 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.Employee Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BirthDate: The employee's date of birth.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ClearEarningsFlag: Clears all employee earning records.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. Write only, and only available for Updates. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fax: The employee's fax number.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirstName: A first name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| JobTitle: The employee's job title.This property requires that the QBXMLVersion be set to "12.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LastName: A last name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MiddleInitial: A middle initial. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Mobile: The employee's mobile phone number.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pager: The employee's pager number.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PagerPIN: A personal identification number for the employee's pager.This property is only applicable for use with QuickBooks 2003 or better, and requires that the QBXMLVersion be set to "2.0" or higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PrintAs: The name to be printed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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" ?>...") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Employee 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.
Employee 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. |