jxAPI Types Reference

Warning: legacy API

This page is about the legacy SOAP-based jxAPI that is no longer updated or recommended for use in new projects. The documentation in this section may be outdated or inaccurate, and is provided for reference purposes only.

Journyx recommends using the REST-based API for new projects in most cases. However, at the current time, there are certain object types that are not available through the REST API.

AccessControlList

The following basic CRUD methods are available for this type:

• addFullAccessControlList
• addAccessControlLists
• modifyAccessControlList
• removeAccessControlList
• getDefaultAccessControlList
• getAccessControlList
• getAccessControlLists
• getAllAccessControlLists
• getAccessControlListById
• countAccessControlLists

Field	Type	Description
vid_object	string
acl_type	double
id_group	string

Accrual

An accrual.

The following basic CRUD methods are available for this type:

• addFullAccrual
• addAccruals
• modifyAccrual
• removeAccrual
• getDefaultAccrual
• getAccrual
• getAccruals
• getAllAccruals
• getAccrualById
• countAccruals

Field	Type	Description
id	string	The ID of this accrual (primary key).
id_user	string	The ID of the user this accrual applies to.
id_code_pay_type	string	ID of the pay type this accrual applies to.
warning_type	string	Should be 'v2'. Other types may exist before migration.
hours_left	double	How many hours are left in this accrual.
id_domain	string
hard_threshold	double	Threshold for hard cutoff.
warning_threshold	double	Threshold for a soft warning.
creator	string	ID of the user that created this accrual.
create_timestamp	double	Time stamp of when this accrual was created.
modifier	string	ID of the user that last modified this accrual.
modify_timestamp	double	Time stamp of when this accrual was last modified.
pname	string	Displayed name of this accrual.
is_hidden	int	Non-zero if this accrual is hidden.
use_warning	int	Non-zero if the soft warning threshold is to be used.
use_hard_threshold	int	Non-zero if the hard threshold is to be used.

AccrualEvent

An accrual log event.

The following basic CRUD methods are available for this type:

• addFullAccrualEvent
• addAccrualEvents
• modifyAccrualEvent
• removeAccrualEvent
• getDefaultAccrualEvent
• getAccrualEvent
• getAccrualEvents
• getAllAccrualEvents
• getAccrualEventById
• countAccrualEvents

Field	Type	Description
id_timebank_event	int	The ID of this event record.
id_timebank	string	The ID of the associated accrual.
event_code	string	The type of this event.
timestamp	double	The time at which the event was logged.
owner	string	The owner of the accrual.
modify_user	string	The user that caused this accrual event.
rule	string	A short description of the event
note	string	A free-form description or comment.
id_code_pay_type	string	The pay type of the associated accrual.
prev_hours_left	double	The previous hours left in the accrual.
new_hours_left	double	The new hours left in the accrual.
hours_left_diff	double	The difference in accrual hours left.
id_time_rec	string	The ID of the associated time record.
vid_timesheet	string	The ID of the associated time sheet.
prev_id_code_list	string	The previous code list.
new_id_code_list	string	The new code list.
prev_hard_threshold	double	The previous hard accrual threshold.
new_hard_threshold	double	The new hard accrual threshold.
prev_warning_threshold	double	The previous warning threshold.
new_warning_threshold	double	The new warning threshold.
prev_pname	string	The previous printable name of the accrual.
new_pname	string	The new printable name of the accrual.
prev_is_hidden	int	The previous 'hidden' state of the accrual.
new_is_hidden	int	The new 'hidden' state of the accrual.
prev_use_warning	int	The previous 'use warning' state of the accrual.
new_use_warning	int	The new 'use warning' state of the accrual.
prev_use_hard_threshold	int	The previous 'use hard threshold' state of the accrual.
new_use_hard_threshold	int	The new 'use hard threshold' state of the accrual.
record_date	string	The YYYYMMDD date of the associated time record.

AccrualRecord

An accrued time balance.

Field	Type	Description
id	string	The accrual ID.
code	string	The code (pay type) ID of this accrual.
type	string	One of 'Hard', 'Soft', or 'Hidden'.
hours	double	The accrual balance.

AllColumnRecords

Container for lists of full project and code records, used by methods that do bulk data retrieval.

• This type is not available in the following endpoints: zsi

Field	Type	Description
projects	list of ProjectRecord
projects_extra	list of ProjectExtra
mileage_vehicles	list of MileageVehicleRecord
codes_bill_types	list of SubsubcodeRecord
codes_expenses	list of ExpenseCodeRecord
codes_pay_types	list of SubcodeRecord
mileage_reasons	list of MileageReasonRecord
mileage_measurements	list of MileageMeasurementRecord
codes_tasks	list of CodeRecord
codes_currencies	list of ExpenseCurrencyRecord
codes_expense_sources	list of ExpenseSourceRecord
codes_time_4	list of CodesTime4Record
codes_time_5	list of CodesTime5Record
codes_time_6	list of CodesTime6Record
codes_time_7	list of CodesTime7Record
codes_expense_4	list of CodesExpense4Record
codes_expense_5	list of CodesExpense5Record
codes_expense_6	list of CodesExpense6Record
codes_expense_7	list of CodesExpense7Record
codes_custom_4	list of CodesCustom4Record
codes_custom_5	list of CodesCustom5Record
codes_custom_6	list of CodesCustom6Record
codes_custom_7	list of CodesCustom7Record

ApprovalObject

An approval plan.

Field	Type	Description
apprtype	string
id	string	The ID of this approval plan.
name	string	The displayed name of this approval plan.
userbefore	int	Number of days before end of period to send a reminder email.
userafter	int	Number of days after end of period to send a reminder email about a non-submitted sheet.
approverafter	int	Number of days after end of period to remind approver about un-approved sheets.
approversubmitted	int	Text to send to the approver when they have a sheet in queue.
backupafter	int	Number of days after end of period to notify backup approvers of un-approved sheets.
userrejected	int	Text to send to a user when their sheet is rejected.
userapproved	int	Text to send to a user when their sheet is approved.
bizid	string	The business process ID of this approval plan. Usually default[1-5] for 1 to 5 approvers.
type	string	The plan type: 'time', 'expense', or 'mileage'.
approver_1	string	The user ID of the first approver.
approver_2	string	The user ID of the second approver.
approver_3	string	The user ID of the third approver.
approver_4	string	The user ID of the fourth approver.
approver_5	string	The user ID of the fifth approver.
backup_approver_1	string	The user ID of the first backup approver.
backup_approver_2	string	The user ID of the second backup approver.
backup_approver_3	string	The user ID of the third backup approver.
backup_approver_4	string	The user ID of the fourth backup approver.
backup_approver_5	string	The user ID of the fifth backup approver.
userbeforesubject	string
userbeforebody	string
useraftersubject	string
approveraftersubject	string
approverafterbody	string
userrejectedsubject	string
userrejectedbody	string
userapprovedsubject	string
userapprovedbody	string
backupaftersubject	string
backupafterbody	string
backupafterqueue	string
approversubmittedsubject	string
approversubmittedbody	string
approverresubmitted	int
approverresubmittedsubject	string
approverresubmittedbody	string
appendtoemaillog	int
appendtosheetnotes	int
sendonweekends	int

AssignmentRecord

The following basic CRUD methods are available for this type:

• addFullAssignment
• addAssignments
• modifyAssignment
• removeAssignment
• getDefaultAssignment
• getAssignment
• getAssignments
• getAllAssignments
• getAssignmentById
• countAssignments

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getAssignmentAttributeTypes
• getAssignmentAttributes
• setAssignmentAttributes

Field	Type	Description
id_assignment	string
pname	string
id_project	string
id_user	string
id_role	string
id_group	string
state	int
utilization	double
msp_assignment_id	string
msp_file_id	string
daily_load	double
work_variance	double
start_variance	double
end_variance	double
duration_variance	double
scheduled_work	double
scheduled_start	double
scheduled_end	double
scheduled_duration	double
actual_work	double
actual_work_updated	double
actual_start	double
actual_end	double
actual_duration	double
estimated_work	double
estimated_work1	double
estimated_work2	double
id_requisition	string
is_managed	double	new in v11.2
id_team	string

Attachment

An attachment and its metadata.

Field	Type	Description
recid	string	The ID of the record this item is attached to.
uniqueid	string	The unique ID of the attachment.
parent_table	string	The name of the table the target record is in.
creator	string	The ID of the user who created this attachment.
creator_name	string	The full name of the user who created this attachment.
creator_login	string	The login name of the user who created this attachment.
create_timestamp	double	The timestamp of when this attachment was created, in seconds since epoch.
create_time	string	The time when this attachment was created, as a human readable string.
note	string	The description/note of the attachment.
filename	string	The original filename of the attachment.
mimetype	string	The MIME type of the attachment.
size	int	The size of the attachment.
size_str	string	The size of the attachment as a human readable string.
sha256	string	The SHA256 hash of the attachment file data.
attachment	string	The attachment file data, as base64.

AttributeQueryResult

A result from a custom field query.

Field	Type	Description
object_id	string	The ID of the object this custom field value belongs to.
attrtype_id	string	The ID of the custom field type describing the field.
attr_pname	string	The displayable name of the custom field.
value	string	The field value. Always a string even if the underlying result is numeric.

AttributeTypeRecord

A custom field definition (not its actual value, but the metadata about the field itself.)

