/n software QuickBooks employee Component : employee OCX, employee .NET Component, employee Class, employee Bean, employee Object

Available in: QUICKBOOKS

Employee Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

An Employee is anyone who works for the QuickBooks company.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The Employee component represents a company employee.

Required Fields (Add): EmployeeName

Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete

Online Edition: Leave out IsActive, Pager, PagerPIN, Fax, EmployeeType*, ContactName, AltContactName, CustomerType*, Gender, BirthDate, and AccountNumber.

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 component, 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 component 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 component. 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 component.

To search for Employees, the OBJSEARCH component may be used.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AccountNumber	Account number for this entity.
Address	Address of employee.
AltPhone	Alternate phone number of entity.
EarningsCount	Payroll property: Number of Earnings elements.
EarningsRate	Payroll property: Amount employee has earned for this period.
EarningsRatePercent	Payroll property: Percentage employee has earned for this period.
EarningsWageId	Payroll property: Type of wages.
EarningsWageName	Payroll property: Type of wages.
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.
QBAddRequestAggregate	Request aggregate for an Add.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate	Request aggregate for an Update.
QBXMLVersion	The version of QBXML used in the outgoing message.
RefId	An alphanumerical identifier generated by the server.
ReleasedDate	Date employee was released.
SSN	Social security number.
SickAccrualStartDate	Payroll property: Date sick time is accrued from
SickMaximumTime	Payroll property: The maximum amount of sick time which can be accrued.
SickTimeAccrualPeriod	Payroll property: How an employee accrues sick time.
SickTimeAccrued	Payroll property: Sick time employee will accrue per period.
SickTimeAvailable	Payroll property: Sick time available for this employee.
SickTimeResetsEachYear	Payroll property: Indicates whether sick time resets or carries over each year.
SickTimeUsed	Payroll property: Sick time employee has used.
UseTimeDataToCreatePaychecks	Payroll property: Indicates whether time data is used to create paychecks for this employee.
VacationAccrualStartDate	Payroll property: Date vacation time is accrued from
VacationMaximumTime	Payroll property: The maximum amount of vacation time which can be accrued.
VacationTimeAccrualPeriod	Payroll property: How an employee accrues vacation time.
VacationTimeAccrued	Payroll property: Vacation time employee will accrue per period.
VacationTimeAvailable	Payroll property: Vacation time available for this employee.
VacationTimeResetsEachYear	Payroll property: Indicates whether vacation time resets or carries over each year.
VacationTimeUsed	Payroll property: Vacation time employee has used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AXMExport	Exports the object.
AXMImport	Imports the object.
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 component 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.
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.
WebExport	Exports the object to a web client.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
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 component with short descriptions. Click on the links for complete descriptions.


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.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
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.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
IsActive	Indicates whether the object is currently enabled for use by QuickBooks.
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.
PrintAs	The name to be printed.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector
Salutation	A salutation, such as Mr., Mrs., etc.
SendRawXML	Sends specified XML to quickbooks without modification.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.