EntryCode

An Entry Code is a unique selection value in an Entry Screen column.

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

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"]

autoaddbooleanrequired

If true, this Entry Code is automatically added to new Groups as they are created.

Example: false

descriptionstring

A description of the Entry Code.

Example: This is a description of the Entry Code.

loggableboolean

If true, this Entry Code is currently loggable (usable) on Entry Screens.

Example: true

pnamestringrequired

The name of the Entry Code.

Example: Billable

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

custom_fields object

A map of custom fields. The key is the field ID and the value a description of the field.

Important: this will 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 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 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.

Example: XYZ Pay Group

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.

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.

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.

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.

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.

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.

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

entry_columns_uristring

The URI of the Entry Column associated with this Entry Code.

Example: /api/v1/entry_columns/time_recs.id_code_bill_type

entry_typestring

The Entry Screen type of this Entry Column value. Values can be: time, expense, mileage.

Example: time

favorite_uristring

The URI to control the Favorite status of this Entry Code for this user.

Example: /api/v1/favorites/user/my_user_id/codes_bill_types/20945205C94E4576B5FB798DA09B44DE

id_codestring

The unique internal ID of this Entry Code. (Same as id field.)

Example: 20945205C94E4576B5FB798DA09B44DE

EntryCode
{
  "entry_columns_uri": "/api/v1/entry_columns/time_recs.id_code_bill_type",
  "entry_type": "time",
  "favorite_uri": "/api/v1/favorites/user/my_user_id/codes_bill_types/20945205C94E4576B5FB798DA09B44DE",
  "id_code": "20945205C94E4576B5FB798DA09B44DE",
  "id": "64BBA147B9AC41D9978062300826C89F",
  "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
  "tablename": "users",
  "table_label": "codes_pay_types",
  "group_names": [
    {
      "id": "5088C427E8B64EBEBE1C5B5961DB1902",
      "pname": "Sales"
    },
    {
      "id": "3553F715A6F54DAB95D0D25B08468195",
      "pname": "Accounting"
    }
  ],
  "groups": [
    "5088C427E8B64EBEBE1C5B5961DB1902",
    "3553F715A6F54DAB95D0D25B08468195"
  ],
  "autoadd": false,
  "description": "This is a description of the Entry Code.",
  "loggable": true,
  "pname": "Billable",
  "is_hidden": true,
  "hidden": true,
  "status": "Loggable and Reportable",
  "status_code": "lr",
  "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"
    }
  },
  "creator": "64BBA147B9AC41D9978062300826C89F",
  "creator_fullname": "John Doe",
  "creator_properties": {
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "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": {
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "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"
}