Accrual

An Accrual or "time bank" is a collection of time that can be used to pay for time off. Accruals are typically used to track vacation time, sick time, and other types of paid time off.

Each accrual is tied to a user and one or more Pay Types. The accrual can have a name, a balance, and hard and soft limits. Balances can be managed manually, or can be generated through the Accrual Calculator product.

Time is deducted from the Accrual when a user creates a Time Entry for a Pay Type associated with the Accrual.

A hard limit is a minimum balance that cannot be exceeded. For example a hard limit of 0.00 hours would mean that the user cannot have a negative balance in the Accrual.

A soft limit is a balance at which the user is notified or warned that they are approaching the hard limit.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

hard_thresholdfloat

The hard threshold for the Accrual. If the Accrual balance drops below this value, the user cannot create new Time Entries using this Accrual. A typical hard threshold is 0.0.

Example: 0

hours_leftfloat

The number of hours left in the Accrual - the hours balance.

Example: 40

id_userstring

The internal ID of the User associated with this Accrual. Once set, this value cannot be changed.

Example: 64BBA147B9AC41D9978062300826C89F

id_user_properties object

The properties associated with the user who owns this Accrual. Note that this key may not be present unless requested in the $keys parameter.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

custom_fields object

An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

tip

Updating Custom Field values

When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

info

Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

See the CustomFields Schema page for more detailed information on these topics.

property name* CustomFieldValue

A specific instance (value) of a Custom field for a particular object.

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

• STRING - a variable-length string.
• CHAR - a fixed-length string. (The value may be padded with spaces.)
• NUMBER - a floating-point number.
• INTEGER - an integer (whole number).
• TIMESTAMP - a date and time, stored in Unix epoch format.
• DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings and char may also have a maximum length specified, such as STRING_100.