Field	Type	Description
id_attr_type	string	The ID of this custom field.
table_name	string	The name of the table this custom field is on.
pname	string	The displayed name of this custom field.
description	string	The description of this custom field.
attr_type	string	The type of this custom field.
visibility	int	Visibility in web UI: 0=hidden, 1=editable, 2=read-only
id_domain	string	The domain this custom field is in, if any.
hidden_name	string	A read-only, hidden extra name for the field, usually equal to pname.
string_default	string	The default value for this custom field, for STRING/CHAR/DATE types.
numeric_default	double	The default value for this custom field, for NUMBER/INTEGER/TIMESTAMP types.

AttributeValue

Field	Type	Description
name	string
value	string

CellNote

Field	Type	Description
id	string	A unique ID for this note.
modified	boolean	Set to True if you have modified this note.
correction	boolean	True if this is a correction (audit level required) note.
text	string	The note text.

CodeRecord

An item in the "tasks" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullCode
• addCodes
• modifyCode
• removeCode
• getDefaultCode
• getCode
• getCodes
• getAllCodes
• getCodeById
• countCodes

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodeAttributeTypes

• getCodeAttributes

• setCodeAttributes This type is searchable. The following related methods are available:

• searchCodes

Objects of this type may be members of groups. The following related methods are available:

• addCodeToGroup
• removeCodeFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodes
• countLoggableCodes

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodes
• hideCode
• unhideCode

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesCustom4Record

An item in the "Custom Entry Field 4" column (or its renamed equivalent) of custom entry records.

The following basic CRUD methods are available for this type:

• addFullCodesCustom4
• addCodesCustom4s
• modifyCodesCustom4
• removeCodesCustom4
• getDefaultCodesCustom4
• getCodesCustom4
• getCodesCustom4s
• getAllCodesCustom4s
• getCodesCustom4ById
• countCodesCustom4s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesCustom4AttributeTypes

• getCodesCustom4Attributes

• setCodesCustom4Attributes This type is searchable. The following related methods are available:

• searchCodesCustom4s

Objects of this type may be members of groups. The following related methods are available:

• addCodesCustom4ToGroup
• removeCodesCustom4FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesCustom4s
• countLoggableCodesCustom4s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesCustom4s
• hideCodesCustom4
• unhideCodesCustom4

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesCustom5Record

An item in the "Custom Entry Field 5" column (or its renamed equivalent) of custom entry records.

The following basic CRUD methods are available for this type:

• addFullCodesCustom5
• addCodesCustom5s
• modifyCodesCustom5
• removeCodesCustom5
• getDefaultCodesCustom5
• getCodesCustom5
• getCodesCustom5s
• getAllCodesCustom5s
• getCodesCustom5ById
• countCodesCustom5s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesCustom5AttributeTypes

• getCodesCustom5Attributes

• setCodesCustom5Attributes This type is searchable. The following related methods are available:

• searchCodesCustom5s

Objects of this type may be members of groups. The following related methods are available:

• addCodesCustom5ToGroup
• removeCodesCustom5FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesCustom5s
• countLoggableCodesCustom5s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesCustom5s
• hideCodesCustom5
• unhideCodesCustom5

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesCustom6Record

An item in the "Custom Entry Field 6" column (or its renamed equivalent) of custom entry records.

The following basic CRUD methods are available for this type:

• addFullCodesCustom6
• addCodesCustom6s
• modifyCodesCustom6
• removeCodesCustom6
• getDefaultCodesCustom6
• getCodesCustom6
• getCodesCustom6s
• getAllCodesCustom6s
• getCodesCustom6ById
• countCodesCustom6s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesCustom6AttributeTypes

• getCodesCustom6Attributes

• setCodesCustom6Attributes This type is searchable. The following related methods are available:

• searchCodesCustom6s

Objects of this type may be members of groups. The following related methods are available:

• addCodesCustom6ToGroup
• removeCodesCustom6FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesCustom6s
• countLoggableCodesCustom6s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesCustom6s
• hideCodesCustom6
• unhideCodesCustom6

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesCustom7Record

An item in the "Custom Entry Field 7" column (or its renamed equivalent) of custom entry records.

The following basic CRUD methods are available for this type:

• addFullCodesCustom7
• addCodesCustom7s
• modifyCodesCustom7
• removeCodesCustom7
• getDefaultCodesCustom7
• getCodesCustom7
• getCodesCustom7s
• getAllCodesCustom7s
• getCodesCustom7ById
• countCodesCustom7s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesCustom7AttributeTypes

• getCodesCustom7Attributes

• setCodesCustom7Attributes This type is searchable. The following related methods are available:

• searchCodesCustom7s

Objects of this type may be members of groups. The following related methods are available:

• addCodesCustom7ToGroup
• removeCodesCustom7FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesCustom7s
• countLoggableCodesCustom7s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesCustom7s
• hideCodesCustom7
• unhideCodesCustom7

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesExpense4Record

An item in the "Expense Entry Field 4" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullCodesExpense4
• addCodesExpense4s
• modifyCodesExpense4
• removeCodesExpense4
• getDefaultCodesExpense4
• getCodesExpense4
• getCodesExpense4s
• getAllCodesExpense4s
• getCodesExpense4ById
• countCodesExpense4s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesExpense4AttributeTypes

• getCodesExpense4Attributes

• setCodesExpense4Attributes This type is searchable. The following related methods are available:

• searchCodesExpense4s

Objects of this type may be members of groups. The following related methods are available:

• addCodesExpense4ToGroup
• removeCodesExpense4FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesExpense4s
• countLoggableCodesExpense4s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesExpense4s
• hideCodesExpense4
• unhideCodesExpense4

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesExpense5Record

An item in the "Expense Entry Field 5" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullCodesExpense5
• addCodesExpense5s
• modifyCodesExpense5
• removeCodesExpense5
• getDefaultCodesExpense5
• getCodesExpense5
• getCodesExpense5s
• getAllCodesExpense5s
• getCodesExpense5ById
• countCodesExpense5s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesExpense5AttributeTypes

• getCodesExpense5Attributes

• setCodesExpense5Attributes This type is searchable. The following related methods are available:

• searchCodesExpense5s

Objects of this type may be members of groups. The following related methods are available:

• addCodesExpense5ToGroup
• removeCodesExpense5FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesExpense5s
• countLoggableCodesExpense5s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesExpense5s
• hideCodesExpense5
• unhideCodesExpense5

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesExpense6Record

An item in the "Expense Entry Field 6" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullCodesExpense6
• addCodesExpense6s
• modifyCodesExpense6
• removeCodesExpense6
• getDefaultCodesExpense6
• getCodesExpense6
• getCodesExpense6s
• getAllCodesExpense6s
• getCodesExpense6ById
• countCodesExpense6s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesExpense6AttributeTypes

• getCodesExpense6Attributes

• setCodesExpense6Attributes This type is searchable. The following related methods are available:

• searchCodesExpense6s

Objects of this type may be members of groups. The following related methods are available:

• addCodesExpense6ToGroup
• removeCodesExpense6FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesExpense6s
• countLoggableCodesExpense6s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesExpense6s
• hideCodesExpense6
• unhideCodesExpense6

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesExpense7Record

An item in the "Expense Entry Field 7" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullCodesExpense7
• addCodesExpense7s
• modifyCodesExpense7
• removeCodesExpense7
• getDefaultCodesExpense7
• getCodesExpense7
• getCodesExpense7s
• getAllCodesExpense7s
• getCodesExpense7ById
• countCodesExpense7s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesExpense7AttributeTypes

• getCodesExpense7Attributes

• setCodesExpense7Attributes This type is searchable. The following related methods are available:

• searchCodesExpense7s

Objects of this type may be members of groups. The following related methods are available:

• addCodesExpense7ToGroup
• removeCodesExpense7FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesExpense7s
• countLoggableCodesExpense7s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesExpense7s
• hideCodesExpense7
• unhideCodesExpense7

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesTime4Record

An item in the "Time Entry Field 4" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullCodesTime4
• addCodesTime4s
• modifyCodesTime4
• removeCodesTime4
• getDefaultCodesTime4
• getCodesTime4
• getCodesTime4s
• getAllCodesTime4s
• getCodesTime4ById
• countCodesTime4s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesTime4AttributeTypes

• getCodesTime4Attributes

• setCodesTime4Attributes This type is searchable. The following related methods are available:

• searchCodesTime4s

Objects of this type may be members of groups. The following related methods are available:

• addCodesTime4ToGroup
• removeCodesTime4FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesTime4s
• countLoggableCodesTime4s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesTime4s
• hideCodesTime4
• unhideCodesTime4

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesTime5Record

An item in the "Time Entry Field 5" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullCodesTime5
• addCodesTime5s
• modifyCodesTime5
• removeCodesTime5
• getDefaultCodesTime5
• getCodesTime5
• getCodesTime5s
• getAllCodesTime5s
• getCodesTime5ById
• countCodesTime5s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesTime5AttributeTypes

• getCodesTime5Attributes

• setCodesTime5Attributes This type is searchable. The following related methods are available:

• searchCodesTime5s

Objects of this type may be members of groups. The following related methods are available:

• addCodesTime5ToGroup
• removeCodesTime5FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesTime5s
• countLoggableCodesTime5s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesTime5s
• hideCodesTime5
• unhideCodesTime5

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesTime6Record

An item in the "Time Entry Field 6" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullCodesTime6
• addCodesTime6s
• modifyCodesTime6
• removeCodesTime6
• getDefaultCodesTime6
• getCodesTime6
• getCodesTime6s
• getAllCodesTime6s
• getCodesTime6ById
• countCodesTime6s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesTime6AttributeTypes

• getCodesTime6Attributes

• setCodesTime6Attributes This type is searchable. The following related methods are available:

• searchCodesTime6s

