CustomField

Id

Integer

The unique id record for this custom field

No

System

String

What Deputy resource is associated with this custom field

Timesheet = Timesheet
Employee = Employee
Roster = Roster

Yes

Name

String

The name of the custom field

Yes

ApiName

String

Used to define which API connection is using that field. Limited to 64 characters

Yes

DeputyField

String

F01 to F128 - Reserved by Deputy system and automatically assigned

No

SortOrder

String

Allows you to define how Custom fields are sorted

No

Type

Integer

Define what type the custom field is

1 = Text
2 = Number
3 = Large Text
4 = Boolean/Checkbox
5 = List
6 = Multi List
7 = File
8 = Boolean/Checkbox - Yes with comment required
9 = Boolean/Checkbox - No with comment required

Yes

Valuelist

Array/String

Required when using List/Multi List as the type. Options are an array of strings

No

Helptext

String

Help text that can be associated with the custom field

No

Published

Boolean

Whether the custom field is published or not

0 = Inactive
1 = Active

No

Action

Integer

Allows you to define shift behaviour based on a custom field setting.

1 = Prevent clock in
2 = Notify Manager
3 = Prevent clock in and notify manager

No

ConditionalRules

Boolean

Required when boolean is defined as the type of custom field

Yes = Yes
No = No

No

DisplayTiming

Integer

When the custom field should display

1 = Clock out and update
2 = Clock in
3 = Clock In/Out and update

No

TriggerScript

Integer

The record number of a DeXML script to trigger

No

Validation

String

What parts of the field need to be validated

nempty = required field
unq = unique

If you would like to set both these requirements on a field use /n to split the two in the string

No

Creator

Integer

The unique id of the user who created the custom field

No

Created

DateTime

When the custom field was created

No

Modified

DateTime

When the custom field was last modified

No