AccrualsCollectionResponse
HTTP status code of the response for reference purposes.
200200Indicates whether the request was successful (normally true if it's
not an error response).
trueURL of the current request / resource, for reference purposes.
https://example.apps.journyx.com/api/v1/usersThe total number of items matching the query; not the number of items in the current response.
100The number of items skipped in the query; in other words, the offset of the first item in the current response compared to the total set of items in the collection. When used as a query parameter, this is the number of items to skip over.
0The number of items returned in the current response. When used as a query parameter, this is the maximum number of items to return.
10The URL to fetch the next set (page) of results.
https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10results object[]
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.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typesThe 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.
0The number of hours left in the Accrual - the hours balance.
40The internal ID of the User associated with this Accrual. Once set, this value cannot be changed.
64BBA147B9AC41D9978062300826C89Fid_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.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID.
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]Indicates whether the object is hidden.
See also status
Indicates whether the user is hidden.
Read-only alias for is_hidden.
The status of the user; either hidden, active, or inactive.
Possible values: [Hidden, Loggable and Reportable, Reportable Only]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The ID of the user's default memorized timesheet.
The number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John DoeExtended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John DoeExtended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAThe 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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
Indicates whether the object is hidden.
See also status
falseThe 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.
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.
VacationIf true, the hard threshold is enforced. If false, the hard threshold is ignored.
trueIf true, the warning ("soft") threshold is enforced. If false, the warning threshold is ignored.
trueThe 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.
16Indicates whether the user is hidden.
Read-only alias for is_hidden.
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]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John Doecreator_properties object
Extended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID.
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]Indicates whether the object is hidden.
See also status
Indicates whether the user is hidden.
Read-only alias for is_hidden.
The status of the user; either hidden, active, or inactive.
Possible values: [Hidden, Loggable and Reportable, Reportable Only]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The ID of the user's default memorized timesheet.
The number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John DoeExtended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAThe 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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John Doemodifier_properties object
Extended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID.
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]Indicates whether the object is hidden.
See also status
Indicates whether the user is hidden.
Read-only alias for is_hidden.
The status of the user; either hidden, active, or inactive.
Possible values: [Hidden, Loggable and Reportable, Reportable Only]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The ID of the user's default memorized timesheet.
The number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John DoeExtended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAThe 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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domThe internal ID of the Time Bank associated with this Accrual;
same as the id field. This ID cannot be changed once created.
1A40D7570AF94AFDB286D0697DEA5CF3A generated short description of the limits for this Accrual that describes the hard and soft limits in human-readable terms.
Min 0.00A generated description of the limits for this Accrual that describes the hard and soft limits in human-readable terms in long form.
Minimum balance of 0.00 hours is enforced.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.
["Vacation","Sick"]A comma-separated string of the printable names (labels) of the Pay Types associated with this Accrual.
Vacation, SickThe 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.
["/api/v1/entry_codes/codes_pay_types/Vacation","/api/v1/entry_codes/codes_pay_types/Sick"]An internal code that describes the format of the accrual record.
v2screen object
Defines various user interface properties for the web UI screen that this collection supports. This is an internal object that is read-only on most object endpoints and is not guaranteed to be a stable interface. This mainly defines the search filters available in the UI. This object may not be present in all collections.
:::warning Not available in every collection
This key (object) may not be present in all collections that refer to this schema.
:::
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typesThe internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John Doecreator_properties object
Extended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID.
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]Indicates whether the object is hidden.
See also status
Indicates whether the user is hidden.
Read-only alias for is_hidden.
The status of the user; either hidden, active, or inactive.
Possible values: [Hidden, Loggable and Reportable, Reportable Only]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The ID of the user's default memorized timesheet.
The number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John DoeExtended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAThe 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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John Doemodifier_properties object
Extended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID.
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]Indicates whether the object is hidden.
See also status
Indicates whether the user is hidden.
Read-only alias for is_hidden.
The status of the user; either hidden, active, or inactive.
Possible values: [Hidden, Loggable and Reportable, Reportable Only]
Loggable and ReportableThe internal code for the status of the object; either:
lrforLoggable and ReportableroforReportable OnlyhforHidden
Possible values: [lr, ro, h]
lrThe login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The ID of the user's default memorized timesheet.
The number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John DoeExtended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAThe 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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domIndicates whether the user can customize the columns displayed in the screen.
truecf_filters object[]
A list of custom field filters that are available for this screen.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupcf_filters_unused object[]
A list of custom field filters that are available for this screen, but are not currently used.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupfields object[]
The list of fields to show in this management screen's search results.
The default tooltip for the field shown when hovering over the field label.
The name of the Accrual.The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).
34If this field represents a Custom Field, this is the ID of the Custom Field Type.
nullThe hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.
id_user_properties.fullnameThe internal database ID for the configured field, if this is a global settings field.
34The unique identifier for the screen that this field belongs to.
accrualsWhether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.
falseWhether the field is a Custom Field.
falseWhether the field is a date-time field, which will be displayed as a formatted date-time value in the column.
falseWhether the field is a numeric field, which will be displayed as a formatted number in the column.
falseWhether the field is a percentage field, which will be displayed as a formatted percentage value in the column.
falseWhether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.
falseWhether the field is a URL field, which will be displayed as a clickable link in the column.
falseThe key for the field, which is used to identify the field in the
search results and in the API.
Same as id_field.
id_user_properties.fullnameThe label to show for this field in the management screen search results.
Owner NameThe order in which this field should be displayed in the search results.
1properties object
Additional extended properties of the field.
Whether the field is searchable in the search panel area on the management screen.
trueWhether the field is sortable in the search results.
trueLabel of the database table that stores field settings.
Field Config (global)The name of the database table that stores the field settings.
fields_config_globalThe tooltip to show for this field in the management screen search results.
The full name of the owner of this Accrual.Indicates whether the screen's global settings allow for per-user customization of the columns displayed in the screen.
trueThe unique internal ID of this screen. (Same as id.)
These are fixed values that are defined in the system.
accrualsIndicates whether this user is currently user global settings for this screen. If false, the user is using their own settings.
falseA list of other search filters that are available for this screen.
["project","group"]A list of other search filters that are available for this screen, but are not currently used.
["px_teams"]A list of additional properties for this screen. Currently unused.
{
"response_code": 200,
"success": true,
"uri": "https://example.apps.journyx.com/api/v1/users",
"$count": 100,
"$skip": 0,
"$top": 10,
"@nextLink": "https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10",
"results": [
{
"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",
"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"
}
],
"screen": {
"id": "64BBA147B9AC41D9978062300826C89F",
"uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
"tablename": "users",
"table_label": "codes_pay_types",
"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",
"allow_customize": true,
"cf_filters": [
{
"id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
"attr_type": [
"STRING_100",
"ENUM_STRING_20",
"M_ENUM_STRING_252",
"ENUM_INTEGER",
"NUMBER"
],
"description": "string",
"pname": "Pay Group",
"id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
"value": "XYZ Pay Group"
}
],
"cf_filters_unused": [
{
"id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
"attr_type": [
"STRING_100",
"ENUM_STRING_20",
"M_ENUM_STRING_252",
"ENUM_INTEGER",
"NUMBER"
],
"description": "string",
"pname": "Pay Group",
"id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
"value": "XYZ Pay Group"
}
],
"fields": [
{
"default_tooltip": "The name of the Accrual.",
"id": "34",
"id_attr_type": null,
"id_field": "id_user_properties.fullname",
"id_field_global": "34",
"id_screen": "accruals",
"is_boolean": false,
"is_custom_field": false,
"is_datetime_float": false,
"is_numeric": false,
"is_percent": false,
"is_truncated": false,
"is_url": false,
"key": "id_user_properties.fullname",
"label": "Owner Name",
"ordering": 1,
"properties": {},
"searchable": true,
"sortable": true,
"table_label": "Field Config (global)",
"tablename": "fields_config_global",
"tooltip": "The full name of the owner of this Accrual."
}
],
"global_allows_customize": true,
"id_screen": "accruals",
"is_global": false,
"other_search_filters": [
"project",
"group"
],
"other_search_filters_unused": [
"px_teams"
],
"properties": {}
}
}