Objects of this type may be members of groups. The following related methods are available:

• addCodesTime6ToGroup
• removeCodesTime6FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesTime6s
• countLoggableCodesTime6s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesTime6s
• hideCodesTime6
• unhideCodesTime6

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

CodesTime7Record

An item in the "Time Entry Field 7" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullCodesTime7
• addCodesTime7s
• modifyCodesTime7
• removeCodesTime7
• getDefaultCodesTime7
• getCodesTime7
• getCodesTime7s
• getAllCodesTime7s
• getCodesTime7ById
• countCodesTime7s

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getCodesTime7AttributeTypes

• getCodesTime7Attributes

• setCodesTime7Attributes This type is searchable. The following related methods are available:

• searchCodesTime7s

Objects of this type may be members of groups. The following related methods are available:

• addCodesTime7ToGroup
• removeCodesTime7FromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableCodesTime7s
• countLoggableCodesTime7s

Objects of this type may be hidden. The following related methods are available:

• getHiddenCodesTime7s
• hideCodesTime7
• unhideCodesTime7

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
creator	string	The ID of the user that created this item.
create_timestamp	string	The time this item was created.
modifier	string	The ID of the user that last modified this item.
modify_timestamp	string	The time this item was last modified.

ColumnDependency

A column-to-column dependency.

Field	Type	Description
parent_table	string	The parent table name.
parent_id	string	The parent record ID.
child_table	string	The child table name.
child_id	string	The child record ID.

CurrencyConversion

The following basic CRUD methods are available for this type:

• addFullCurrencyConversion
• addCurrencyConversions
• modifyCurrencyConversion
• removeCurrencyConversion
• getDefaultCurrencyConversion
• getCurrencyConversion
• getCurrencyConversions
• getAllCurrencyConversions
• getCurrencyConversionById
• countCurrencyConversions

Field	Type	Description
id_currency_conversion	string
start_date	string
stop_date	string
id_domain	string
convert_from	string
convert_to	string
convert_factor	string

DisplaySettings

Server-configurable settings related to displaying time/expense/custom entry screens.

• This type is not available in the following endpoints: zsi

Field	Type	Description
time_label	string	The label of the time entry table.
time_column_names	list of string	The names of the time entry columns (project, 3 codes, comment).
time_column_priority	list of int	The ordering of the time entry columns.
expense_label	string	The label of the expense entry table.
expense_column_names	list of string	The names of the expense entry columns (project, 3 codes, comment).
expense_column_priority	list of int	The ordering of the expense entry columns.
custom_label	string	The label of the custom entry table.
custom_column_names	list of string	The names of the custom entry columns (project, 3 codes, comment).
custom_column_priority	list of int	The ordering of the custom entry columns.
allow_blank_comments	boolean	If true, blank comments are allowed; if false, they must not be blank.
time_grid	string
time_view_future	boolean
time_view_past	boolean
expense_view_future	boolean
expense_view_past	boolean
custom_view_future	boolean
custom_view_past	boolean

ExpenseCodeRecord

An item in the "expense code" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullExpenseCode
• addExpenseCodes
• modifyExpenseCode
• removeExpenseCode
• getDefaultExpenseCode
• getExpenseCode
• getExpenseCodes
• getAllExpenseCodes
• getExpenseCodeById
• countExpenseCodes

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getExpenseCodeAttributeTypes

• getExpenseCodeAttributes

• setExpenseCodeAttributes This type is searchable. The following related methods are available:

• searchExpenseCodes

Objects of this type may be members of groups. The following related methods are available:

• addExpenseCodeToGroup
• removeExpenseCodeFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableExpenseCodes
• countLoggableExpenseCodes

Objects of this type may be hidden. The following related methods are available:

• getHiddenExpenseCodes
• hideExpenseCode
• unhideExpenseCode

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

ExpenseCurrencyRecord

An item in the "currency" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullExpenseCurrency
• addExpenseCurrencys
• modifyExpenseCurrency
• removeExpenseCurrency
• getDefaultExpenseCurrency
• getExpenseCurrency
• getExpenseCurrencys
• getAllExpenseCurrencys
• getExpenseCurrencyById
• countExpenseCurrencys

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getExpenseCurrencyAttributeTypes

• getExpenseCurrencyAttributes

• setExpenseCurrencyAttributes This type is searchable. The following related methods are available:

• searchExpenseCurrencys

Objects of this type may be members of groups. The following related methods are available:

• addExpenseCurrencyToGroup
• removeExpenseCurrencyFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableExpenseCurrencys
• countLoggableExpenseCurrencys

Objects of this type may be hidden. The following related methods are available:

• getHiddenExpenseCurrencys
• hideExpenseCurrency
• unhideExpenseCurrency

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

ExpenseGUI

Objects of this type may be members of groups. The following related methods are available:

• addExpenseGUIToGroup
• removeExpenseGUIFromGroup

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• code_expense_4_priority
• code_expense_4_default
• code_expense_5_priority
• code_expense_5_default
• code_expense_6_priority
• code_expense_6_default
• code_expense_7_priority
• code_expense_7_default
• text2_priority
• text2_default
• text3_priority
• text3_default
• text2_max_chars
• text3_max_chars

Field	Type	Description
id_expense_gui	string
pname	string
project_priority	int
project_default	string
expense_priority	int
expense_default	string
comment_priority	int
comment_default	string
currency_priority	int
currency_default	string
source_priority	int
source_default	string
id_domain	string
auto_add	int
reserved1	string
arrows	int
totals	string
projecttree	string
backwards	int
blankrows	string
javascript	int
projectdesc	int
diary_notes	string
future2	string
future3	string
future4	string
future5	string
future6	string
future7	string
future8	string
pre_html	string
post_html	string
max_attachments	int
attachment_rule	int
use_deps_for_hidden	int
comment_max_chars	int
use_suggestions	int
code_expense_4_priority	int
code_expense_4_default	string
code_expense_5_priority	int
code_expense_5_default	string
code_expense_6_priority	int
code_expense_6_default	string
code_expense_7_priority	int
code_expense_7_default	string
text2_priority	int
text2_default	string
text3_priority	int
text3_default	string
text2_max_chars	int
text3_max_chars	int

ExpenseMileageConversion

A mileage-to-expense conversion rate definition.

Field	Type	Description
id_mileage_conversion	string	The ID of this record.
start_date	string	The starting date for this rate to be used.
stop_date	string	The stop date for this rate to be used.
id_domain	string	The domain this rate is in, if any.
id_code_expense	string	The expense code for the conversion.
rate	string	The rate of conversion from miles (or other travel units) to expenses.
id_currency	string	The conversion currency.

ExpenseRecord

An entry in the expense record table. Note that there may be more than one record for a single project/code/date combo which will be combined when shown in the web UI, and that amounts may be negative to represent corrections.

The following basic CRUD methods are available for this type:

• addFullExpenseRecord
• addExpenseRecords
• modifyExpenseRecord
• removeExpenseRecord
• getDefaultExpenseRecord
• getExpenseRecord
• getExpenseRecords
• getAllExpenseRecords
• getExpenseRecordById
• countExpenseRecords

Automatic name to ID conversion is available for this type, for the following fields:

user, project, expense_code, currency, source, expense4, expense5, expense6, expense7. Name conversion is performed by the following variant methods:

• addFullExpenseRecordWithNames
• addExpenseRecordsWithNames
• modifyExpenseRecordWithNames
• modifyExpenseRecordsWithNames
• getExpenseRecordWithNames
• getExpenseRecordsWithNames

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 10.0.

• id_assignment

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 11.2.

• id_suggestion

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• id_code_expense_4
• id_code_expense_5
• id_code_expense_6
• id_code_expense_7
• text2
• text3

Field	Type	Description
id	string	The record ID.
user	string	The record's user ID (not login).
date	string	The date of the record, in YYYYMMDD format.
project	string	The record's project ID.
expense_code	string	The record's expense code (or renamed equivalent) ID.
amount	double	The amount of expense units represented by the record.
comment	string	The comment for this record.
committed	boolean	Reserved; cannot be modified through the jxAPI.
currency	string	The record's currency (or renamed equivalent) ID.
source	string	The record's expense source (or renamed equivalent) ID.
domain	string	The domain ID for this record, if any.
rocomment	string	Read only comment.
flags	string	Deprecated; do not use.
picture	string	Deprecated; do not use.
extra1	string	Reserved; do not use.
extra2	string	Reserved; do not use.
created_by	string	The ID of the user that created this record.
create_time	double	Creation timestamp, in seconds since epoch.
modified_by	string	The ID of the user that last modified this record.
modify_time	double	Modification timestamp, in seconds since epoch.
mileage	double	Travel distance for automatic conversion.
id_assignment	string	ID of assignment associated with this record.
id_suggestion	int	ID of suggestion associated with this record.
id_code_expense_4	string	Optional Expense Entry Field 4
id_code_expense_5	string	Optional Expense Entry Field 5
id_code_expense_6	string	Optional Expense Entry Field 6
id_code_expense_7	string	Optional Expense Entry Field 7
text2	string	Optional Expense Entry Text 2
text3	string	Optional Expense Entry Text 3

ExpenseSourceRecord

An item in the "expense source" column (or its renamed equivalent) of expense records.

The following basic CRUD methods are available for this type:

• addFullExpenseSource
• addExpenseSources
• modifyExpenseSource
• removeExpenseSource
• getDefaultExpenseSource
• getExpenseSource
• getExpenseSources
• getAllExpenseSources
• getExpenseSourceById
• countExpenseSources

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getExpenseSourceAttributeTypes

• getExpenseSourceAttributes

