Cmdlets for QuickBooks

Build 24.0.9060

Employees

Create, update, delete, and query QuickBooks Employees.

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 of the employee.

Name String False 100

The name of the employee. This is required to have a value when inserting.

Salutation String False 15

A salutation, such as Mr., Mrs., etc.

FirstName String False 25

The first name of the employee.

MiddleInitial String False 25

A middle name or middle initial of the employee.

LastName String False 25

The last name of the employee.

JobTitle String False 41

Job title of the employee. Requires QBXML Version 12.0 or higher.

AccountNumber String False 99

The account number for this employee.

SSN String False 11

The social security number of the employee.

EmployeeType String False 13

The type of employee.

The allowed values are Regular, Unspecified, Officer, Statutory, Owner.

Gender String False 12

The gender of the employee. Note that after inserting, this value cannot be updated.

The allowed values are Unspecified, Male, Female.

Address String True

Full address returned by QuickBooks.

Line1 String False 500

First line of the address.

Line2 String False 500

Second line of the address.

City String False 255

City name for the address.

State String False 255

State name for the address.

PostalCode String False 30

Postal code for the address.

AlternatePhone String False 21

An alternate phone number for the employee.

Email String False 1023

The email address of the employee.

PrintAs String False 110

How the employee name should be printed.

MobilePhone String False 21

The mobile phone number of this employee.

Pager String False 21

The pager number of this employee.

PagerPIN String False 10

The personal identification number for the pager of this employee.

Fax String False 21

The fax number of this employee.

BirthDate Date False

The date of birth of this employee.

USCitizen String False 10

Indicates whether the Employee is a US Citizen.

The allowed values are Unspecified, Yes, No.

Ethnicity String False 20

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 is disabled

The allowed values are Unspecified, Yes, No.

DisabilityDescription String False 25

A description of the disability.

FormOnFile String False 10

Indicates whether the I-9 Form is on file.

The allowed values are Unspecified, Yes, No.

USVeteran String False 10

Indicates whether the Employee is a US 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

This property indicates whether this object is currently enabled for use by QuickBooks.

Notes String False 5000

This property may contain any notes you wish to make concerning the transaction.

PayPeriod String False 13

Indicates how often employees are paid.

The allowed values are NotSet, Daily, Weekly, Biweekly, Semimonthly, Monthly, Quarterly, Yearly.

PayrollClassName String False 159

A reference to the class into which this employee payroll falls. Id/Name Reference Properties.

PayrollClassId String False

Class.ID

1000

A reference to the class into which this employee payroll falls. Id/Name Reference Properties.

Phone String False 21

The phone number of the employee.

ReleasedDate Date False

The date the employee was released (if he/she was released).

TimeDataForPaychecks String False 18

Indicates whether time data is used to create paychecks for this employee.

The allowed values are NotSet, UseTimeData, DoNotUseTimeData.

SickTimeAccrualPeriod String False 19

Sick-time hours accrual period.

The allowed values are BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck.

SickTimeAccrualStartDate Date False

Sick-time accrual start date. The minimum QBXMLVersion is 5.0. The standard formatting for dates is YYYY-MM-DD; e.g., September 2, 2002 is formatted as 2002-09-02.

SickTimeAccrued String False 30

Sick-time hours accrued. 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. The integrated application has no permission to access personal data. The QuickBooks administrator can grant permission to access personal data through the Integrated Application preferences.

SickTimeAvailable String False 30

Sick-time hours available. 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. The integrated application has no permission to access personal data. The QuickBooks administrator can grant permission to access personal data through the Integrated Application preferences.

SickTimeMaximum String False 30

Sick-time maximum hours. 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

SickTimeYearlyReset Boolean False

Sick-time hours resets each year. Default false.

SickTimeUsed String False 30

Sick-time hours used. 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. Minimum QBXMLVersion '5.0'.

VacationTimeAccrualPeriod String False 19

Vacation-time hours accrual period.

The allowed values are BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck.

VacationTimeAccrualStartDate Date False

Vacation-time accrual start date. Minimum QBXMLVersion '5.0'. The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02.

VacationTimeAccrued String False 30

Vacation-time hours accrued. 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.

VacationTimeAvailable String False 30

Vacation-time hours available. 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.

VacationTimeMaximum String False 30

Vacation-time maximum hours. 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.

VacationTimeYearlyReset Boolean False

Vacation-time hours resets each year. Default false.

VacationTimeUsed String False 30

Vacation-time hours used. 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. Minimum QBXMLVersion '5.0'.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

EditSequence String True 16

A string indicating the revision of the employee record.

TimeModified Datetime True

When the employee record was last modified.

TimeCreated Datetime True

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 (by default 0). Note that this property is used only when adding new accounts to QuickBooks.

OpeningDate String

The opening balance date of the account. Note that this property is used only when adding new accounts to QuickBooks.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060