Employee Class

Properties Methods Events Configuration Settings Errors

An Employee is anyone who works for the QuickBooks company.

Syntax

Employee

Remarks

The Employee class 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 class, 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 class 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 class. 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 class.

To search for Employees, the ObjSearch Class may be used.

Property List

The following is the full list of the properties of the class 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	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 class 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 class 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.

Configuration Settings

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


SendRawXML	Sends specified XML to quickbooks without modification.
AppendAfter	Appends an XML tag after the specified QBXML element.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
EditSequence	An identifier for this copy of the object.
Salutation	A salutation, such as Mr., Mrs., etc.
FirstName	A first name.
MiddleInitial	A middle initial.
LastName	A last name.
PrintAs	The name to be printed.
Mobile	The employee's mobile phone number.
Pager	The employee's pager number.
PagerPIN	A personal identification number for the employee's pager.
Fax	The employee's fax number.
BirthDate	The employee's date of birth.
ClearEarningsFlag	Clears all employee earning records.
IsActive	Indicates whether the object is currently enabled for use by QuickBooks.
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
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.