• setExpenseSourceAttributes This type is searchable. The following related methods are available:

• searchExpenseSources

Objects of this type may be members of groups. The following related methods are available:

• addExpenseSourceToGroup
• removeExpenseSourceFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableExpenseSources
• countLoggableExpenseSources

Objects of this type may be hidden. The following related methods are available:

• getHiddenExpenseSources
• hideExpenseSource
• unhideExpenseSource

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

GroupRecord

A group.

The following basic CRUD methods are available for this type:

• addFullGroup
• addGroups
• modifyGroup
• removeGroup
• getDefaultGroup
• getGroup
• getGroups
• getAllGroups
• getGroupById
• countGroups

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getGroupAttributeTypes

• getGroupAttributes

• setGroupAttributes This type is searchable. The following related methods are available:

• searchGroups

Field	Type	Description
id	string	The group id.
description	string	The group description.
name	string	The group name.
parent	string	The ID of the group's parent group, if any.
domain	string	The ID of the group's domain, if any.
type	int	The group type. 1 for regular groups, other numbers for PS, ProjectLink, PX, etc.

ImportResults

Results of running an import on the server.

Field	Type	Description
messages	list of string	A list of informational messages from the import module, if any.
warnings	list of string	A list of warning messages from the import module, if any.
errors	list of string	A list of error messages from the import module, if any.

Item

Field	Type	Description
key	string
value	any

MemorizedEntries

A list of memorized entries that apply to a specific entry type and user or group.

Field	Type	Description
id	string	The ID of the user or group.
type	string	The entry type.
entries	list of MemorizedEntry	The list of memorized entries.

MemorizedEntry

A saved entry row that is added to new sheets in the web UI for user convenience.

Field	Type	Description
id	string	The ID of this memorized entry.
group	string	The ID of this memorized entry's group.
project	string	The ID of the memorized project.
code1	string	The ID of the first memorized code column.
code2	string	The ID of the second memorized code column.
code3	string	The ID of the third memorized code column.
comment	string	The memorized comment.

MileageGUI

Objects of this type may be members of groups. The following related methods are available:

• addMileageGUIToGroup
• removeMileageGUIFromGroup

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• code_custom_4_priority
• code_custom_4_default
• code_custom_5_priority
• code_custom_5_default
• code_custom_6_priority
• code_custom_6_default
• code_custom_7_priority
• code_custom_7_default
• text2_priority
• text2_default
• text3_priority
• text3_default
• text2_max_chars
• text3_max_chars

Field	Type	Description
id_travel_entry_gui	string
pname	string
project_priority	int
project_default	string
reason_priority	int
reason_default	string
comment_priority	int
comment_default	string
measurement_priority	int
measurement_default	string
vehicle_priority	int
vehicle_default	string
id_domain	string
auto_add	double
reserved1	string
arrows	int
totals	string
projecttree	string
backwards	int
blankrows	string
javascript	int
projectdesc	int
diary_notes	string
future2	string
future3	string
future4	string
future5	string
future6	string
future7	string
future8	string
pre_html	string
post_html	string
max_attachments	int
attachment_rule	int
use_deps_for_hidden	int
comment_max_chars	int
use_suggestions	int
code_custom_4_priority	int
code_custom_4_default	string
code_custom_5_priority	int
code_custom_5_default	string
code_custom_6_priority	int
code_custom_6_default	string
code_custom_7_priority	int
code_custom_7_default	string
text2_priority	int
text2_default	string
text3_priority	int
text3_default	string
text2_max_chars	int
text3_max_chars	int

MileageMeasurementRecord

An item in the "measurement" column (or its renamed equivalent) of travel/custom records.

The following basic CRUD methods are available for this type:

• addFullMileageMeasurement
• addMileageMeasurements
• modifyMileageMeasurement
• removeMileageMeasurement
• getDefaultMileageMeasurement
• getMileageMeasurement
• getMileageMeasurements
• getAllMileageMeasurements
• getMileageMeasurementById
• countMileageMeasurements

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getMileageMeasurementAttributeTypes

• getMileageMeasurementAttributes

• setMileageMeasurementAttributes This type is searchable. The following related methods are available:

• searchMileageMeasurements

Objects of this type may be members of groups. The following related methods are available:

• addMileageMeasurementToGroup
• removeMileageMeasurementFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableMileageMeasurements
• countLoggableMileageMeasurements

Objects of this type may be hidden. The following related methods are available:

• getHiddenMileageMeasurements
• hideMileageMeasurement
• unhideMileageMeasurement

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

MileageReasonRecord

An item in the "reason" column (or its renamed equivalent) of travel/custom records.

The following basic CRUD methods are available for this type:

• addFullMileageReason
• addMileageReasons
• modifyMileageReason
• removeMileageReason
• getDefaultMileageReason
• getMileageReason
• getMileageReasons
• getAllMileageReasons
• getMileageReasonById
• countMileageReasons

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getMileageReasonAttributeTypes

• getMileageReasonAttributes

• setMileageReasonAttributes This type is searchable. The following related methods are available:

• searchMileageReasons

Objects of this type may be members of groups. The following related methods are available:

• addMileageReasonToGroup
• removeMileageReasonFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableMileageReasons
• countLoggableMileageReasons

Objects of this type may be hidden. The following related methods are available:

• getHiddenMileageReasons
• hideMileageReason
• unhideMileageReason

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

MileageRecord

An entry in the custom record table. Note that there may be more than one record for a single project/code/date combo which will be combined when shown in the web UI, and that amounts may be negative to represent corrections.

The following basic CRUD methods are available for this type:

• addFullMileageRecord
• addMileageRecords
• modifyMileageRecord
• removeMileageRecord
• getDefaultMileageRecord
• getMileageRecord
• getMileageRecords
• getAllMileageRecords
• getMileageRecordById
• countMileageRecords

Automatic name to ID conversion is available for this type, for the following fields:

user, project, reason, vehicle, measurement, custom4, custom5, custom6, custom7. Name conversion is performed by the following variant methods:

• addFullMileageRecordWithNames
• addMileageRecordsWithNames
• modifyMileageRecordWithNames
• modifyMileageRecordsWithNames
• getMileageRecordWithNames
• getMileageRecordsWithNames

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 10.0.

• id_assignment

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 11.2.

• id_suggestion

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• id_code_custom_4
• id_code_custom_5
• id_code_custom_6
• id_code_custom_7
• text2
• text3

Field	Type	Description
id	string	The record ID.
user	string	The record's user ID (not login).
date	string	The date of the record, in YYYYMMDD format.
project	string	The record's project ID.
reason	string	The record's reason (or renamed equivalent) ID.
distance	double	The amount of custom units represented by the record.
comment	string	The comment for this record.
committed	boolean	Reserved; cannot be modified through the jxAPI.
measurement	string	The record's measurement (or renamed equivalent) ID.
vehicle	string	The record's vehicle (or renamed equivalent) ID.
domain	string	The domain ID for this record, if any.
extra	string	Reserved; do not use.
flags	string	Deprecated; do not use.
created_by	string	The ID of the user that created this record.
create_time	double	Creation timestamp, in seconds since epoch.
modified_by	string	The ID of the user that last modified this record.
modify_time	double	Modification timestamp, in seconds since epoch.
id_assignment	string	ID of assignment associated with this record.
id_suggestion	int	ID of suggestion associated with this record.
id_code_custom_4	string	Optional Custom Entry Field 4
id_code_custom_5	string	Optional Custom Entry Field 5
id_code_custom_6	string	Optional Custom Entry Field 6
id_code_custom_7	string	Optional Custom Entry Field 7
text2	string	Optional Custom Entry Text 2
text3	string	Optional Custom Entry Text 3

MileageVehicleRecord

An item in the "vehicle" column (or its renamed equivalent) of travel/custom records.

The following basic CRUD methods are available for this type:

• addFullMileageVehicle
• addMileageVehicles
• modifyMileageVehicle
• removeMileageVehicle
• getDefaultMileageVehicle
• getMileageVehicle
• getMileageVehicles
• getAllMileageVehicles
• getMileageVehicleById
• countMileageVehicles

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getMileageVehicleAttributeTypes

• getMileageVehicleAttributes

• setMileageVehicleAttributes This type is searchable. The following related methods are available:

• searchMileageVehicles

Objects of this type may be members of groups. The following related methods are available:

• addMileageVehicleToGroup
• removeMileageVehicleFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableMileageVehicles
• countLoggableMileageVehicles

Objects of this type may be hidden. The following related methods are available:

• getHiddenMileageVehicles
• hideMileageVehicle
• unhideMileageVehicle

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

MobileAppSettings

Extra server-configurable settings related to the Journyx mobile app.

Field	Type	Description
time_submit_enabled	boolean	True if mobile time submission is allowed.

NoteRecord

A note record.

Automatic name to ID conversion is available for this type, for the following fields:

user, project. Name conversion is performed by the following variant methods:

warning

Missing links here.

• addFullNoteWithNames
• addNotesWithNames
• modifyNoteWithNames
• modifyNotesWithNames
• getNoteWithNames
• getNotesWithNames

Field	Type	Description
id	string	The ID of this record.
note_rec_start	string	Deprecated; now always the same as 'id'.
user	string	The ID of the user that this note is associated with.
project	string	The ID of the project that this note is associated with.
update_timestamp	double	Time when the note was updated, in seconds since epoch.
the_text	string	The note text.
chunk	string	Deprecated; do not use.
domain	string	The ID of the domain this note is in, if any.
time_rec	string	The ID of the time record this note is associated with, if any.
expense_rec	string	The ID of the expense record this note is associated with, if any.
travel_rec	string	The ID of the travel/custom rec this note is associated with, if any.
vid_object	string
table_name	string
correction	int
locked	int

