Employees
Manages QuickBooks Employees, allowing creation, updates, deletion, and queries for employee records and payroll data.
Table Specific Information
This table has a Custom Fields column. See the Custom Fields page for more information.
Select
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Employees are Id, Name, TimeModified, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Employees WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
Columns
Name | Type | ReadOnly | References | ColumnSize | Description |
ID [KEY] | String | True | 255 |
The unique identifier for the employee record. | |
Name | String | False | 100 |
The name of the employee. This field is required when inserting a new record. | |
Salutation | String | False | 15 |
A salutation for the employee, such as Mr., Mrs., or Dr. | |
FirstName | String | False | 25 |
The first name of the employee. | |
MiddleInitial | String | False | 25 |
The middle name or middle initial of the employee. | |
LastName | String | False | 25 |
The last name of the employee. | |
JobTitle | String | False | 41 |
The job title or position of the employee. Requires QBXML Version 12.0 or higher. | |
AccountNumber | String | False | 99 |
The account number assigned to the employee. | |
SSN | String | False | 11 |
The social security number (SSN) of the employee. | |
EmployeeType | String | False | 13 |
Specifies the type of employee, such as full-time, part-time, or contractor. The allowed values are Regular, Unspecified, Officer, Statutory, Owner. | |
Gender | String | False | 12 |
The gender of the employee. Note that this field cannot be updated after insertion. The allowed values are Unspecified, Male, Female. | |
Address | String | True |
The full address of the employee as returned by QuickBooks. | ||
Line1 | String | False | 500 |
The first line of the employee's address. | |
Line2 | String | False | 500 |
The second line of the employee's address. | |
City | String | False | 255 |
The city of the employee's address. | |
State | String | False | 255 |
The state of the employee's address. | |
PostalCode | String | False | 30 |
The postal code of the employee's address. | |
AlternatePhone | String | False | 21 |
An alternate phone number for the employee. | |
String | False | 1023 |
The email address of the employee. | ||
PrintAs | String | False | 110 |
Specifies how the employee's name should appear on printed documents. | |
MobilePhone | String | False | 21 |
The mobile phone number of the employee. | |
Pager | String | False | 21 |
The pager number of the employee. | |
PagerPIN | String | False | 10 |
The personal identification number (PIN) for the pager. | |
Fax | String | False | 21 |
The fax number of the employee. | |
BirthDate | Date | False |
The date of birth of the employee. | ||
USCitizen | String | False | 10 |
Indicates whether the employee is a U.S. citizen. The allowed values are Unspecified, Yes, No. | |
Ethnicity | String | False | 20 |
Specifies the ethnicity of the employee. The allowed values are Unspecified, AmericanIndian, Asian, Black, Hawaiian, Hispanic, White, TwoOrMoreRaces. | |
Disabled | String | False | 10 |
Indicates whether the employee has a disability. The allowed values are Unspecified, Yes, No. | |
DisabilityDescription | String | False | 25 |
A description of the employee's disability, if applicable. | |
FormOnFile | String | False | 10 |
Indicates whether the I-9 form is on file for the employee. The allowed values are Unspecified, Yes, No. | |
USVeteran | String | False | 10 |
Indicates whether the employee is a U.S. veteran. The allowed values are Unspecified, Yes, No. | |
MilitaryStatus | String | False | 10 |
The current military status of the employee. The allowed values are Unspecified, Active, Reserve. | |
HiredDate | Date | False |
The date the employee was hired. | ||
IsActive | Boolean | False |
Indicates whether the employee is currently active in QuickBooks. | ||
Notes | String | False | 5000 |
Any notes or comments related to the employee. | |
PayPeriod | String | False | 13 |
The frequency of the employee's pay period (for example, weekly, bi-weekly, monthly). The allowed values are NotSet, Daily, Weekly, Biweekly, Semimonthly, Monthly, Quarterly, Yearly. | |
PayrollClassName | String | False | 159 |
The payroll class name associated with the employee. | |
PayrollClassId | String | False |
Class.ID | 1000 |
The payroll class ID associated with the employee. |
Phone | String | False | 21 |
The primary phone number of the employee. | |
ReleasedDate | Date | False |
The date the employee's employment was terminated, if applicable. | ||
TimeDataForPaychecks | String | False | 18 |
Indicates if time data is used to calculate the employee's paychecks. The allowed values are NotSet, UseTimeData, DoNotUseTimeData. | |
SickTimeAccrualPeriod | String | False | 19 |
The accrual period for sick time. The allowed values are BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck. | |
SickTimeAccrualStartDate | Date | False |
The date when sick time accrual starts. | ||
SickTimeAccrued | String | False | 30 |
The total accrued sick time, represented in hours and minutes (for example, 2:30 for 2 hours and 30 minutes). | |
SickTimeAvailable | String | False | 30 |
The available sick time, represented in hours and minutes. | |
SickTimeMaximum | String | False | 30 |
The maximum allowable sick time, represented in hours and minutes. | |
SickTimeYearlyReset | Boolean | False |
Indicates whether sick time resets annually. Defaults to false. | ||
SickTimeUsed | String | False | 30 |
The amount of sick time used, represented in hours and minutes. | |
VacationTimeAccrualPeriod | String | False | 19 |
The accrual period for vacation time. The allowed values are BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck. | |
VacationTimeAccrualStartDate | Date | False |
The date when vacation time accrual starts. | ||
VacationTimeAccrued | String | False | 30 |
The total accrued vacation time, represented in hours and minutes. | |
VacationTimeAvailable | String | False | 30 |
The available vacation time, represented in hours and minutes. | |
VacationTimeMaximum | String | False | 30 |
The maximum allowable vacation time, represented in hours and minutes. | |
VacationTimeYearlyReset | Boolean | False |
Indicates whether vacation time resets annually. Defaults to false. | ||
VacationTimeUsed | String | False | 30 |
The amount of vacation time used, represented in hours and minutes. | |
CustomFields | String | False |
Custom fields associated with the employee, formatted as XML. | ||
EditSequence | String | True | 16 |
A string used for versioning the employee record. | |
TimeModified | Datetime | True |
The timestamp of the last modification to the employee record. | ||
TimeCreated | Datetime | True |
The timestamp of when the employee record was created. |
Pseudo-Columns
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
OpeningBalance | String |
The opening balance of the account, defaulting to 0. Used only when adding new accounts. |
OpeningDate | String |
The date of the opening balance for the account. Used only when adding new accounts. |