Employee Class

Properties   Methods   Events   Configuration Settings   Errors  

An Employee is anyone who works for the QuickBooks company.

Syntax

class inqb.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()

employee_name will automatically be parsed into a first name, last name, etc. by the class, so setting employee_name 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 employee_name, 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.

account_number	Account number for this entity.
address	Address of employee.
alt_phone	Alternate phone number of entity.
earnings_count	The number of records in the Earnings arrays.
earnings_rate	Amount employee has earned for this period.
earnings_rate_percent	Percentage employee has earned for this period.
earnings_wage_id	Id of the wage type.
earnings_wage_name	Name of the wage type.
email	Email address of entity.
employee_name	Employee's name.
employee_type	Type of employee.
gender	Gender of Employee .
hired_date	Date employee was hired.
is_active	Whether or not entity is active.
notes	Notes for this transaction.
pay_period	Payroll property: Indicates how often employees are paid.
payroll_class_id	Payroll property: class of the employee payroll info.
payroll_class_name	Payroll property: class of the employee payroll info.
phone	Phone number of entity.
qb_connection_string	An aggregate consisting of various QuickBooks connection properties.
qb_request_aggregate	The request aggregate.
qb_request_id	The Id of the next message to be sent to QuickBooks.
qb_request_mode	Defines whether the request is made online or stored offline.
qb_response_aggregate	The last QBXML response aggregate received from QuickBooks.
qbxml_version	The version of QBXML used in the outgoing message.
ref_id	An alphanumerical identifier generated by the server.
released_date	Date employee was released.
sick_time_accrual_period	Indicates how an employee accrues time off.
sick_time_accrual_start_date	Indicates the start date from which an employee accrues time off.
sick_time_accrued	The time off that the employee will accrue per AccrualPeriod .
sick_time_available	The total time off currently available for the employee to use.
sick_time_maximum_time	The maximum time off that the employee can accrue.
sick_time_resets_each_year	Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
sick_time_used	The time off that the employee has used in the current AccrualPeriod .
ssn	Social security number.
use_time_data_to_create_paychecks	Payroll property: Indicates whether time data is used to create paychecks for this employee.
vacation_time_accrual_period	Indicates how an employee accrues time off.
vacation_time_accrual_start_date	Indicates the start date from which an employee accrues time off.
vacation_time_accrued	The time off that the employee will accrue per AccrualPeriod .
vacation_time_available	The total time off currently available for the employee to use.
vacation_time_maximum_time	The maximum time off that the employee can accrue.
vacation_time_resets_each_year	Indicates whether or not the accrued time off resets to zero at the beginning of the new year.
vacation_time_used	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.
check_request_status	Checks whether or not the specified request was processed by QuickBooks.
close_qb_connection	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.
get_by_name	Gets a single record from QuickBooks.
get_custom_field	Gets a custom field value from QuickBooks.
import_qbxml	Imports a QBXML response aggregate.
open_qb_connection	Opens a persistent connection to QuickBooks.
reset	Resets all properties to their defaults.
set_custom_field	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.

on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_status	Shows the progress of the QuickBooks connection.
on_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.

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 Remote Connector.
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector.
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
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.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.