Cmdlets for QuickBooks Time

Build 24.0.9062

Users

Retrieves a list of all users associated with your company.

Table Specific Information

Select

Query the Users table. The 本製品 will use the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the 本製品.

  • Id, GroupId, Username, PayrollId and EmployeeNumber fields support the '=' and IN operators.
  • FirstName and LastName fields support the '=' and LIKE operators.
  • ActiveStatus filter supports the '=' operator.
  • LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE ActiveStatus = 'both'

SELECT * FROM Users WHERE LastModified > '2019-01-01 18:30' AND GroupId IN (1, 2, 3)

SELECT * FROM Users WHERE FirstName LIKE 'josh%' AND PayrollId IN ('562348', '45457')

Insert

Insert can be executed by specifying UserName, FirstName and LastName columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Users (UserName, FirstName, LastName) VALUES ('cdatagroup@123', 'cdata', 'group')

Update

Update can be executed by specifying the Id or UserName in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Users SET FirstName = 'New Name'  WHERE Id = '14055' 

UPDATE Users SET FirstName = 'New User Name', LastName = 'New Title' WHERE UserName = 'cdatagroup@123' 

Columns

Name Type ReadOnly Description
Id [KEY] Integer False

Id of this user.

FirstName String False

First name of user.

LastName String False

Last name of user.

DisplayName String False

The display name of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null display_name value (users who have not setup their display_name will return empty string)

Pronouns String False

The personal pronouns of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null pronouns value (users who have not setup their pronouns will return empty string)

GroupId Integer False

Id of the group this user belongs to.

Active Boolean False

Whether this user is active. If false, this user is considered archived.

EmployeeNumber Integer False

Unique number associated with this user.

Salaried Boolean False

Indicates whether or not the user is salaried.

Exempt Boolean False

Indicates whether or not the user is eligible for overtime pay.

Username String False

Username associated with this user.

Email String False

Email address associated with this user.

EmailVerified Boolean False

Indicates whether or not the user is eligible for overtime pay.

PayrollId String False

Unique company wide string associated with this user. Usually used for linking with external systems.

HireDate Date False

Date on which this user was hired.

TermDate Date False

Date on which this user was terminated.

LastModified Datetime False

Date/time when this user was last modified.

LastActive Datetime False

Date/time when this user last performed any action.

Created Datetime False

Date/time when this user was created

ClientUrl String False

Client account url identifier associated with this user.

CompanyName String False

Client account name identifier associated with the user.

ProfileImageUrl String False

Url identifier associated with this user's profile image.

MobileNumber String False

Mobile phone number associated with this user.

PTOBalances String False

List of jobcode identifiers and their respective PTO balances for this user (in seconds).

SubmittedTo Date False

The latest date this user has submitted timesheets up to.

ApprovedTo Date False

The latest date this user has had timesheets approved to.

ManagerOfGroupIds String False

The group ids that this user manages.

RequirePasswordChange Boolean False

Whether this user will be required to change their password on their next login.

LoginPIN Integer False

Used for logging into a Kiosk or similar.

PayRate Double False

The rate of pay associated with this user. Only visible to admins.

PayInterval String False

The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins.

CustomFields String False

A key/value map of customfield ids to the customfield items that are associated with the user.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ActiveStatus Boolean

Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

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