CustomFields

Create, Update and Query the Custom Fields in TSheets.

Table Specific Information

Select

Query the CustomFields table. The cmdlet 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 cmdlet.

Id supports the '=,IN'
Active supports the '='
AppliesTo supports the '='
Type supports the '='
LastModified supports the '<,<=,>,>='
SupplementalData supports the '='

For example, the following queries are processed server side:

SELECT * FROM CustomFields
SELECT * FROM CustomFields WHERE Id = 24145

Insert

Insert can be executed by specifying Name, Required, Active, AppliesTo, Type, ShowToAll and ShortCode column. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO CustomFields (Name, Required, Active, AppliesTo, Type, ShowToAll, ShortCode) VALUES ('Test', true, true, 'timesheet', 'managed-list', true, 'cstm')

Update

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

UPDATE CustomFields SET Name = 'Updated name' WHERE Id = '1140410'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Custom Field.
Name	String	False	Name of the customfield.
Active	Boolean	False	Boolean value. If true, the custom field is active and if false, the custom field is archive.
Required	Boolean	False	Indicates whether a value for the custom field is required on a timesheet.
AppliesTo	String	False	Indicates what type of object this custom field object applies to. Values are 'timesheet' or 'user' or 'jobode'.
Type	String	False	'managed-list' or 'free-form'. If 'free-form', then it should be displayed in a UI as a text box, where users can enter values for this customfield and they'll get added automatically to the customfield if they don't already exist. If 'managed-list', then it should be displayed as a select-box and users can only choose an existing value.
ShortCode	String	False	This is a shortened code or alias that is associated with the customfield. It may only consist of letters and numbers.
RegexFilter	String	True	Regular expression that will be applied to any new items as they're added to the customfield. If they do not match the regex_filter, they may not be added.
Created	Datetime	True	Date/time when this custom field was created.
LastModified	Datetime	True	Date/time when this custom field was last modified.
UIPreference	String	True	'drop_down' or 'text_box_with_suggest'. Indicates the suggested user interface depending on the specified type.
ShowToAll	Boolean	False	Declares whether this customfield should be shown on timesheets regardless of the jobcode chosen. If false, it will only appear when the chosen jobcode for a timesheet has been associated with this field. This field can only be set to false if the custom field is of type 'timesheet'.
RequiredCustomFields	String	True	Ids of Custom fields that should be displayed when this custom field is visible on a timecard.

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
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.