Period

This type encapsulates all information about a period for a specific user, specifically all three sheets (time, expense, and custom) that cover a specific requested date. Note that the sheets may not actually contain all row data, if only the header information was requested.

Field	Type	Description
time_sheet	Sheet	The user's time sheet.
expense_sheet	Sheet	The user's expense sheet.
custom_sheet	Sheet	The user's custom sheet.

Prediction

Field	Type	Description
id_item	string
relevance	double

ProjectApproval

A project approval entry.

The following basic CRUD methods are available for this type:

• addFullProjectApproval
• addProjectApprovals
• modifyProjectApproval
• removeProjectApproval
• getDefaultProjectApproval
• getProjectApproval
• getProjectApprovals
• getAllProjectApprovals
• getProjectApprovalById
• countProjectApprovals

Field	Type	Description
id_projectapproval	string	The ID of the project approval entry.
id_project	string	The ID of the project.
id_domain	string	The domain ID, if any.

ProjectApprovalInfo

An entry in the project approval queue.

Field	Type	Description
id	string	The ID of the approval queue entry.
project_id	string	The ID of the project to approve.
project_name	string	The printable name of the project to approve.
sheet_id	string	The ID of the sheet to approve the project on.
user_login	string	The login ID of the user whose sheet it is.
user_name	string	The name of the user whose sheet it is.
type	string	One of 'time', 'expense', or 'mileage'.
period	string	The name of the period the sheet is based on.
level	string	The level at which the sheet is to be approved.
amount	double	The amount of hours, expense units, or custom units reported.
approver_login	string	The login ID of the current approver.
approver_name	string	The full name of the current approver.
state	string	The current state: 'APPROVED', 'NOT APPROVED', or 'REJECTED'.
user_id	string	The ID of the user whose sheet it is.
approver_id	string	The ID of the current approver.

ProjectApprovalSetting

A project approval setting.

The following basic CRUD methods are available for this type:

• addFullProjectApprovalSetting
• addProjectApprovalSettings
• modifyProjectApprovalSetting
• removeProjectApprovalSetting
• getDefaultProjectApprovalSetting
• getProjectApprovalSetting
• getProjectApprovalSettings
• getAllProjectApprovalSettings
• getProjectApprovalSettingById
• countProjectApprovalSettings

Field	Type	Description
id_projectapprovalsettings	string	The ID of this setting.
id_projectapproval	string	The ID of the project approval entry this setting applies to.
setting_type	string	The setting type.
small_string	string	The value of the setting, if it is a small string.
mid_string	string	The value of the setting, if it is a medium sized string.
big_string	string	The value of the setting, if it is a big string.
integer	int	The value of the setting, if it is an integer.
id_domain	string	The domain ID, if any.

ProjectApprover

An approver for projects.

The following basic CRUD methods are available for this type:

• addFullProjectApprover
• addProjectApprovers
• modifyProjectApprover
• removeProjectApprover
• getDefaultProjectApprover
• getProjectApprover
• getProjectApprovers
• getAllProjectApprovers
• getProjectApproverById
• countProjectApprovers

Field	Type	Description
id_projectapprover	string	The ID for this record.
id_projectapproval	string	The ID of the project approval entry this approver is associated with.
id_user	string	The ID of the approver's user record.
level	int	What level of approval this user is responsible for.
id_domain	string	The domain ID, if any.

ProjectCodeRate

The following basic CRUD methods are available for this type:

• addFullProjectCodeRate
• addProjectCodeRates
• modifyProjectCodeRate
• removeProjectCodeRate
• getDefaultProjectCodeRate
• getProjectCodeRate
• getProjectCodeRates
• getAllProjectCodeRates
• getProjectCodeRateById
• countProjectCodeRates

Field	Type	Description
id_rate	string
id_project	string
id_code	string
start_date	string
stop_date	string
pay_rate	double
bill_rate	double
description	string
id_domain	string

ProjectDependencies

Code column dependencies (IDs only) for a single project.

• This type is not available in the following endpoints: zsi

Field	Type	Description
project_id	string	The project ID.
project_name	string	The project's displayed name.
project_description	string	The project's description.
mileage_vehicles	list of string
codes_bill_types	list of string
codes_expenses	list of string
codes_pay_types	list of string
mileage_reasons	list of string
mileage_measurements	list of string
codes_tasks	list of string
codes_currencies	list of string
codes_expense_sources	list of string
codes_time_4	list of string
codes_time_5	list of string
codes_time_6	list of string
codes_time_7	list of string
codes_expense_4	list of string
codes_expense_5	list of string
codes_expense_6	list of string
codes_expense_7	list of string
codes_custom_4	list of string
codes_custom_5	list of string
codes_custom_6	list of string
codes_custom_7	list of string

ProjectExtra

Extra information about a project, containing fields that are not accessible from the jxAPI prior to 10.0.

• This type is not available in the following endpoints: zsi

Field	Type	Description
project_id	string	The project ID.
allow_time	int	1 if the project is allowed to be used in time entry.
allow_expense	int	1 if the project is allowed to be used in expense entry.
allow_custom	int	1 if the project is allowed to be used in custom/travel entry.
allow_leave	int	1 if the project can be used to book leave requests.
allow_holiday	int	1 if the project can be used to book holiday time off.

ProjectPickerItem

The following basic CRUD methods are available for this type:

• addFullProjectPickerItem
• addProjectPickerItems
• modifyProjectPickerItem
• removeProjectPickerItem
• getDefaultProjectPickerItem
• getProjectPickerItem
• getProjectPickerItems
• getAllProjectPickerItems
• getProjectPickerItemById
• countProjectPickerItems

Field	Type	Description
id_project_picker	string
id_project	string
acl_type	double
id_user	string
id_domain	string
reserved1	string
reserved2	string
reserved3	string
reserved4	string

ProjectRecord

A project. Note that some fields refer to features that may not be available in your version of Journyx.

The following basic CRUD methods are available for this type:

• addFullProject
• addProjects
• modifyProject
• removeProject
• getDefaultProject
• getProject
• getProjects
• getAllProjects
• getProjectById
• countProjects

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getProjectAttributeTypes

• getProjectAttributes

• setProjectAttributes This type is searchable. The following related methods are available:

• searchProjects

Objects of this type may be members of groups. The following related methods are available:

• addProjectToGroup
• removeProjectFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableProjects
• countLoggableProjects

Objects of this type may be hidden. The following related methods are available:

• getHiddenProjects
• hideProject
• unhideProject

Automatic name to ID conversion is available for this type, for the following fields:

parent, creator. Name conversion is performed by the following variant methods:

• addFullProjectWithNames
• addProjectsWithNames
• modifyProjectWithNames
• modifyProjectsWithNames
• getProjectWithNames
• getProjectsWithNames
• getHiddenProjectsWithNames
• getLoggableProjectsWithNames
• searchProjectsWithNames

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 10.0.

• allow_time
• allow_expense
• allow_custom
• allow_leave
• allow_holiday

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.1.

• multiple_assns

Data types and versions

Note that the data types of certain fields like estimate and percent_done were int types in versions prior to 10.0, but are now double types.

Field	Type	Description
id	string	The project ID.
description	string	The project description.
parent	string	The ID of the project's parent project.
estimate	double	Estimated hours to complete the project.
percent_done	double	The percent of the project that is completed.
creator	string	The ID of the user that created the project.
loggable	string	Is the project loggable?
name	string	The project name.
domain	string	The ID of the domain this project is in, if any.
type	double	Project record type; generally always 1.
owner	string	The ID of the user that owns this project.
backup_owner	string	The ID of the backup owner of this project.
scheduled_work	double	PX scheduled work
scheduled_start	double	PX scheduled start
scheduled_end	double	PX scheduled end
scheduled_duration	double	PX scheduled duration
projected_cost	double	Budget projected cost
projected_return	double	Budget projected return
projected_profit	double	Budget projected profit
projected_roi	double	Budget projected ROI
awaiting_export	int	Is this project awaiting export with ProjectLink?
is_hidden	int	Is the project hidden?
allow_time	int	Can time be booked against the project?
allow_expense	int	Can expenses be booked against the project?
allow_custom	int	Can travel/custom be booked against the project?
allow_leave	int	Can leave requests be booked against the project?
allow_holiday	int	Can holidays be booked against the project?
propagate_pa_rates	int
multiple_assns	int
agile_team_assns	int

PS_DV_Assignments

The following basic CRUD methods are available for this type:

• addFullPS_DV_Assignments
• addPS_DV_Assignmentss
• modifyPS_DV_Assignments
• removePS_DV_Assignments
• getDefaultPS_DV_Assignments
• getPS_DV_Assignments
• getPS_DV_Assignmentss
• getAllPS_DV_Assignmentss
• getPS_DV_AssignmentsById
• countPS_DV_Assignmentss

Field	Type	Description
id_custom_field_rec	string
create_timestamp	double
creator	string
start_date	string
id_domain	string
id_rule	string
id_group	string
pay_group	string
apply_to_all	int

PS_DV_Rules

The following basic CRUD methods are available for this type:

• addFullPS_DV_Rules
• addPS_DV_Ruless
• modifyPS_DV_Rules
• removePS_DV_Rules
• getDefaultPS_DV_Rules
• getPS_DV_Rules
• getPS_DV_Ruless
• getAllPS_DV_Ruless
• getPS_DV_RulesById
• countPS_DV_Ruless