Example: ["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

Example: XYZ Pay Group

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

iduuid

The Group ID.

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsuuid[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_propertiesobject

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F

modifier_fullnamestring

The full name of the user who most recently modified the object.

Example: John Doe

modifier_propertiesobject

Extended information about the User who last modified the object. This field is only included if the $keys parameter requests it.

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field, or custom_fields.users_email.value.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2float

UNUSED FIELD This is a legacy field that is no longer used.

reserved3float

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

is_hiddenboolean

Indicates whether the object is hidden.

See also status

Example: false

pay_type_idsstring[]required

The internal IDs of the Pay Types associated with this Accrual. These Pay Types are the types of time that can be used to pay for time off.

pnamestringrequired

The name of the Accrual. Typically this is the name of the main Pay Type associated with the Accrual, but it can be any name. This will be displayed to the end user.

Example: Vacation

use_hard_thresholdboolean

If true, the hard threshold is enforced. If false, the hard threshold is ignored.

Example: true

use_warningboolean

If true, the warning ("soft") threshold is enforced. If false, the warning threshold is ignored.

Example: true

warning_thresholdfloat

The warning threshold for the Accrual. If the Accrual balance drops below this value, the user is notified or warned that they are approaching the hard limit. An example warning threshold is 16.0.

Example: 16

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The general visibility status of the object; either Hidden, Loggable and Reportable, or Reportable Only.

This is a write-enabled field if you have the appropriate permissions. See also status_code which can be changed in the same way.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_properties object

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

custom_fields object

An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

tip

Updating Custom Field values

When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

info

Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

See the CustomFields Schema page for more detailed information on these topics.

property name* CustomFieldValue

A specific instance (value) of a Custom field for a particular object.

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

• STRING - a variable-length string.
• CHAR - a fixed-length string. (The value may be padded with spaces.)
• NUMBER - a floating-point number.
• INTEGER - an integer (whole number).
• TIMESTAMP - a date and time, stored in Unix epoch format.
• DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings and char may also have a maximum length specified, such as STRING_100.

Example: ["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

Example: XYZ Pay Group

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

iduuid

The Group ID.

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsuuid[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F

modifier_fullnamestring

The full name of the user who most recently modified the object.

Example: John Doe

modifier_propertiesobject

Extended information about the User who last modified the object. This field is only included if the $keys parameter requests it.

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field, or custom_fields.users_email.value.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2float

UNUSED FIELD This is a legacy field that is no longer used.

reserved3float

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F

modifier_fullnamestring

The full name of the user who most recently modified the object.

Example: John Doe

modifier_properties object

Extended information about the User who last modified the object. This field is only included if the $keys parameter requests it.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

custom_fields object

An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

tip

Updating Custom Field values

When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

info

Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

See the CustomFields Schema page for more detailed information on these topics.

property name* CustomFieldValue

A specific instance (value) of a Custom field for a particular object.

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

• STRING - a variable-length string.
• CHAR - a fixed-length string. (The value may be padded with spaces.)
• NUMBER - a floating-point number.
• INTEGER - an integer (whole number).
• TIMESTAMP - a date and time, stored in Unix epoch format.
• DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings and char may also have a maximum length specified, such as STRING_100.

Example: ["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

Example: XYZ Pay Group

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

iduuid

The Group ID.

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsuuid[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_propertiesobject

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field, or custom_fields.users_email.value.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2float

UNUSED FIELD This is a legacy field that is no longer used.

reserved3float

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

id_timebankstring

The internal ID of the Time Bank associated with this Accrual; same as the id field. This ID cannot be changed once created.

Example: 1A40D7570AF94AFDB286D0697DEA5CF3

limits_descriptionstring

A generated short description of the limits for this Accrual that describes the hard and soft limits in human-readable terms.

Example: Min 0.00

limits_description_fullstring

A generated description of the limits for this Accrual that describes the hard and soft limits in human-readable terms in long form.

Example: Minimum balance of 0.00 hours is enforced.

pay_type_namesstring[]

The printable names (labels) of the Pay Types associated with this Accrual. These Pay Types are the types of time that can be used to pay for time off.

Example: ["Vacation","Sick"]

pay_type_names_strstring

A comma-separated string of the printable names (labels) of the Pay Types associated with this Accrual.

Example: Vacation, Sick

pay_type_urisstring[]

The URIs of the Pay Types associated with this Accrual. These Pay Types are the types of time that can be used to pay for time off.

Example: ["/api/v1/entry_codes/codes_pay_types/Vacation","/api/v1/entry_codes/codes_pay_types/Sick"]

warning_typestring

An internal code that describes the format of the accrual record.

Example: v2

Accrual

{
  "id_timebank": "1A40D7570AF94AFDB286D0697DEA5CF3",
  "limits_description": "Min 0.00",
  "limits_description_full": "Minimum balance of 0.00 hours is enforced.",
  "pay_type_names": [
    "Vacation",
    "Sick"
  ],
  "pay_type_names_str": "Vacation, Sick",
  "pay_type_uris": [
    "/api/v1/entry_codes/codes_pay_types/Vacation",
    "/api/v1/entry_codes/codes_pay_types/Sick"
  ],
  "warning_type": "v2",
  "id": "64BBA147B9AC41D9978062300826C89F",
  "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
  "tablename": "users",
  "table_label": "codes_pay_types",
  "hard_threshold": 0,
  "hours_left": 40,
  "id_user": "64BBA147B9AC41D9978062300826C89F",
  "id_user_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "custom_fields": {
      "C41B2DDA662F4EF6B730F9CB6DB04696": {
        "attr_type": "ENUM_STRING_252",
        "description": "Employee pay group.",
        "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
        "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
        "pname": "Pay Group",
        "value": "XYZ Pay Group"
      },
      "users_email": {
        "attr_type": "STRING_252",
        "description": "Email address",
        "id_attr_type": "users_email",
        "id_attr_type_uri": "/api/v1/custom_fields/users_email",
        "pname": "Email Address",
        "value": "username@example.com"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {},
    "create_timestamp": 1696021987.01375,
    "create_timestamp_date_long": "Wednesday, March 22, 2023",
    "create_timestamp_date_short": "03/22/2023",
    "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "modifier": "64BBA147B9AC41D9978062300826C89F",
    "modifier_fullname": "John Doe",
    "modifier_properties": {},
    "modify_timestamp": 1696021987.01375,
    "modify_timestamp_date_long": "Wednesday, March 22, 2023",
    "modify_timestamp_date_short": "03/22/2023",
    "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "id_domain": "install_root_dom",
    "daysinlist": 0,
    "email": "string",
    "first_name": "string",
    "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
    "last_name": "string",
    "memorized_sheet_choices": [
      {
        "value": "string",
        "text": "string"
      }
    ],
    "reserved1": "string",
    "reserved2": 0,
    "reserved3": 0,
    "timerecs_out": 0,
    "time_gui_properties": {},
    "travel_gui_properties": {},
    "expense_gui_properties": {}
  },
  "is_hidden": false,
  "pay_type_ids": [
    "string"
  ],
  "pname": "Vacation",
  "use_hard_threshold": true,
  "use_warning": true,
  "warning_threshold": 16,
  "hidden": true,
  "status": "Loggable and Reportable",
  "status_code": "lr",
  "creator": "64BBA147B9AC41D9978062300826C89F",
  "creator_fullname": "John Doe",
  "creator_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "custom_fields": {
      "C41B2DDA662F4EF6B730F9CB6DB04696": {
        "attr_type": "ENUM_STRING_252",
        "description": "Employee pay group.",
        "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
        "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
        "pname": "Pay Group",
        "value": "XYZ Pay Group"
      },
      "users_email": {
        "attr_type": "STRING_252",
        "description": "Email address",
        "id_attr_type": "users_email",
        "id_attr_type_uri": "/api/v1/custom_fields/users_email",
        "pname": "Email Address",
        "value": "username@example.com"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "create_timestamp": 1696021987.01375,
    "create_timestamp_date_long": "Wednesday, March 22, 2023",
    "create_timestamp_date_short": "03/22/2023",
    "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "modifier": "64BBA147B9AC41D9978062300826C89F",
    "modifier_fullname": "John Doe",
    "modifier_properties": {},
    "modify_timestamp": 1696021987.01375,
    "modify_timestamp_date_long": "Wednesday, March 22, 2023",
    "modify_timestamp_date_short": "03/22/2023",
    "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "id_domain": "install_root_dom",
    "daysinlist": 0,
    "email": "string",
    "first_name": "string",
    "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
    "last_name": "string",
    "memorized_sheet_choices": [
      {
        "value": "string",
        "text": "string"
      }
    ],
    "reserved1": "string",
    "reserved2": 0,
    "reserved3": 0,
    "timerecs_out": 0,
    "time_gui_properties": {},
    "travel_gui_properties": {},
    "expense_gui_properties": {}
  },
  "create_timestamp": 1696021987.01375,
  "create_timestamp_date_long": "Wednesday, March 22, 2023",
  "create_timestamp_date_short": "03/22/2023",
  "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
  "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
  "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
  "modifier": "64BBA147B9AC41D9978062300826C89F",
  "modifier_fullname": "John Doe",
  "modifier_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "custom_fields": {
      "C41B2DDA662F4EF6B730F9CB6DB04696": {
        "attr_type": "ENUM_STRING_252",
        "description": "Employee pay group.",
        "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
        "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
        "pname": "Pay Group",
        "value": "XYZ Pay Group"
      },
      "users_email": {
        "attr_type": "STRING_252",
        "description": "Email address",
        "id_attr_type": "users_email",
        "id_attr_type_uri": "/api/v1/custom_fields/users_email",
        "pname": "Email Address",
        "value": "username@example.com"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {},
    "create_timestamp": 1696021987.01375,
    "create_timestamp_date_long": "Wednesday, March 22, 2023",
    "create_timestamp_date_short": "03/22/2023",
    "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "modify_timestamp": 1696021987.01375,
    "modify_timestamp_date_long": "Wednesday, March 22, 2023",
    "modify_timestamp_date_short": "03/22/2023",
    "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "id_domain": "install_root_dom",
    "daysinlist": 0,
    "email": "string",
    "first_name": "string",
    "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
    "last_name": "string",
    "memorized_sheet_choices": [
      {
        "value": "string",
        "text": "string"
      }
    ],
    "reserved1": "string",
    "reserved2": 0,
    "reserved3": 0,
    "timerecs_out": 0,
    "time_gui_properties": {},
    "travel_gui_properties": {},
    "expense_gui_properties": {}
  },
  "modify_timestamp": 1696021987.01375,
  "modify_timestamp_date_long": "Wednesday, March 22, 2023",
  "modify_timestamp_date_short": "03/22/2023",
  "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
  "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
  "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
  "id_domain": "install_root_dom"
}