Field	Type	Description
id_custom_field_rec	string
create_timestamp	double
creator	string
start_date	string
id_domain	string
rule_category	string
selection_values	string
selection_table	string
selection_and_or	int
action	string
action_detail	string
scope	string
comparison	string
empty	int
target_values	string
target_table	string
target_and_or	int
amount	int
message	string

PSAccrualOverride

The following basic CRUD methods are available for this type:

• addFullPSAccrualOverride
• addPSAccrualOverrides
• modifyPSAccrualOverride
• removePSAccrualOverride
• getDefaultPSAccrualOverride
• getPSAccrualOverride
• getPSAccrualOverrides
• getAllPSAccrualOverrides
• getPSAccrualOverrideById
• countPSAccrualOverrides

Field	Type	Description
id_custom_field_rec	string
create_timestamp	double
creator	string
start_date	string
user	string
paytype	string
bonusmonths	double
carryoverlimitoverride	double
accrualssuspended	string
applycarryover	string

PSAccrualTierManager

The following basic CRUD methods are available for this type:

• addFullPSAccrualTierManager
• addPSAccrualTierManagers
• modifyPSAccrualTierManager
• removePSAccrualTierManager
• getDefaultPSAccrualTierManager
• getPSAccrualTierManager
• getPSAccrualTierManagers
• getAllPSAccrualTierManagers
• getPSAccrualTierManagerById
• countPSAccrualTierManagers

Field	Type	Description
id_custom_field_rec	string
create_timestamp	double
creator	string
start_date	string
empaccrualtype	string
floor	double
paytype	string
hoursgranted	double
accrualtype	string
defaultcarryoverlimit	double
applycalculation	string
applycarryover	string
carryoverpriority	string
prorate	string

PSCompensationTierManager

The following basic CRUD methods are available for this type:

• addFullPSCompensationTierManager
• addPSCompensationTierManagers
• modifyPSCompensationTierManager
• removePSCompensationTierManager
• getDefaultPSCompensationTierManager
• getPSCompensationTierManager
• getPSCompensationTierManagers
• getAllPSCompensationTierManagers
• getPSCompensationTierManagerById
• countPSCompensationTierManagers

Field	Type	Description
id_custom_field_rec	string
create_timestamp	double
creator	string
start_date	string
empaccrualtype	string
floor	double
loggedpaytype	string
earnedpaytype	string
multiplier	double
expirationwindow	int
accrualtype	string
defaultcarryoverlimit	double
applycalculation	string
applycarryover	string
carryoverpriority	string

PSMileageConversionResult

Field	Type	Description
converted	boolean
expense_rec	ExpenseRecord
mileage_rec	MileageRecord

PunchGUI

Objects of this type may be members of groups. The following related methods are available:

• addPunchGUIToGroup
• removePunchGUIFromGroup

Field	Type	Description
id_punch_gui	string
description	string
logout_after	double
display_memorized	double
display_recent_punches	double
how_many_days	double
show_totals	double
button_recent	double
button_current	double
button_accruals	double
show_project_hier	double
reserved1	double
group_priority	double
group_default	string
project_priority	double
project_default	string
task_priority	double
task_default	string
pay_type_priority	double
pay_type_default	string
bill_type_priority	double
bill_type_default	string
comment_priority	double
comment_default	string
id_domain	string
pre_html	string
post_html	string
code_time_4_priority	int
code_time_4_default	string
code_time_5_priority	int
code_time_5_default	string
code_time_6_priority	int
code_time_6_default	string
code_time_7_priority	int
code_time_7_default	string
text2_priority	int
text2_default	string
text3_priority	int
text3_default	string

PunchRecord

A punch entry.

The following basic CRUD methods are available for this type:

• addFullPunchRecord
• addPunchRecords
• modifyPunchRecord
• removePunchRecord
• getDefaultPunchRecord
• getPunchRecord
• getPunchRecords
• getAllPunchRecords
• getPunchRecordById
• countPunchRecords

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• id_code_time_4
• id_code_time_5
• id_code_time_6
• id_code_time_7
• text2
• text3

Field	Type	Description
id_punch	string	The ID of this record.
id_user	string	The ID of the user who punched in or out.
record_date	string	The date (YYYYMMDD) of this record.
id_code_task	string	The ID of the task (or renamed equivalent column) punched into/out of.
id_code_pay_type	string	The ID of the pay type (or renamed equivalent column) punched into/out of.
id_project	string	The ID of the project punched into/out of.
punch_datetime	string	The date and time of the punch, in ISO8601 format.
comment	string	The comment for this punch.
id_time_rec	string	The time record associated with this punch, if it has been converted to one.
when_exported	string	When the punch was exported, in ISO8601 format.
id_code_bill_type	string	The ID of the bill type (or renamed equivalent column) punched into/out of.
pre_or_post	double	If 0, the in punch determines time record fields; if 1, the out punch does.
id_group	string	The ID of the group this punch is in.
id_code_time_4	string
id_code_time_5	string
id_code_time_6	string
id_code_time_7	string
text2	string
text3	string

PXTeamRecord

A Team for PX Resources and assignment planning.

Team visibility (for management purposes) and team membership are both stored in the access_control_lists table. Use ACL Type 50 to determine the special membership group ID for a team. Use ACL Type 1 to determine what users belongs to that membership group ID. Use ACL Type 51 to determine viewability of Teams for management purposes.

The following basic CRUD methods are available for this type:

• addFullPXTeam
• addPXTeams
• modifyPXTeam
• removePXTeam
• getDefaultPXTeam
• getPXTeam
• getPXTeams
• getAllPXTeams
• getPXTeamById
• countPXTeams

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getPXTeamAttributeTypes

• getPXTeamAttributes

• setPXTeamAttributes This type is searchable. The following related methods are available:

• searchPXTeams

Objects of this type may be members of groups. The following related methods are available:

• addPXTeamToGroup
• removePXTeamFromGroup

Objects of this type may be hidden. The following related methods are available:

• getHiddenPXTeams
• hidePXTeam
• unhidePXTeam

Field	Type	Description
id	string	The team id.
name	string	The team name.
description	string	The team description.
team_type	int	The type of team - usually 1.
creator	string	The user ID who created the team.
create_timestamp	double	The epoch datetime when the team was created.
modifier	string	The user ID who last modified the team.
modify_timestamp	double	The epoch datetime when the team was last modified.
domain	string	The ID of the group's domain, if any.
auto_add	double	1 means automatically add to newly created groups. 0 to turn off.

RateCodeRecord

Rate Codes for rules and policies. Used to apply a code to a rate instead of a numeric value.

Warning: not available in all endpoints

Please note that the availability of this record type or certain fields in it may vary depending on if you access a versioned or unversioned endpoint. The unversioned endpoint typically corresponds to the oldest available versioned endpoint.

This field became available in the 10.0 endpoint.

The following basic CRUD methods are available for this type:

• addFullRateCode
• addRateCodes
• modifyRateCode
• removeRateCode
• getDefaultRateCode
• getRateCode
• getRateCodes
• getAllRateCodes
• getRateCodeById
• countRateCodes

This type is searchable. The following related methods are available:

• searchRateCodes

Field	Type	Description
id	string	The rate code id.
name	string	The rate code name.
description	string	The rate code description.
domain	string	The ID of the rate code's domain, if any.
active	int	1 if active.

RateRule

A business rule.

Field	Type	Description
id	string
name	string
description	string
project	list of string
code	list of string
subcode	list of string
othercode	list of string
hours	double
timeframe	string
actionType	string
autoreject	boolean
reason	string
condition	string
days	list of string
autoaccrual	boolean
accrueitem	string
descendants	boolean

RawSuggestion

Field	Type	Description
json_data	string
source_data	list of Item
extra_properties	list of Item

RecordStructureElement

Field	Type	Description
name	string
type	string

RequestRecord

The following basic CRUD methods are available for this type:

• addFullRequestRecord
• addRequestRecords
• modifyRequestRecord
• removeRequestRecord
• getDefaultRequestRecord
• getRequestRecord
• getRequestRecords
• getAllRequestRecords
• getRequestRecordById
• countRequestRecords

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• id_code_time_4
• id_code_time_5
• id_code_time_6
• id_code_time_7
• text2
• text3

Field	Type	Description
id_request_rec	string
id_user	string
record_date	string
id_code_task	string
id_code_pay_type	string
id_project	string
time_amount	double
comment	string
commit_state	int
id_domain	string
id_code_bill_type	string
id_group	string
reject_flag	int
id_rejector	string
extramid	string
extrabig	string
extraint	int
extrasms	string
submit_date	string
decline_date	string
decline_reason	string
id_holiday_type	string
note	string
id_code_time_4	string
id_code_time_5	string
id_code_time_6	string
id_code_time_7	string
text2	string
text3	string

RoleRecord

Objects of this type may be members of groups. The following related methods are available:

• addRoleRecordToGroup
• removeRoleRecordFromGroup

Field	Type	Description
id_role	string
description	string
abilities	string
id_domain	string
pname	string
auto_add	double
role_type	string
is_hidden	double

RowPunch

This type holds a single pair of in/out punch times and the time_rec id, if any, connected to the punches.

Field	Type	Description
time_in	string	The in time, in HHMMSS format.
time_out	string	The out time, in HHMMSS format.
mod_id	string	The time rec id or an empty string.

RowPunchList

This type holds in/out times for a single date in a row.

Field	Type	Description
punches	list of RowPunch	Zero or more RowPunch objects each representing an in/out time pair.

RuleSet

A set of business rules.

Field	Type	Description
name	string
description	string
rules	list of RuleSetRow
payRateOrigin	string
billRateOrigin	string

RuleSetRow

One row in a business rule set.

Field	Type	Description
rule	string
paytype	string
payamount	double
billtypeA	string
billamountA	double
billtypeB	string
billamountB	double
billtypeC	string
billamountC	double

Sheet

This type encapsulates an entire time/expense/custom sheet, including essentially all of the information shown in the web UI for that sheet.

Field	Type	Description
id	string	The sheet ID.
user	string	The ID of the user this sheet belongs to.
user_login	string	The login of the user this sheet belongs to.
user_name	string	The full name of the user this sheet belongs to.
type	string	The sheet type (eg. 'time', 'expense', or 'mileage').
dates	list of string	A list of dates (YYYYMMDD format) in the sheet. For each entry in this list, there will be one column in each row of the sheet.
state	string	The sheet's state.
status	string	A message describing the sheet's status.
approver	string	The ID of the next user that must approve the sheet.
level	int	The next approval level of the sheet.
reason	string	The reason this sheet was rejected, if any.
total	double	The total (hours, or expense/custom units) for the sheet.
modified_at	string	The date/time the sheet was last modified.
audit_settings	SheetAuditSettings	The sheet's audit settings.
rows	list of SheetRow	One SheetRow structure per project/code combo in the sheet.
punchlists	list of SheetPunchList	One SheetPunchList containing in/out times per date in the sheet.
column_data	string
can_be_submitted	boolean	New in v10 endpoint

SheetAuditSettings

Extra audit-related, server-configurable settings for a user sheet.

Field	Type	Description
requires_new_entries	boolean	True if sheets require new entries to be resubmitted.
has_ever_been_submitted	boolean	True if the sheet has ever been submitted.
requires_correction_recs	boolean	True if the sheet requires correction records instead of modifying existing ones.
audit_level_setting	string	The audit level setting of the sheet.

SheetCell

This type represents a single cell in a sheet, equivalent to one entry cell in the web UI.

Field	Type	Description
amount	double	The total amount (hours, or expense/custom units) in this cell.
reason	string
error	boolean
notes	list of CellNote	Notes for this cell, if any.
attachments	list of string	The encoded IDs of this cell's attachments, if any.

SheetInfo

Metadata for a sheet. Similar to the Sheet type, but doesn't include the sheet rows, attachments, notes, etc.

Field	Type	Description
id	string	The sheet ID.
user	string	The ID of the user this sheet belongs to.
user_login	string	The login of the user this sheet belongs to.
user_name	string	The full name of the user this sheet belongs to.
type	string	The sheet type (eg. 'time', 'expense', or 'mileage').
start_date	string	The start date of the sheet (YYYYMMDD).
end_date	string	The end date of the sheet (YYYYMMDD).
state	string	The sheet's state.
approver	string	The ID of the next user that must approve the sheet.
level	int	The next approval level of the sheet.
reason	string	The reason this sheet was rejected, if any.
total	double	The total (hours, or expense/custom units) for the sheet.

SheetObject

Metadata describing a sheet, in the old format used by certain pre-9.5 methods.

Field	Type	Description
type	string	One of 'time', 'expense', or 'mileage'.
id	string	The SheetObject ID.
user	string	The ID of the sheet's user.
timesheet	string	The ID of the underlying sheet object.
pname	string	The name of the sheet.
state	int	0=open, 1=submitted, 2=approved, 3=rejected
start	string	Starting date of the sheet.
end	string	End date of the sheet.
approver	string	Next approver for the sheet.
level	int	Approval level of the sheet.
domain	string	Domain ID of the sheet, if any.
reason	string	Reason the sheet was rejected, if any.

SheetPunch

This type holds a single pair of in/out punch times.

Field	Type	Description
time_in	string	The in time, in HHMMSS format.
time_out	string	The out time, in HHMMSS format.

SheetPunchList

This type holds in/out times for a single date in a sheet.

Field	Type	Description
punches	list of SheetPunch	Zero or more SheetPunch objects each representing an in/out time pair.

SheetRow

This type represents one row of a sheet. Similar to its appearance in the web UI, a row has a single set of project and code column values, comment, and a cell for each date in the sheet. If the sheet supports in/out times, it will also have a punchlists field containing in/out time lists for each date in the sheet.

Field	Type	Description
project	string	The ID of this row's project.
project_name	string	The displayed name of this row's project.
code0	string	The ID of this row's first code (task, expense code, or reason).
code0_name	string	The displayed name of this row's first code.
code1	string	The ID of this row's second code (pay type, currency, or measurement).
code1_name	string	The displayed name of this row's second code.
code2	string	The ID of this row's third code (bill type, source, or vehicle).
code2_name	string	The displayed name of this row's second code.
comment	string	This row's comment.
cells	list of SheetCell	One SheetCell per date in ths sheet.
punchlists	list of RowPunchList	One RowPunchList per date in the sheet, if the sheet supports in/out times.

SheetSaveResult

Field	Type	Description
sheet	Sheet
success	boolean
status	list of string
errors	list of string
extra_data	list of Item

SheetStatusRecord

Description of a change that has been or is to be made to a sheet's status.

Field	Type	Description
id	string	The ID of the sheet.
change	string	Either 'approve' or 'reject'.
reason	string	The reason for rejecting a sheet, if any.
status	string	A message describing the result of the change request.

SingleSignOnStatus

Describe whether Single Sign On (SSO) is enabled.

Warning: not available in all endpoints

Please note that the availability of this record type or certain fields in it may vary depending on if you access a versioned or unversioned endpoint. The unversioned endpoint typically corresponds to the oldest available versioned endpoint.

This field became available in the 10.0 endpoint.

Field	Type	Description
ssoEnabled	boolean	True if single sign on is enabled and active.
loginURL	string	URL to initiate the sign in process.
ssoType	string	A string describing the type of Single Sign On enabled, if any.

SubcodeRecord

An item in the "pay types" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullSubcode
• addSubcodes
• modifySubcode
• removeSubcode
• getDefaultSubcode
• getSubcode
• getSubcodes
• getAllSubcodes
• getSubcodeById
• countSubcodes

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getSubcodeAttributeTypes

• getSubcodeAttributes

• setSubcodeAttributes This type is searchable. The following related methods are available:

• searchSubcodes

Objects of this type may be members of groups. The following related methods are available:

• addSubcodeToGroup
• removeSubcodeFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableSubcodes
• countLoggableSubcodes

Objects of this type may be hidden. The following related methods are available:

• getHiddenSubcodes
• hideSubcode
• unhideSubcode

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.
require_accrual	int	Does this item require an associated Accrual to be used?

SubsubcodeRecord

An item in the "bill types" column (or its renamed equivalent) of time records.

The following basic CRUD methods are available for this type:

• addFullSubsubcode
• addSubsubcodes
• modifySubsubcode
• removeSubsubcode
• getDefaultSubsubcode
• getSubsubcode
• getSubsubcodes
• getAllSubsubcodes
• getSubsubcodeById
• countSubsubcodes

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getSubsubcodeAttributeTypes

• getSubsubcodeAttributes

• setSubsubcodeAttributes This type is searchable. The following related methods are available:

• searchSubsubcodes

Objects of this type may be members of groups. The following related methods are available:

• addSubsubcodeToGroup
• removeSubsubcodeFromGroup

Objects of this type may be loggable or non-loggable. The following related methods are available:

• getLoggableSubsubcodes
• countLoggableSubsubcodes

Objects of this type may be hidden. The following related methods are available:

• getHiddenSubsubcodes
• hideSubsubcode
• unhideSubsubcode

Field	Type	Description
id	string	The item ID.
description	string	The item description.
reserved0	double	Reserved field; do not use.
autoadd	double	If 1, automatically add this item to all new groups.
reserved1	string	Reserved field; do not use.
loggable	string	If not "0", 0, or null, this item is loggable.
domain	string	The item's domain ID, if any.
pretty_name	string	The item's displayed name.

SuggestionRecord

A suggested time, expense, or custom entry, with associated Suggestion Engine data.

Because a suggestion can have many and varying properties, this object has only a single field, "properties", which contains a list of key/value pairs. In typed endpoints this is a list of "Item" objects (each of which has a "key" and "value" field), while in untyped endpoints it will use the endpoint's dictionary or mapping type.

Some of the properties of interest include:

• id_suggestion: (int) the suggestion ID
• id_user: the ID of the user the suggestion belongs to
• source_category: the source of the suggestion, eg. "generic" or "exchange_rest" Limit of 252 chars. These are either built-in identifiers as above or identifiers produced through custom PS sources.
• source_id: an ID supplied by the source that can be used to find this suggestion later
• record_date/record_date_end: YYYYMMDD date range of the suggestion
• start_timestamp/end_timestamp: Unix seconds-since-epoch date range of the suggestion
• series_id - (int) ID of the series the suggestion is part of, if any
• id_project, id_group, comment: column data
• id_code_task, id_code_pay_type, id_code_bill_type: column data for time records
• id_code_expense, id_code_currency, id_code_expense_source: column data for expense records
• id_travel_reason, id_travel_measurement, id_travel_vehicle: column data for custom records
• time_amount, expense_amount, custom_amount: amount for t/e/c records
• mileage: for expense records
• is_all_day: is it an all day event?
• subtype: subtype within a source, eg. "Event" or "Task"

There are many more potential properties, but these are the ones most likely to be used when using suggestions from the jxAPI.

Field	Type	Description
properties	list of Item	A list of suggestion properties.

SuggestionRefreshResult

Field	Type	Description
num_new_events	int
num_updated_events	int
num_unchanged_events	int
num_actualized_events	int
bad_auth_sources	list of string
num_suggestions	int
num_hidden_events	int
actualized_events	list of SuggestionRecord
suggestions_list	list of SuggestionRecord
hidden_events	list of SuggestionRecord

TimeGUI

Objects of this type may be members of groups. The following related methods are available:

• addTimeGUIToGroup
• removeTimeGUIFromGroup

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• allocated_must_match_punches
• code_time_4_priority
• code_time_4_default
• code_time_5_priority
• code_time_5_default
• code_time_6_priority
• code_time_6_default
• code_time_7_priority
• code_time_7_default
• text2_priority
• text2_default
• text3_priority
• text3_default
• text2_max_chars
• text3_max_chars

Field	Type	Description
id_gui	string
grid	double
sideways	double
arrows	double
totals	string
startstop	double
time_format	double
anchor	string
days_back	string
backwards	double
blankrows	string
show_mileage_entry	double
row_order	double
group_priority	int
group_default	string
project_priority	int
project_default	string
task_priority	int
task_default	string
pay_type_priority	int
pay_type_default	string
bill_type_priority	int
bill_type_default	string
comment_priority	int
comment_default	string
comment_max_chars	int
pre_html	string
post_html	string
last_modified	string
auto_add	double
pname	string
id_domain	string
javascript	int
show_project_desc	int
id_timesheet	string
diary_notes	double
entry_input_type	double
minute_increment	double
max_attachments	int
attachment_rule	int
use_deps_for_hidden	int
use_suggestions	int
use_24_hour	int
show_interim_submit	int
default_vue_screen	string
allocated_must_match_punches	int
code_time_4_priority	int
code_time_4_default	string
code_time_5_priority	int
code_time_5_default	string
code_time_6_priority	int
code_time_6_default	string
code_time_7_priority	int
code_time_7_default	string
text2_priority	int
text2_default	string
text3_priority	int
text3_default	string
text2_max_chars	int
text3_max_chars	int

TimeRecord

An entry in the time record table. Note that there may be more than one record for a single project/code/date combo which will be combined when shown in the web UI, and that amounts may be negative to represent corrections.

The following basic CRUD methods are available for this type:

• addFullTimeRecord
• addTimeRecords
• modifyTimeRecord
• removeTimeRecord
• getDefaultTimeRecord
• getTimeRecord
• getTimeRecords
• getAllTimeRecords
• getTimeRecordById
• countTimeRecords

Automatic name to ID conversion is available for this type, for the following fields:

user, project, code, subcode, subsubcode, time4, time5, time6, time7. Name conversion is performed by the following variant methods:

• addFullTimeRecordWithNames
• addTimeRecordsWithNames
• modifyTimeRecordWithNames
• modifyTimeRecordsWithNames
• getTimeRecordWithNames
• getTimeRecordsWithNames

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 10.0.

• id_assignment

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 11.2.

• id_suggestion

Warning: availability of fields

The following fields are not available in the unversioned endpoint, or in versioned endpoints prior to 12.5.

• id_code_time_4
• id_code_time_5
• id_code_time_6
• id_code_time_7
• text2
• text3

Field	Type	Description
id	string	The record ID.
user	string	The record's user ID (not login).
date	string	The date of the record, in YYYYMMDD format.
code	string	The record's task (or renamed equivalent) ID.
subcode	string	The record's pay type (or renamed equivalent) ID.
project	string	The record's project ID.
hours	double	The amount of hours represented by the record.
comment	string	The comment for this record.
committed	boolean	Reserved; cannot be modified through the jxAPI.
domain	string	The domain ID for this record, if any.
subsubcode	string	The record's bill type (or renamed equivalent) ID.
group	string	The record's group ID.
created_by	string	The ID of the user that created this record.
create_time	double	Creation timestamp, in seconds since epoch.
modified_by	string	The ID of the user that last modified this record.
modify_time	double	Modification timestamp, in seconds since epoch.
id_assignment	string	ID of assignment associated with this record.
id_suggestion	int	ID of suggestion associated with this record.
id_code_time_4	string	Optional Time Entry Field 4
id_code_time_5	string	Optional Time Entry Field 5
id_code_time_6	string	Optional Time Entry Field 6
id_code_time_7	string	Optional Time Entry Field 7
text2	string	Optional Time Entry Text 2
text3	string	Optional Time Entry Text 3

UserDetails

Contains several bits of useful information about a user including full name, login, email, role IDs, ability IDs, custom fields, and full user rec.

Field	Type	Description
userId	string	The user database ID.
userRecord	UserRecord	The full UserRecord (database record) for this user.
fullName	string	The users full (complete) name in the system.
firstName	string	The users first name (only) in the system.
lastName	string	The users last name (only) in the system.
login	string	The users login (aka username).
email	string	The users email address as recorded in the system.
abilities	list of string	The list of ability IDs that this users possesses.
roleIds	list of string	The list of role IDs that this users possesses. (Roles contain abilities.)
attributes	AttributeQueryResult	The custom field values (attributes) for this user.

UserExpenseSheet

Metadata about an expense sheet.

Field	Type	Description
id_sheet	string
id_timesheet	string
id_user	string
pname	string
state	double
start_date	string
end_date	string
id_domain	string
level	int

UserMileageSheet

Metadata about a travel/custom sheet.

Field	Type	Description
id_sheet	string
id_timesheet	string
id_user	string
pname	string
state	double
start_date	string
end_date	string
id_domain	string
level	int

UserRecord

Record representing a Journyx user.

Note that some users may have an ID that is the same as their login name; do not depend on this.

The following basic CRUD methods are available for this type:

• addFullUser
• addUsers
• modifyUser
• removeUser
• getDefaultUser
• getUser
• getUsers
• getAllUsers
• getUserById
• countUsers

This type may have custom fields. In addition to the core attribute methods, the following type specific methods are available:

• getUserAttributeTypes

• getUserAttributes

• setUserAttributes This type is searchable. The following related methods are available:

• searchUsers

Objects of this type may be members of groups. The following related methods are available:

• addUserToGroup
• removeUserFromGroup

Objects of this type may be hidden. The following related methods are available:

• getHiddenUsers
• hideUser
• unhideUser

Automatic name to ID conversion is available for this type, for the following fields:

time_gui, expense_gui, mileage_gui. Name conversion is performed by the following variant methods:

• addFullUserWithNames
• addUsersWithNames
• modifyUserWithNames
• modifyUsersWithNames
• getUserWithNames
• getUsersWithNames
• getHiddenUsersWithNames
• searchUsersWithNames

Field	Type	Description
id	string	The ID of the user (not login name!).
num_input	int	Number of input records.
num_dates	int	Number of dates.
full_name	string	The user's full name.
default_comment	string	The default comment for this user.
expense_gui	string	The ID of this user's expense screen definition.
time_gui	string	The ID of this user's time screen definition.
domain	string	The user's domain ID, if any.
mileage_gui	string	The ID of this user's travel/custom screen definition.
user_login	string	The user's login name.
is_hidden	int	Is the user hidden?

UserRole

The following basic CRUD methods are available for this type:

• addFullUserRole
• addUserRoles
• modifyUserRole
• removeUserRole
• getDefaultUserRole
• getUserRole
• getUserRoles
• getAllUserRoles
• getUserRoleById
• countUserRoles

Field	Type	Description
id_user_role	string
id_user	string
id_role	string
modifier	string
modify_timestamp	double

UserSheetNote

Sheet History records about an entry / time sheet.

"extra_string_2" is actually the relevant user ID, such as who is approving. The note_creator will be System for approval events, or the original user for ordinary sheet notes.

The following basic CRUD methods are available for this type:

• addFullUserSheetNote
• addUserSheetNotes
• modifyUserSheetNote
• removeUserSheetNote
• getDefaultUserSheetNote
• getUserSheetNote
• getUserSheetNotes
• getAllUserSheetNotes
• getUserSheetNoteById
• countUserSheetNotes

This type is searchable. The following related methods are available:

• searchUserSheetNotes

Field	Type	Description
id_usersheetnote	string
id_usersheet	string
note_text	string
note_creator	string
create_timestamp	double
extra_string_1	string
extra_string_2	string
extra_string_3	string
id_domain	string

UserTimeSheet

Metadata about a time sheet.

Field	Type	Description
id_sheet	string
id_timesheet	string
id_user	string
pname	string
state	double
start_date	string
end_date	string
id_domain	string
level	int

VirtualSheetRecord

The following basic CRUD methods are available for this type:

• addFullVirtualSheetRecord
• addVirtualSheetRecords
• modifyVirtualSheetRecord
• removeVirtualSheetRecord
• getDefaultVirtualSheetRecord
• getVirtualSheetRecord
• getVirtualSheetRecords
• getAllVirtualSheetRecords
• getVirtualSheetRecordById
• countVirtualSheetRecords

Field	Type	Description
id_virtual_sheet_record	string
id_virtual_sheet	string
id_record	string
record_type	string

VirtualTimeSheet

The following basic CRUD methods are available for this type:

• addFullVirtualTimeSheet
• addVirtualTimeSheets
• modifyVirtualTimeSheet
• removeVirtualTimeSheet
• getDefaultVirtualTimeSheet
• getVirtualTimeSheet
• getVirtualTimeSheets
• getAllVirtualTimeSheets
• getVirtualTimeSheetById
• countVirtualTimeSheets

Field	Type	Description
id_sheet	string
id_timesheet	string
id_user	string
pname	string
state	double
start_date	string
end_date	string
id_domain	string
id_approver	string
level	int
reserved1	string
id_parent_sheet	string
creator	string
create_timestamp	double