jxAPI Method 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.

addAccessControlLists

addAccessControlLists(session_key: string, records: AccessControlList[]) -> string[]

Add multiple full records to the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addAccrualEvents

addAccrualEvents(session_key: string, records: AccrualEvent[]) -> string[]

Add multiple full records to the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addAccruals

addAccruals(session_key: string, records: Accrual[]) -> string[]

Add multiple full records to the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addAssignments

addAssignments(session_key: string, records: AssignmentRecord[]) -> string[]

Add multiple full records to the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addAttachment

addAttachment(session_key: string, rectype: string, recid: string, filename: string, data: string, note: string, mimetype: string) -> string

Adds an attachment to a time, expense, or mileage record. A single record may have multiple attachments as long as each has a different filename; you may use the same filename for attachments on different records, however.

This method returns a string which encodes the table, record ID, and filename of the attachment, which can be treated as a unique ID for the attachment. It can be used with the getAttachmentByEncodedId and deleteAttachmentByEncodedId methods.

Permission to add attachments is tied to permission to modify the associated time/expense/mileage record.

• @param rectype: One of 'time', 'expense', or 'mileage'.

• @param recid: The time/expense/mileage record ID to add the attachment to.

• @param filename: The filename of the attachment (used to distinguish multiple attachments to the same record)

• @param data: The attachment data, base64 encoded.

• @param note: A note describing the attachment.

• @param mimetype: The MIME type of the attachment, e.g. 'image/jpg' or 'application/pdf'.

• @return: The encoded unique ID of the attachment.

addAttachmentToCell

addAttachmentToCell(session_key: string, sheet_type: string, date: string, row_ids: string[], filename: string, data: string, note: string, mimetype: string) -> string

Adds an attachment to a particular cell of a sheet. This is equivalent to addAttachment, except that you specify where to put the attachment by supplying a sheet type, the record date, and row ID list (the 'combo' - project and codes), and this method decides what actual record to attach to. This can be used in combination with the save_sheet method to handle attachments without needing to know a specific record ID.

• @param sheet_type: 'time', 'expense', or 'mileage'.
• @param date: The date to add the attachment to.
• @param row_ids: A list of IDs identifying the row; also known as the record 'combo'. As of v12.4 this may now include additional columns as follows: (project, code0, code1, code2, comment, code3, code4, code5, code6, text2, text3)
• @param filename: The file name to save in the attachment record.
• @param data: The attachment data in base64.
• @param note: The note to save in the attachment record.
• @param mimetype: The mime type of the attachment.
• @return: The attachment ID.

addAttributeType

addAttributeType(session_key: string, object_type: string, pname: string, data_type: string) -> string

This adds a new attribute type (custom field) with the given name to the current domain. Default values will be supplied (ie, it will default to a regular String attribute.)

• @param object_type: a valid table name as returned by getAttributeObjectTypes()

• @param pname: the display name of the new attribute type.

• @param data_type: this describes what type of data this Attribute Type is allowed to hold, be it a string of characters, a date, or a number. See the general JXAPI Attribute documentation for more information about data-types.

• @return: the ID of the newly created record, if successful.

• @raise RuntimeError: raised if the object_type is not valid.

• @raise TypeError: raised if the data_type parameter is not a valid data-type description for Attribute Types. See the checkAttributeDataType method.

This method requires administrator access.

addAttributeTypeSelectionValue

addAttributeTypeSelectionValue(session_key: string, id_attr_type: string, the_value: string, is_default: boolean) -> string

Adds a selection value to an enumerated attribute type. Attributes with enumerated types are displayed in the user interface as a drop-down list.

Each value is associated internally with a unique ID which will be returned by this method when the value is added successfully. This ID is used by other selection list methods to manipulate individual values.

In untyped endpoints, this method can be used to add any type of value.

In typed endpoints, this method can only add string values. Use addAttributeTypeSelectionValueInteger or addAttributeTypeSelectionValueNumber to add integer or floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param the_value: The value to add to the selection list.

• @param is_default: If true, this value becomes the default selection for the list.

• @return: the ID of the newly added value

• @raise TypeError: if the value is inappropriate for the attribute type

• @raise ValueError: if the attribute type does not exist

This method requires administrator access.

addAttributeTypeSelectionValueInteger

addAttributeTypeSelectionValueInteger(session_key: string, id_attr_type: string, the_value: int, is_default: boolean) -> string

Adds a selection value to an enumerated attribute type. Attributes with enumerated types are displayed in the user interface as a drop-down list.

Each value is associated internally with a unique ID which will be returned by this method when the value is added successfully. This ID is used by other selection list methods to manipulate individual values.

This method is not available in untyped endpoints; use addAttributeTypeSelectionValue instead.

In typed endpoints, this method can only add integer values. Use addAttributeTypeSelectionValue or addAttributeTypeSelectionValueNumber to add string or floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param the_value: The value to add to the selection list.

• @param is_default: If true, this value becomes the default selection for the list.

• @return: the ID of the newly added value

• @raise TypeError: if the value is inappropriate for the attribute type

• @raise ValueError: if the attribute type does not exist

This method is a superset of the addAttributeTypeSelectionValue method, and is subject to its access restrictions.

addAttributeTypeSelectionValueNumber

addAttributeTypeSelectionValueNumber(session_key: string, id_attr_type: string, the_value: double, is_default: boolean) -> string

Adds a selection value to an enumerated attribute type. Attributes with enumerated types are displayed in the user interface as a drop-down list.

Each value is associated internally with a unique ID which will be returned by this method when the value is added successfully. This ID is used by other selection list methods to manipulate individual values.

This method is not available in untyped endpoints; use addAttributeTypeSelectionValue instead.

In typed endpoints, this method can only add floating point values. Use addAttributeTypeSelectionValue or addAttributeTypeSelectionValueInteger to add string or integer values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param the_value: The value to add to the selection list.

• @param is_default: If true, this value becomes the default selection for the list.

• @return: the ID of the newly added value

• @raise TypeError: if the value is inappropriate for the attribute type

• @raise ValueError: if the attribute type does not exist

This method is a superset of the addAttributeTypeSelectionValue method, and is subject to its access restrictions.

addCodes

addCodes(session_key: string, records: CodeRecord[]) -> string[]

Add multiple full records to the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesCustom4s

addCodesCustom4s(session_key: string, records: CodesCustom4Record[]) -> string[]

Add multiple full records to the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesCustom4ToGroup

addCodesCustom4ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_custom_4 (CodesCustom4) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesCustom5s

addCodesCustom5s(session_key: string, records: CodesCustom5Record[]) -> string[]

Add multiple full records to the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesCustom5ToGroup

addCodesCustom5ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_custom_5 (CodesCustom5) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesCustom6s

addCodesCustom6s(session_key: string, records: CodesCustom6Record[]) -> string[]

Add multiple full records to the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesCustom6ToGroup

addCodesCustom6ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_custom_6 (CodesCustom6) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesCustom7s

addCodesCustom7s(session_key: string, records: CodesCustom7Record[]) -> string[]

Add multiple full records to the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesCustom7ToGroup

addCodesCustom7ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_custom_7 (CodesCustom7) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesExpense4s

addCodesExpense4s(session_key: string, records: CodesExpense4Record[]) -> string[]

Add multiple full records to the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesExpense4ToGroup

addCodesExpense4ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expense_4 (CodesExpense4) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesExpense5s

addCodesExpense5s(session_key: string, records: CodesExpense5Record[]) -> string[]

Add multiple full records to the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesExpense5ToGroup

addCodesExpense5ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expense_5 (CodesExpense5) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesExpense6s

addCodesExpense6s(session_key: string, records: CodesExpense6Record[]) -> string[]

Add multiple full records to the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesExpense6ToGroup

addCodesExpense6ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expense_6 (CodesExpense6) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesExpense7s

addCodesExpense7s(session_key: string, records: CodesExpense7Record[]) -> string[]

Add multiple full records to the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesExpense7ToGroup

addCodesExpense7ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expense_7 (CodesExpense7) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesTime4s

addCodesTime4s(session_key: string, records: CodesTime4Record[]) -> string[]

Add multiple full records to the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesTime4ToGroup

addCodesTime4ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_time_4 (CodesTime4) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesTime5s

addCodesTime5s(session_key: string, records: CodesTime5Record[]) -> string[]

Add multiple full records to the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesTime5ToGroup

addCodesTime5ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_time_5 (CodesTime5) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesTime6s

addCodesTime6s(session_key: string, records: CodesTime6Record[]) -> string[]

Add multiple full records to the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesTime6ToGroup

addCodesTime6ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_time_6 (CodesTime6) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodesTime7s

addCodesTime7s(session_key: string, records: CodesTime7Record[]) -> string[]

Add multiple full records to the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addCodesTime7ToGroup

addCodesTime7ToGroup(session_key: string, id: string, group: string) -> int

Add a codes_time_7 (CodesTime7) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addCodeToGroup

addCodeToGroup(session_key: string, id: string, group: string) -> int

Add a codes_tasks (Code) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addColumnDependency

addColumnDependency(session_key: string, parent_table: string, parent_id: string, child_table: string, child_id: string) -> int

Add a column dependency.

This method adds dependencies between code columns. It returns 1 if a dependency was added, and 0 if it already existed.

• @param parent_table: The name or printable name of the parent table.

• @param parent_id: The ID or printable name of the parent item.

• @param child_table: The name or printable name of the child table.

• @param child_id: The ID or printable name of the child item.

• @return: 0 if the dependency already existed, 1 if it was added.

This method requires administrator access.

addCurrencyConversions

addCurrencyConversions(session_key: string, records: CurrencyConversion[]) -> string[]

Add multiple full records to the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addEntryNoteToCell

addEntryNoteToCell(session_key: string, user: string, sheet_type: string, date: string, row_ids: string[], text: string) -> int

Adds an entry note to a particular sheet cell, specified by date and row data. Similar to addAttachmentToCell.

• @param user: The user ID, or the empty string for the current user.
• @param sheet_type: The sheet type ('time','expense',or 'mileage').
• @param date: The date in YYYYMMDD format.
• @param row_ids: A list of (project, code0, code1, code2, comment) IDs.
• @param text: The note text to add.
• @return: 1.

addExpenseCodes

addExpenseCodes(session_key: string, records: ExpenseCodeRecord[]) -> string[]

Add multiple full records to the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addExpenseCodeToGroup

addExpenseCodeToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expenses (ExpenseCode) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addExpenseCurrencys

addExpenseCurrencys(session_key: string, records: ExpenseCurrencyRecord[]) -> string[]

Add multiple full records to the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addExpenseCurrencyToGroup

addExpenseCurrencyToGroup(session_key: string, id: string, group: string) -> int

Add a codes_currencies (ExpenseCurrency) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addExpenseRecords

addExpenseRecords(session_key: string, records: ExpenseRecord[]) -> string[]

Add multiple full records to the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addExpenseRecordsWithNames

addExpenseRecordsWithNames(session_key: string, records: ExpenseRecord[]) -> string[]

Add multiple full records to the expense_recs (ExpenseRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addExpenseSources

addExpenseSources(session_key: string, records: ExpenseSourceRecord[]) -> string[]

Add multiple full records to the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addExpenseSourceToGroup

addExpenseSourceToGroup(session_key: string, id: string, group: string) -> int

Add a codes_expense_sources (ExpenseSource) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addFullAccessControlList

addFullAccessControlList(session_key: string, record: AccessControlList) -> string

Add a full record to the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullAccrual

addFullAccrual(session_key: string, record: Accrual) -> string

Add a full record to the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullAccrualEvent

addFullAccrualEvent(session_key: string, record: AccrualEvent) -> string

Add a full record to the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullAssignment

addFullAssignment(session_key: string, record: AssignmentRecord) -> string

Add a full record to the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullAttributeType

addFullAttributeType(session_key: string, new_record: AttributeTypeRecord) -> string

Simply adds a new Attribute Type record to the system.

• @param new_record: A new Attribute Type record. See the description elsewhere of that record type.

• @return: the ID of the newly added record (if successful.)

• @raise Exception: An exception will be raised if any required fields are missing.

This method requires administrator access.

addFullCode

addFullCode(session_key: string, record: CodeRecord) -> string

Add a full record to the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesCustom4

addFullCodesCustom4(session_key: string, record: CodesCustom4Record) -> string

Add a full record to the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesCustom5

addFullCodesCustom5(session_key: string, record: CodesCustom5Record) -> string

Add a full record to the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesCustom6

addFullCodesCustom6(session_key: string, record: CodesCustom6Record) -> string

Add a full record to the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesCustom7

addFullCodesCustom7(session_key: string, record: CodesCustom7Record) -> string

Add a full record to the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesExpense4

addFullCodesExpense4(session_key: string, record: CodesExpense4Record) -> string

Add a full record to the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesExpense5

addFullCodesExpense5(session_key: string, record: CodesExpense5Record) -> string

Add a full record to the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesExpense6

addFullCodesExpense6(session_key: string, record: CodesExpense6Record) -> string

Add a full record to the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesExpense7

addFullCodesExpense7(session_key: string, record: CodesExpense7Record) -> string

Add a full record to the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesTime4

addFullCodesTime4(session_key: string, record: CodesTime4Record) -> string

Add a full record to the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesTime5

addFullCodesTime5(session_key: string, record: CodesTime5Record) -> string

Add a full record to the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesTime6

addFullCodesTime6(session_key: string, record: CodesTime6Record) -> string

Add a full record to the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCodesTime7

addFullCodesTime7(session_key: string, record: CodesTime7Record) -> string

Add a full record to the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullCurrencyConversion

addFullCurrencyConversion(session_key: string, record: CurrencyConversion) -> string

Add a full record to the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullExpenseCode

addFullExpenseCode(session_key: string, record: ExpenseCodeRecord) -> string

Add a full record to the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullExpenseCurrency

addFullExpenseCurrency(session_key: string, record: ExpenseCurrencyRecord) -> string

Add a full record to the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullExpenseRecord

addFullExpenseRecord(session_key: string, record: ExpenseRecord) -> string

Add a full record to the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullExpenseRecordWithNames

addFullExpenseRecordWithNames(session_key: string, record: ExpenseRecord) -> string

Add a full record to the expense_recs (ExpenseRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullExpenseSource

addFullExpenseSource(session_key: string, record: ExpenseSourceRecord) -> string

Add a full record to the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullGroup

addFullGroup(session_key: string, record: GroupRecord) -> string

Add a full record to the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullMileageMeasurement

addFullMileageMeasurement(session_key: string, record: MileageMeasurementRecord) -> string

Add a full record to the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullMileageReason

addFullMileageReason(session_key: string, record: MileageReasonRecord) -> string

Add a full record to the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullMileageRecord

addFullMileageRecord(session_key: string, record: MileageRecord) -> string

Add a full record to the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullMileageRecordWithNames

addFullMileageRecordWithNames(session_key: string, record: MileageRecord) -> string

Add a full record to the travel_recs (MileageRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullMileageVehicle

addFullMileageVehicle(session_key: string, record: MileageVehicleRecord) -> string

Add a full record to the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProject

addFullProject(session_key: string, record: ProjectRecord) -> string

Add a full record to the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectApproval

addFullProjectApproval(session_key: string, record: ProjectApproval) -> string

Add a full record to the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectApprovalSetting

addFullProjectApprovalSetting(session_key: string, record: ProjectApprovalSetting) -> string

Add a full record to the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectApprover

addFullProjectApprover(session_key: string, record: ProjectApprover) -> string

Add a full record to the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectCodeRate

addFullProjectCodeRate(session_key: string, record: ProjectCodeRate) -> string

Add a full record to the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectPickerItem

addFullProjectPickerItem(session_key: string, record: ProjectPickerItem) -> string

Add a full record to the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullProjectWithNames

addFullProjectWithNames(session_key: string, record: ProjectRecord) -> string

Add a full record to the projects (Project) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPS_DV_Assignments

addFullPS_DV_Assignments(session_key: string, record: PS_DV_Assignments) -> string

Add a full record to the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPS_DV_Rules

addFullPS_DV_Rules(session_key: string, record: PS_DV_Rules) -> string

Add a full record to the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPSAccrualOverride

addFullPSAccrualOverride(session_key: string, record: PSAccrualOverride) -> string

Add a full record to the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPSAccrualTierManager

addFullPSAccrualTierManager(session_key: string, record: PSAccrualTierManager) -> string

Add a full record to the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPSCompensationTierManager

addFullPSCompensationTierManager(session_key: string, record: PSCompensationTierManager) -> string

Add a full record to the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPunchRecord

addFullPunchRecord(session_key: string, record: PunchRecord) -> string

Add a full record to the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullPXTeam

addFullPXTeam(session_key: string, record: PXTeamRecord) -> string

Add a full record to the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullRateCode

addFullRateCode(session_key: string, record: RateCodeRecord) -> string

Add a full record to the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullRecord

addFullRecord(session_key: string, tablename: string, record: Record, withNames: boolean) -> string

Adds a record to the Journyx database.

• @param tablename: The name of the table to add a record to.
• @param record: The record to add.
• @param withNames: If true, perform name/ID conversion if available for this type.
• @param multiple: If true, add multiple records (untyped endpoints only).
• @return: The ID of the newly added record.

This method adds a record or records to a table in the Journyx database. All tables with corresponding jxAPI record types are supported. For untyped endpoints only, you may add multiple records in one call by setting the multiple parameter to True and passing a list of records instead of a single one.

For some types, name to ID conversion is available. If the withNames parameter is True, certain foreign key fields may contain a pretty name instead of an ID, and the proper ID will be looked up on the server side before adding the record. Consult the type reference to find out which types support name conversion, and on which fields.

The ID field of the record passed in should usually be empty; a new ID will be assigned and returned from this method. When adding multiple records, the return will be a list of IDs instead of a single one.

addFullRecords

addFullRecords(session_key: string, tablename: string, records: Record[], withNames: boolean) -> string[]

Adds multiple records to a table in the Journyx database.

• @param tablename: The name of the table to add records to.
• @param records: A list of records to add.
• @param withNames: If true, perform name/ID conversion if available for this type.
• @return: A list of the IDs of the newly added records.

This method is exactly like addFullRecord except that it takes a list of records to add, and returns a list of their new IDs. While addFullRecord can do this in untyped endpoints, this method is provided to allow the same functionality in typed endpoints.

addFullRequestRecord

addFullRequestRecord(session_key: string, record: RequestRecord) -> string

Add a full record to the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullSubcode

addFullSubcode(session_key: string, record: SubcodeRecord) -> string

Add a full record to the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullSubsubcode

addFullSubsubcode(session_key: string, record: SubsubcodeRecord) -> string

Add a full record to the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullTimeRecord

addFullTimeRecord(session_key: string, record: TimeRecord) -> string

Add a full record to the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullTimeRecordWithNames

addFullTimeRecordWithNames(session_key: string, record: TimeRecord) -> string

Add a full record to the time_recs (TimeRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullUser

addFullUser(session_key: string, record: UserRecord) -> string

Add a full record to the users (User) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullUserRole

addFullUserRole(session_key: string, record: UserRole) -> string

Add a full record to the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullUserSheetNote

addFullUserSheetNote(session_key: string, record: UserSheetNote) -> string

Add a full record to the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullUserWithNames

addFullUserWithNames(session_key: string, record: UserRecord) -> string

Add a full record to the users (User) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullVirtualSheetRecord

addFullVirtualSheetRecord(session_key: string, record: VirtualSheetRecord) -> string

Add a full record to the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addFullVirtualTimeSheet

addFullVirtualTimeSheet(session_key: string, record: VirtualTimeSheet) -> string

Add a full record to the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addGroups

addGroups(session_key: string, records: GroupRecord[]) -> string[]

Add multiple full records to the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageMeasurements

addMileageMeasurements(session_key: string, records: MileageMeasurementRecord[]) -> string[]

Add multiple full records to the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageMeasurementToGroup

addMileageMeasurementToGroup(session_key: string, id: string, group: string) -> int

Add a codes_travel_measurements (MileageMeasurement) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addMileageReasons

addMileageReasons(session_key: string, records: MileageReasonRecord[]) -> string[]

Add multiple full records to the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageReasonToGroup

addMileageReasonToGroup(session_key: string, id: string, group: string) -> int

Add a codes_travel_reasons (MileageReason) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addMileageRecords

addMileageRecords(session_key: string, records: MileageRecord[]) -> string[]

Add multiple full records to the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageRecordsWithNames

addMileageRecordsWithNames(session_key: string, records: MileageRecord[]) -> string[]

Add multiple full records to the travel_recs (MileageRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageVehicles

addMileageVehicles(session_key: string, records: MileageVehicleRecord[]) -> string[]

Add multiple full records to the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addMileageVehicleToGroup

addMileageVehicleToGroup(session_key: string, id: string, group: string) -> int

Add a codes_travel_vehicles (MileageVehicle) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addObjectToGroup

addObjectToGroup(session_key: string, group_id_name: string, object_class: string, object_id_name: string) -> int

Adds an object of any supported type to a group.

An exception will be raised if the group or object ID or name cannot be mapped to a single unique group or object. For example, if you try to add an object to the group "Test" and there is more than one group with that name, an exception will be raised. In this case, you should use the ID instead.

An exception will be raised if the object_class parameter does not name one of the supported classes. Use getGroupObjectClasses to obtain a list of acceptable values.

• @param group_id_name: The ID or pretty name of the group.
• @param object_class: The name of the class of object to add to the group.
• @param object_id_name: The ID or pretty name of the object to add to the group.
• @return: zero if the object was successfully added to the group

This method requires any one of the following abilities: "admin", "msp_admin"

addProjectApprovals

addProjectApprovals(session_key: string, records: ProjectApproval[]) -> string[]

Add multiple full records to the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectApprovalSettings

addProjectApprovalSettings(session_key: string, records: ProjectApprovalSetting[]) -> string[]

Add multiple full records to the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectApprover

addProjectApprover(session_key: string, project_id: string, approver_id: string, level: double) -> string

Add an approver to a project.

• @param project_id: The project ID.
• @param approver_id: The ID of the approver's user record.
• @param level: The level to insert this approver at.
• @return: The ID of the new ProjectApproval object.

addProjectApprovers

addProjectApprovers(session_key: string, records: ProjectApprover[]) -> string[]

Add multiple full records to the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectBackupApprover

addProjectBackupApprover(session_key: string, project_id: string, approver_id: string, level: double) -> string

Add a backup approver to a project.

• @param project_id: The project ID.
• @param approver_id: The ID of the approver's user record.
• @param level: The level to insert this approver at.
• @return: The ID of the new ProjectApproval object.

addProjectCodeRates

addProjectCodeRates(session_key: string, records: ProjectCodeRate[]) -> string[]

Add multiple full records to the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectDependency

addProjectDependency(session_key: string, project_id: string, code_type: string, code_id: string) -> string

• @param project_id: The ID of the project.

• @param code_type: The code type of the new dependency.

• @param code_id: The ID of the dependent code.

• @return: A string which may be ignored.

• @raise ValueError: If the project ID, code ID, or code type is not found.

Adds the given code ID to a project's dependencies.

NOTE: You must have one of the following role abilities to perform this action:

• 'Authority - Administrator'
• 'Project - Add'
• 'Project - Modify'
• 'Project - Delete'

addProjectPickerItems

addProjectPickerItems(session_key: string, records: ProjectPickerItem[]) -> string[]

Add multiple full records to the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjects

addProjects(session_key: string, records: ProjectRecord[]) -> string[]

Add multiple full records to the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectsWithNames

addProjectsWithNames(session_key: string, records: ProjectRecord[]) -> string[]

Add multiple full records to the projects (Project) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addProjectToGroup

addProjectToGroup(session_key: string, id: string, group: string) -> int

Add a projects (Project) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addPS_DV_Assignmentss

addPS_DV_Assignmentss(session_key: string, records: PS_DV_Assignments[]) -> string[]

Add multiple full records to the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPS_DV_Ruless

addPS_DV_Ruless(session_key: string, records: PS_DV_Rules[]) -> string[]

Add multiple full records to the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPSAccrualOverrides

addPSAccrualOverrides(session_key: string, records: PSAccrualOverride[]) -> string[]

Add multiple full records to the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPSAccrualTierManagers

addPSAccrualTierManagers(session_key: string, records: PSAccrualTierManager[]) -> string[]

Add multiple full records to the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPSCompensationTierManagers

addPSCompensationTierManagers(session_key: string, records: PSCompensationTierManager[]) -> string[]

Add multiple full records to the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPunchRecords

addPunchRecords(session_key: string, records: PunchRecord[]) -> string[]

Add multiple full records to the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPXTeams

addPXTeams(session_key: string, records: PXTeamRecord[]) -> string[]

Add multiple full records to the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addPXTeamToGroup

addPXTeamToGroup(session_key: string, id: string, group: string) -> int

Add a px_teams (PXTeam) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addRateCodes

addRateCodes(session_key: string, records: RateCodeRecord[]) -> string[]

Add multiple full records to the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addRequestRecords

addRequestRecords(session_key: string, records: RequestRecord[]) -> string[]

Add multiple full records to the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addSubcodes

addSubcodes(session_key: string, records: SubcodeRecord[]) -> string[]

Add multiple full records to the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addSubcodeToGroup

addSubcodeToGroup(session_key: string, id: string, group: string) -> int

Add a codes_pay_types (Subcode) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addSubsubcodes

addSubsubcodes(session_key: string, records: SubsubcodeRecord[]) -> string[]

Add multiple full records to the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addSubsubcodeToGroup

addSubsubcodeToGroup(session_key: string, id: string, group: string) -> int

Add a codes_bill_types (Subsubcode) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addTimeRecords

addTimeRecords(session_key: string, records: TimeRecord[]) -> string[]

Add multiple full records to the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addTimeRecordsWithNames

addTimeRecordsWithNames(session_key: string, records: TimeRecord[]) -> string[]

Add multiple full records to the time_recs (TimeRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addUserRoles

addUserRoles(session_key: string, records: UserRole[]) -> string[]

Add multiple full records to the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addUsers

addUsers(session_key: string, records: UserRecord[]) -> string[]

Add multiple full records to the users (User) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addUserSheetNotes

addUserSheetNotes(session_key: string, records: UserSheetNote[]) -> string[]

Add multiple full records to the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addUsersWithNames

addUsersWithNames(session_key: string, records: UserRecord[]) -> string[]

Add multiple full records to the users (User) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addUserToGroup

addUserToGroup(session_key: string, id: string, group: string) -> int

Add a users (User) record to a group.

See coredb for more information about this method.

This method is a superset of the addObjectToGroup method, and is subject to its access restrictions.

addVirtualSheetRecords

addVirtualSheetRecords(session_key: string, records: VirtualSheetRecord[]) -> string[]

Add multiple full records to the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

addVirtualTimeSheets

addVirtualTimeSheets(session_key: string, records: VirtualTimeSheet[]) -> string[]

Add multiple full records to the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the addFullRecord method, and is subject to its access restrictions.

adminEmail

adminEmail(session_key: string) -> string

Returns the name and contact information of the server administrator.

This method may be called by any logged-in user.

adminName

adminName(session_key: string) -> string

Returns the name and contact information of the server administrator.

This method may be called by any logged-in user.

adminTelephone

adminTelephone(session_key: string) -> string

Returns the name and contact information of the server administrator.

This method may be called by any logged-in user.

apiFeatures

apiFeatures() -> string[]

• @return: A list of string tags for the available jxAPI features.

Returns the features currently available in the jxAPI. A feature is a grouping of methods and tables that provide a set of logical functionality. For example, the 'tables' feature includes the standard access methods for database tables.

Note that features are not just dependent on what the server can do, but also upon the API version, endpoint, etc.

This method does not require a login session, and may be called by any client.

apiVersion

apiVersion() -> int[]

• @return: An array of 4 integers.

Returns the jxAPI version supported by the current endpoint, which may be distinct from the Timesheet server version and/or any other endpoints that may be available.

This method does not require a login session, and may be called by any client.

approveProject

approveProject(session_key: string, sheet_id: string, project_id: string) -> int

Approve a project that is pending approval.

• @param sheet_id: The sheet ID to approve the project in.
• @param project_id: The project ID to approve.
• @return: A meaningless value.

AssignApprovalPlan

AssignApprovalPlan(session_key: string, id: string, uids: string[]) -> int

• @param id: The plan ID to assign.

• @param uids: A list of user IDs to assign the plan to.

• @return: 0

Assigns an Approval Plan to one more users. An exception will be raised if either the Plan ID/Name cannot be found, or if one of the users does not exist, or if the caller does not have the authority to do this. Returns a zero (0) if the assignment was successful.

Note that the first parameter can be either the unique ID of the Approval Plan, or it can be the Name as it appears on the Plan Modification screens. The Unique ID changes every time the administrator modifies the Plan, because the record is deleted and re-added, and so it is often convenient to assign Plans based on their name.

Also note that Plans for Time, Expense, and Mileage can all be used with this function. But since each of these types of Plans may have the same name, if you specify an ambiguous name they will be 'resolved' in the order of Time, then Expense, then Mileage. If other words, if you have both Time and Expense Plans named 'My Plan', and call this function as AssignApprovalPlan('My Plan', ['user1', 'user2']), then only the Time Plan will get assigned to the users, not the Expense Plan.

This method requires administrator access.

assignApprovalPlan

assignApprovalPlan(session_key: string, id: string, uids: string[]) -> int

• @param id: The plan ID to assign.

• @param uids: A list of user IDs to assign the plan to.

• @return: 0

Assigns an Approval Plan to one more users. An exception will be raised if either the Plan ID/Name cannot be found, or if one of the users does not exist, or if the caller does not have the authority to do this. Returns a zero (0) if the assignment was successful.

Note that the first parameter can be either the unique ID of the Approval Plan, or it can be the Name as it appears on the Plan Modification screens. The Unique ID changes every time the administrator modifies the Plan, because the record is deleted and re-added, and so it is often convenient to assign Plans based on their name.

Also note that Plans for Time, Expense, and Mileage can all be used with this function. But since each of these types of Plans may have the same name, if you specify an ambiguous name they will be 'resolved' in the order of Time, then Expense, then Mileage. If other words, if you have both Time and Expense Plans named 'My Plan', and call this function as AssignApprovalPlan('My Plan', ['user1', 'user2']), then only the Time Plan will get assigned to the users, not the Expense Plan.

This method requires administrator access.

assignPeriodToUsers

assignPeriodToUsers(session_key: string, period_id: string, period_type: string, users: string[], remove_old: boolean) -> string[]

Assigns a time period (which must exist) to one or more users.

• @param period_id: The period ID. ('default_weekly' is one that exists by default)

• @param period_type: One of 'time', 'expense', or 'mileage'.

• @param users: A list of user IDs to assign the period to.

• @param remove_old: If true, remove ALL the user's old time information including ALL time records and sheets.

• @return: A list of strings. The first one is a status message, and any additional ones are errors or warnings.

This method requires administrator access.

assignPeriodToUsersByName

assignPeriodToUsersByName(session_key: string, period_name: string, period_type: string, users: string[], remove_old: boolean) -> string[]

Assigns a time period (which must exist) to one or more users, using the pretty name of the period.

• @param period_name: The period name. ('weekly' is one that exists by default)

• @param period_type: One of 'time', 'expense', or 'mileage'.

• @param users: A list of user IDs to assign the period to.

• @param remove_old: If true, remove ALL the user's old time information including ALL time records and sheets.

• @return: A list of strings. The first one is a status message, and any additional ones are errors or warnings.

This method requires administrator access.

assignRoleToUser

assignRoleToUser(session_key: string, name: string, role: string) -> int

• @param name: The ID of the user.

• @param role: The role to assign to the user.

• @return: 0

• @raise ValueError: If the user or role is not found, or the role name is ambiguous.

Assigns a role to a user, which must be specified by its ID (not login). The role may be specified by the role ID or its display name, provided that the name can be unambiguously matched with a single role ID.

This method requires administrator access.

assignRuleSetToUser

assignRuleSetToUser(session_key: string, userid: string, rulesetname: string) -> string

• @param rulesetname: The name of the policy to assign.
• @param userid: The ID of the user to assign the policy to.

Assigns a policy to a user. To remove any existing policy from the user, pass an empty string as the policy name.

This method requires administrator access.

availableImporters

availableImporters(session_key: string) -> string[]

Get the names of available importers.

This method returns a list of the names of available importers, suitable for use with importFile. Note that the list includes all importers installed on the server, whether or not the calling user can actually run them.

This method may be called by any logged-in user.

changePassword

changePassword(session_key: string, newpw: string) -> int

• @param newpw: The new password.

• @return: 0

Changes the password of the currently logged in user. An exception may be raised if the new password does not meet the validity requirements imposed by the server.

This method may be called by any logged-in user.

changePasswordForUser

changePasswordForUser(session_key: string, user: string, newpw: string) -> int

• @param user: The ID of the user.

• @param newpw: The new password to assign.

• @return: 0

Changes the password of any existing user; only administrators may change the password for any user other than themself. An exception may be raised if the new password does not meet the validity requirements imposed by the server, or if a non-administrator attempts to change someone else's password.

changeProjectApprovalBackupLevels

changeProjectApprovalBackupLevels(session_key: string, project_id: string, recids: string[], newlevels: double[]) -> int

Change the levels of one or more project backup approval records.

• @param project_id: The project ID.
• @param recids: The IDs of the ProjectApproval objects to modify.
• @param newlevels: The levels to set each ProjectApproval object to.
• @return: A meaningless value.

changeProjectApprovalLevels

changeProjectApprovalLevels(session_key: string, project_id: string, recids: string[], newlevels: double[]) -> int

Change the levels of one or more project approval records.

• @param project_id: The project ID.
• @param recids: The IDs of the ProjectApproval objects to modify.
• @param newlevels: The levels to set each ProjectApproval object to.
• @return: A meaningless value.

ChangeSheetStatus

ChangeSheetStatus(session_key: string, sheet_records: SheetStatusRecord[]) -> SheetStatusRecord[]

Change the approval status of one more more sheets.

This method is deprecated. While it is still fully functional, we recommend that you use the new sheet workflow around :py:func:save_sheet to do approvals instead if possible.

• @param sheet_records: A list of SheetStatusRecord objects describing the requested changes.

• @return: A list of SheetStatusRecord objects describing the changes that were made.

A fault will occur if you are not authorized to change the sheet's approval status.

This method may be called by any logged-in user.

changeUserPassword

changeUserPassword(username: string, curpwd: string, newpwd: string) -> int

• @param username: The login ID of the user to change the password for.

• @param curpwd: The user's current password.

• @param newpwd: The new password to assign to the user.

• @return: 0

• @raise RuntimeError: If the current password provided is not correct, or the new password is not allowed by the server.

Changes the password for an existing user without first logging in. This method can be used to change a password that is expired and thus does not not permit logins; even if expired the current password is validated first, however.

This method does not require a login session, and may be called by any client.

checkAttributeDataType

checkAttributeDataType(session_key: string, data_type: string) -> int

Use this method to determine if a particular string is a valid data-type for AttributeType records. (Here, data-type is a synonym for the attr_type field of AttributeType records.)

• @param data_type: the string that you wish to check.

• @return: This method returns the integer 1 if the given string IS a valid data-type for AttributeType records.

• @raise TypeError: If it is not a valid data-type.

This method may be called by any logged-in user.

checkAttributeValue

checkAttributeValue(session_key: string, data_type: string, value: string) -> int

Checks a value for conformance to an attribute type.

In untyped endpoints, this method can be used to check values of any type.

In typed endpoints, this method can only be used to check string values. Use checkAttributeValueInteger or checkAttributeValueNumber to check integer and floating point values, respectively.

• @param data_type: The attribute data type, or the ID of an attribute type.

• @param value: The value to check.

• @return: 1 if the value is appropriate for the specified attribute type or attribute data type

This method may be called by any logged-in user.

checkAttributeValueInteger

checkAttributeValueInteger(session_key: string, data_type: string, value: int) -> int

Checks an integer value for conformance to an attribute type.

This method does not exist in untyped endpoints; use checkAttributeValue instead.

In typed endpoints, this method can only be used to check integer values. Use checkAttributeValue or checkAttributeValueNumber to check string and floating point values, respectively.

• @param data_type: The attribute data type, or the ID of an attribute type.

• @param value: The value to check.

• @return: 1 if the value is appropriate for the specified attribute type or attribute data type

This method is a superset of the checkAttributeValue method, and is subject to its access restrictions.

checkAttributeValueNumber

checkAttributeValueNumber(session_key: string, data_type: string, value: double) -> int

Checks a floating point value for conformance to an attribute type.

This method does not exist in untyped endpoints; use checkAttributeValue instead.

In typed endpoints, this method can only be used to check floating point values. Use checkAttributeValue or checkAttributeValueInteger to check string and integer values, respectively.

• @param data_type: The attribute data type, or the ID of an attribute type.

• @param value: The value to check.

• @return: 1 if the value is appropriate for the specified attribute type or attribute data type

This method is a superset of the checkAttributeValue method, and is subject to its access restrictions.

clientLogin

clientLogin(username: string, pwd: string, user_agent: string, keep_old_sessions: int) -> string

Creates a new session, exactly like login but allowing a client application to pass a user-agent parameter for logging purposes.

This method does not require a login session, and may be called by any client.

companyName

companyName(session_key: string) -> string

Returns the company name specified in the server license.

This method may be called by any logged-in user.

countAccessControlLists

countAccessControlLists(session_key: string) -> int

Count visible records in the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countAccrualEvents

countAccrualEvents(session_key: string) -> int

Count visible records in the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countAccruals

countAccruals(session_key: string) -> int

Count visible records in the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countAssignments

countAssignments(session_key: string) -> int

Count visible records in the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodes

countCodes(session_key: string) -> int

Count visible records in the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesCustom4s

countCodesCustom4s(session_key: string) -> int

Count visible records in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesCustom5s

countCodesCustom5s(session_key: string) -> int

Count visible records in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesCustom6s

countCodesCustom6s(session_key: string) -> int

Count visible records in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesCustom7s

countCodesCustom7s(session_key: string) -> int

Count visible records in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesExpense4s

countCodesExpense4s(session_key: string) -> int

Count visible records in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesExpense5s

countCodesExpense5s(session_key: string) -> int

Count visible records in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesExpense6s

countCodesExpense6s(session_key: string) -> int

Count visible records in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesExpense7s

countCodesExpense7s(session_key: string) -> int

Count visible records in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesTime4s

countCodesTime4s(session_key: string) -> int

Count visible records in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesTime5s

countCodesTime5s(session_key: string) -> int

Count visible records in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesTime6s

countCodesTime6s(session_key: string) -> int

Count visible records in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCodesTime7s

countCodesTime7s(session_key: string) -> int

Count visible records in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countCurrencyConversions

countCurrencyConversions(session_key: string) -> int

Count visible records in the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countExpenseCodes

countExpenseCodes(session_key: string) -> int

Count visible records in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countExpenseCurrencys

countExpenseCurrencys(session_key: string) -> int

Count visible records in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countExpenseRecords

countExpenseRecords(session_key: string) -> int

Count visible records in the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countExpenseSources

countExpenseSources(session_key: string) -> int

Count visible records in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countGroups

countGroups(session_key: string) -> int

Count visible records in the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodes

countLoggableCodes(session_key: string) -> int

Count loggable records in the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesCustom4s

countLoggableCodesCustom4s(session_key: string) -> int

Count loggable records in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesCustom5s

countLoggableCodesCustom5s(session_key: string) -> int

Count loggable records in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesCustom6s

countLoggableCodesCustom6s(session_key: string) -> int

Count loggable records in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesCustom7s

countLoggableCodesCustom7s(session_key: string) -> int

Count loggable records in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesExpense4s

countLoggableCodesExpense4s(session_key: string) -> int

Count loggable records in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesExpense5s

countLoggableCodesExpense5s(session_key: string) -> int

Count loggable records in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesExpense6s

countLoggableCodesExpense6s(session_key: string) -> int

Count loggable records in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesExpense7s

countLoggableCodesExpense7s(session_key: string) -> int

Count loggable records in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesTime4s

countLoggableCodesTime4s(session_key: string) -> int

Count loggable records in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesTime5s

countLoggableCodesTime5s(session_key: string) -> int

Count loggable records in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesTime6s

countLoggableCodesTime6s(session_key: string) -> int

Count loggable records in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableCodesTime7s

countLoggableCodesTime7s(session_key: string) -> int

Count loggable records in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableExpenseCodes

countLoggableExpenseCodes(session_key: string) -> int

Count loggable records in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableExpenseCurrencys

countLoggableExpenseCurrencys(session_key: string) -> int

Count loggable records in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableExpenseSources

countLoggableExpenseSources(session_key: string) -> int

Count loggable records in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableMileageMeasurements

countLoggableMileageMeasurements(session_key: string) -> int

Count loggable records in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableMileageReasons

countLoggableMileageReasons(session_key: string) -> int

Count loggable records in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableMileageVehicles

countLoggableMileageVehicles(session_key: string) -> int

Count loggable records in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableProjects

countLoggableProjects(session_key: string) -> int

Count loggable records in the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableSubcodes

countLoggableSubcodes(session_key: string) -> int

Count loggable records in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countLoggableSubsubcodes

countLoggableSubsubcodes(session_key: string) -> int

Count loggable records in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countMileageMeasurements

countMileageMeasurements(session_key: string) -> int

Count visible records in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countMileageReasons

countMileageReasons(session_key: string) -> int

Count visible records in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countMileageRecords

countMileageRecords(session_key: string) -> int

Count visible records in the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countMileageVehicles

countMileageVehicles(session_key: string) -> int

Count visible records in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjectApprovals

countProjectApprovals(session_key: string) -> int

Count visible records in the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjectApprovalSettings

countProjectApprovalSettings(session_key: string) -> int

Count visible records in the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjectApprovers

countProjectApprovers(session_key: string) -> int

Count visible records in the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjectCodeRates

countProjectCodeRates(session_key: string) -> int

Count visible records in the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjectPickerItems

countProjectPickerItems(session_key: string) -> int

Count visible records in the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countProjects

countProjects(session_key: string) -> int

Count visible records in the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPS_DV_Assignmentss

countPS_DV_Assignmentss(session_key: string) -> int

Count visible records in the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPS_DV_Ruless

countPS_DV_Ruless(session_key: string) -> int

Count visible records in the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPSAccrualOverrides

countPSAccrualOverrides(session_key: string) -> int

Count visible records in the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPSAccrualTierManagers

countPSAccrualTierManagers(session_key: string) -> int

Count visible records in the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPSCompensationTierManagers

countPSCompensationTierManagers(session_key: string) -> int

Count visible records in the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPunchRecords

countPunchRecords(session_key: string) -> int

Count visible records in the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countPXTeams

countPXTeams(session_key: string) -> int

Count visible records in the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countRateCodes

countRateCodes(session_key: string) -> int

Count visible records in the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countRequestRecords

countRequestRecords(session_key: string) -> int

Count visible records in the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countSubcodes

countSubcodes(session_key: string) -> int

Count visible records in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countSubsubcodes

countSubsubcodes(session_key: string) -> int

Count visible records in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countTimeRecords

countTimeRecords(session_key: string) -> int

Count visible records in the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countUserRoles

countUserRoles(session_key: string) -> int

Count visible records in the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countUsers

countUsers(session_key: string) -> int

Count visible records in the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countUserSheetNotes

countUserSheetNotes(session_key: string) -> int

Count visible records in the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countVirtualSheetRecords

countVirtualSheetRecords(session_key: string) -> int

Count visible records in the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

countVirtualTimeSheets

countVirtualTimeSheets(session_key: string) -> int

Count visible records in the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

create_or_update_suggestions

create_or_update_suggestions(session_key: string, id_user: string, source_category: string, source_data_list: RawSuggestion[], entry_type: string) -> SuggestionRefreshResult

Create new suggestions or update existing ones.

The source_data_list parameter is a list of RawSuggestion objects; each one of these must have either a SuggestionRecord in the source_data field, or a JSON representation of a suggestion in the json_data field. The extra_properties field contains properties that override those in the suggestion.

If the id_suggestion or source_id properties is included in a suggestion and it matches an existing one, it will be updated, otherwise a new suggestion will be created.

• @param id_user: The user to add suggestions for.
• @param source_category: The source category (eg. "generic").
• @param source_data_list: A list of RawSuggestion objects.
• @param entry_type: One of 'time', 'expense', or 'custom'.
• @return: A SuggestionRefreshResult object.

This method may be called by any logged-in user.

CreateApprovalPlan

CreateApprovalPlan(session_key: string, new_rec: ApprovalObject) -> int

• @param new_rec: The ApprovalObject structure describing the new approval plan.

• @return: 0

This method creates a new Approval Template for the approvals process and returns 0 (zero) to indicate success. This method raises an exception if the user does not have the authority to add an Approval Template, or if the record format is invalid.

ApprovalObjects have these keys and values:

• type - either time, expense, or mileage
• bizid - the business process ID which defines the approvers structure (how many approvers there are.) Use one of these constants, which correspond to the number of approvers: default1, default2, default3, default4, default5.
• name - the name of the Approval Template.
• Userbefore - number of days before the end of a period to send a reminder email to the user.
• Userafter - number of days after the end of a period before a reminder is sent to the user (if sheet has not been submitted)
• Approverafter - number of days after the end of a period before a notice is sent to the approver (if they user has not submitted a sheet.)
• Backupafter - number of days after the end of a period to notify the backup approver if a sheet has been submitted but not approved.
• Userrejected - a string to send to the user when his sheet is rejected.
• Userapproved - a string to send to the user when his sheet is approved.
• Approversubmitted - a string to send to the approver when a sheet is in his approval queue.

In addition to the above keys, you must add all the approvers to the Template when you create it, as there is no other way to modify an Approval Template through the jxAPI once created. (However, you can modify the Approval Template through the normal web interface.) Backup approvers are optional but you must add a primary approver key (approver_1 for instance) for each "level" of approval.

For instance, if you gave "default2" for the bizid field, this indicates a 2-level approval process. This means that you must give 2 primary approvers, and 0 to 2 backup approvers.

The valid keys for Primary Approvers and Backup approvers are:

• approver_1
• backup_approver_1
• approver_2
• backup_approver_2
• approver_3
• backup_approver_3
• approver_4
• backup_approver_4
• approver_5
• backup_approver_5

Again, the number of primary approvers must correspond exactly to the number of approval levels indicated by the bizid field. It is not possible to create an Approval Template through the jxAPI without specifying all the primary approvers.

You will get a ValueError exception if you are missing a primary approver.

This method requires administrator access.

createApprovalPlan

createApprovalPlan(session_key: string, new_rec: ApprovalObject) -> int

• @param new_rec: The ApprovalObject structure describing the new approval plan.

• @return: 0

This method creates a new Approval Template for the approvals process and returns 0 (zero) to indicate success. This method raises an exception if the user does not have the authority to add an Approval Template, or if the record format is invalid.

ApprovalObjects have these keys and values:

• type - either time, expense, or mileage
• bizid - the business process ID which defines the approvers structure (how many approvers there are.) Use one of these constants, which correspond to the number of approvers: default1, default2, default3, default4, default5.
• name - the name of the Approval Template.
• Userbefore - number of days before the end of a period to send a reminder email to the user.
• Userafter - number of days after the end of a period before a reminder is sent to the user (if sheet has not been submitted)
• Approverafter - number of days after the end of a period before a notice is sent to the approver (if they user has not submitted a sheet.)
• Backupafter - number of days after the end of a period to notify the backup approver if a sheet has been submitted but not approved.
• Userrejected - a string to send to the user when his sheet is rejected.
• Userapproved - a string to send to the user when his sheet is approved.
• Approversubmitted - a string to send to the approver when a sheet is in his approval queue.

In addition to the above keys, you must add all the approvers to the Template when you create it, as there is no other way to modify an Approval Template through the jxAPI once created. (However, you can modify the Approval Template through the normal web interface.) Backup approvers are optional but you must add a primary approver key (approver_1 for instance) for each "level" of approval.

For instance, if you gave "default2" for the bizid field, this indicates a 2-level approval process. This means that you must give 2 primary approvers, and 0 to 2 backup approvers.

The valid keys for Primary Approvers and Backup approvers are:

• approver_1
• backup_approver_1
• approver_2
• backup_approver_2
• approver_3
• backup_approver_3
• approver_4
• backup_approver_4
• approver_5
• backup_approver_5

Again, the number of primary approvers must correspond exactly to the number of approval levels indicated by the bizid field. It is not possible to create an Approval Template through the jxAPI without specifying all the primary approvers.

You will get a ValueError exception if you are missing a primary approver.

This method requires administrator access.

createGroupMemorizedEntry

createGroupMemorizedEntry(session_key: string, mtype: string, group: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type.

• @param group: The ID of the group to create the entry for.

• @param mrec: The memorized entry to create.

• @return: The ID of the newly created memorized entry.

Create a new memorized entry for a group.

This method requires administrator access.

createGroupMemorizedEntryWithNames

createGroupMemorizedEntryWithNames(session_key: string, mtype: string, group: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type.

• @param group: The ID of the group to create the entry for.

• @param mrec: The memorized entry to create.

• @return: The ID of the newly created memorized entry.

Create a new memorized entry for a group, converting group, project, and code names to IDs on the server side.

This method is a superset of the createGroupMemorizedEntry method, and is subject to its access restrictions.

createJournalForProject

createJournalForProject(session_key: string, projectid: string, journalname: string) -> string

• @param projectid: The ID of the project to attach the journal to.

• @param journalname: The name of the journal.

• @return: The journal ID.

Create a new journal (note set) for a project.

Note that if the specified journal name already exists, the ID of the existing journal will be returned, instead of creating a new one.

createNote

createNote(session_key: string, journalid: string, text: string, entrytype: string, entryid: string) -> int

• @param journalid: The journal ID.

• @param text: The text of the note.

• @param entrytype: If the note is associated with an entry, one of 'time', 'expense', or 'mileage'.

• @param entryid: If the note is associated with an entry, the entry ID.

• @return: 1 if successful.

Create a note in an existing journal.

createRateRule

createRateRule(session_key: string, raterule: RateRule) -> string

• @param raterule: The RateRule structure describing the rule to add.

• @return: The name of the newly added RateRule.

Adds a new rate rule.

This method requires administrator access.

createRuleSet

createRuleSet(session_key: string, ruleset: RuleSet) -> string

• @param ruleset: A RuleSet structure describing the policy to add.

• @return: The name of the newly added policy.

Adds a policy.

This method requires administrator access.

createUserAccrual

createUserAccrual(session_key: string, user: string, accrual: AccrualRecord) -> string

• @param user: The ID of the user.

• @param accrual: The accrual to create.

• @return: The ID of the newly created accrual.

Creates a new accrual for a user.

Note: This method is deprecated with the changes to accruals in 10.1, as it can only create old-style accruals.

This method requires administrator access.

createUserMemorizedEntry

createUserMemorizedEntry(session_key: string, mtype: string, user: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type.

• @param user: The ID of the user to create the entry for.

• @param mrec: The memorized entry to create.

• @return: The ID of the newly created memorized entry.

Create a new memorized entry for a user.

This method requires administrator access, unless the user specified by the "user" parameter is the current user.

createUserMemorizedEntryWithNames

createUserMemorizedEntryWithNames(session_key: string, mtype: string, user: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type.

• @param user: The ID of the user to create the entry for.

• @param mrec: The memorized entry to create.

• @return: The ID of the newly created memorized entry.

Create a new memorized entry for a user, converting provided group, project, and code names to their corresponding IDs on the server side. If the value of one of these fields cannot be found as a name, it will be assumed to be an ID instead.

This method is a superset of the createUserMemorizedEntry method, and is subject to its access restrictions.

customerNumber

customerNumber(session_key: string) -> string

Returns the customer number specified in the server license.

This method may be called by any logged-in user.

dateFormat

dateFormat(session_key: string) -> string

Returns a string identifying the short date display format used by the server:

• "US1" : MM/DD/YYYY
• "US2" : MM-DD-YYYY
• "US3" : MM.DD.YYYY
• "EU1" : DD/MM/YYYY
• "EU2" : DD-MM-YYYY
• "EU3" : DD.MM.YYYY
• "US1_SHORT" : MM/DD/YY
• "US2_SHORT" : MM-DD-YY
• "US3_SHORT" : MM.DD.YY
• "EU1_SHORT" : DD/MM/YY
• "EU2_SHORT" : DD-MM-YY
• "EU3_SHORT" : DD.MM.YY
• "ISO" : YYYYMMDD

Note that this affects the way dates are displayed in the UI only; dates passed in records or to other jxAPI methods are always YYYYMMDD unless specified otherwise.

This method may be called by any logged-in user.

delete_approval_plan

delete_approval_plan(session_key: string, sheet_type: string, planid: string, reopen_sheets: boolean) -> boolean

Deletes an approval plan.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param planid: The plan ID.
• @param reopen_sheets: If true, reopen sheets which are partially approved by this plan.
• @return: True if no exception occurred.

This method requires administrator access.

delete_approval_plans

delete_approval_plans(session_key: string, sheet_type: string, planids: string[], reopen_sheets: boolean) -> boolean

Deletes multiple approval plans.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param planids: A list of plan IDs.
• @param reopen_sheets: If true, reopen sheets which are partially approved by these plans.
• @return: True if no exception occurred.

This method requires administrator access.

delete_suggestion_by_id

delete_suggestion_by_id(session_key: string, id_suggestion: int) -> boolean

Delete a suggestion with a particular suggestion ID.

• @param id_suggestion: The ID of the suggestion to delete.
• @return: Always True if no exception is thrown.

This method may be called by any logged-in user.

delete_suggestion_by_source_id

delete_suggestion_by_source_id(session_key: string, id_user: string, source_id: string, source_category: string) -> boolean

Deletes a suggestion with a particular source ID.

• @param id_user: The user who owns the suggestion.
• @param source_id: The original source ID of the suggestion.
• @param source_category: The source category, eg. "generic".
• @return: Always True if no exception is thrown.

This method may be called by any logged-in user.

deleteAllAttachments

deleteAllAttachments(session_key: string, rectype: string, recid: string) -> int

Deletes all attachments from a time, expense, or mileage record.

Permission to delete attachments is tied to permission to modify the underlying time/expense/mileage record.

• @param rectype: One of 'time', 'expense', or 'mileage'.

• @param recid: The ID of the time/expense/mileage record to delete attachments from.

• @return: 1.

deleteAttachment

deleteAttachment(session_key: string, rectype: string, recid: string, filename: string) -> int

Deletes an attachment from a time, expense, or mileage record.

Permission to delete attachments is tied to permission to modify the underlying time/expense/mileage record.

• @param rectype: One of 'time', 'expense', or 'mileage'.

• @param recid: The ID of the time/expense/mileage record to delete the attachment from.

• @param filename: The filename of the attachment to delete.

• @return: 1.

deleteAttachmentByEncodedId

deleteAttachmentByEncodedId(session_key: string, uniqueId: string) -> int

Deletes an attachment given its encoded unique ID.

See deleteAttachment for more information.

• @param uniqueId: The attachment ID.

• @return: 1.

This method is a superset of the deleteAttachment method, and is subject to its access restrictions.

deleteAttribute

deleteAttribute(session_key: string, object_type: string, object_id: string, id_attr_type: string) -> int

This method causes the specified attribute value (the value at the 'address' of a specific Object Class and ID and an Attribute Type ID) to be 'unset' or deleted. Subsequent calls to getAttribute() with the same parameters would then return None.

• @param object_type: must be in the list of valid Object Types as returned by getAttributeObjectTypes.

• @param object_id: the Journyx database ID of the Object that we are deleting an attribute value for. It should belong to the object class (table) indicated by the first parameter.

• @param id_attr_type: the ID of the Attribute Type that we are to delete the values of.

• @return: If deleting the attribute value was successful, then 0 is returned.

• @raise RuntimeError: Object Type is invalid

• @raise ValueError: The Object ID does not exist

• @raise ValueError: The Attribute Type ID does not exist

• @raise Exception: The Attribute Value cannot be deleted (due to a permissions error or other reasons)

If the Object ID and Attribute Type ID were valid, but no value was previously set, then 0 is returned (no exception is raised.)

NOTE: You must have the 'Authority - Administrator' role ability to perform this action.

This method requires any one of the following abilities: "admin", "msp_admin"

deleteAttributeType

deleteAttributeType(session_key: string, id_attr_type: string) -> int

This method deletes not only the Attribute Type record, but ALL attributes of that type, including any historical time/expense/travel attributes.

WARNING

Since this causes a lot of records to be deleted, it should be used with caution. Only users with administrator privileges may run this command.

• @param id_attr_type: The ID of the Attribute Type that you wish to delete.

• @return: Returns 0 if successful.

• @raise RuntimError: If you lack the requisite privileges (admin ability).

• @raise ValueError: If the Attribute Type ID you provide does not exist.

NOTE: You must have the 'Authority - Administrator' role ability to perform this action.

This method requires administrator access.

deleteAttributeTypeSelectionValue

deleteAttributeTypeSelectionValue(session_key: string, id_attr_value: string) -> int

This method deletes the given Selection Value. It will no longer show up in Attribute Selection Lists. Any Objects which already have this Value will retain the value, but the value will not exist in future selection lists.

• @param id_attr_value: the Selection Value ID to delete.

• @return: 0 if successful.

• @raise ValueError: raised if the Selection Value (ID) does not exist.

This method requires administrator access.

deleteGroupMemorizedEntry

deleteGroupMemorizedEntry(session_key: string, mtype: string, id: string) -> int

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to delete.

• @return: 1

Removes a memorized entry from a group. Although it is not necessary to specify the group (since every memorized entry has a unique ID) this method will not remove memorized entries assigned to users, only those assigned to groups.

This method requires administrator access.

deleteJournal

deleteJournal(session_key: string, journalid: string) -> int

• @param journalid: The ID of the journal to delete.

Delete a journal and all of its notes.

This method requires administrator access.

deleteNote

deleteNote(session_key: string, noteid: string) -> int

• @param noteid: The ID of the note to delete.

• @return: 1 if successful.

Delete an existing note.

This method is equivalent to modifying the note text to an empty string.

deleteRateRule

deleteRateRule(session_key: string, rulename: string) -> int

• @param rulename: The name of the rate rule to delete.

• @return: 1

• @raise RuntimeError: If the rule is associated with a policy.

Deletes an existing rate rule. Rules that are associated with an existing policy cannot be deleted unless the policy is deleted first.

This method requires administrator access.

deleteRuleSet

deleteRuleSet(session_key: string, setname: string) -> int

• @param setname: The name of the policy to delete.

• @return: 1

Deletes a policy. Does not delete any of the rules that are part of the policy; if you want to remove those too you must delete them individually with deleteRateRule.

This method is a superset of the deleteRateRule method, and is subject to its access restrictions.

deleteUserAccrual

deleteUserAccrual(session_key: string, id: string) -> int

• @param id: The ID of the accrual to delete.

• @return: 1

Removes an existing accrual.

Note: This method is deprecated as of Journyx 10.1, even if you request an older API version.

This method requires administrator access.

deleteUserAttributeByLogin

deleteUserAttributeByLogin(session_key: string, object_id: string, id_attr_type: string) -> int

This method causes the specified attribute value (the value at the 'address' of a user ID and an Attribute Type ID) to be 'unset' or deleted. Subsequent calls to getAttribute() with the same parameters would then return None.

• @param object_id: the Journyx user login of the user for whom we are deleting an attribute value.

• @param id_attr_type: the ID of the Attribute Type that we are to delete the values of.

• @return: If deleting the attribute value was successful, then 0 is returned.

• @raise ValueError: The Object ID does not exist

• @raise ValueError: The Attribute Type ID does not exist

• @raise Exception: The Attribute Value cannot be deleted (due to a permissions error or other reasons)

If the Object ID and Attribute Type ID were valid, but no value was previously set, then 0 is returned (no exception is raised.)

NOTE: You must have the 'Authority - Administrator' role ability to perform this action.

This method requires any one of the following abilities: "admin", "msp_admin"

deleteUserMemorizedEntry

deleteUserMemorizedEntry(session_key: string, mtype: string, id: string) -> int

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to delete.

• @return: 1

Deletes a memorized entry. Although it is not necessary to specify the user (since every memorized entry has a unique ID) this method will not remove memorized entries assigned to groups, only those assigned to users.

This method requires administrator access.

doesProjectApprovalStartOver

doesProjectApprovalStartOver(session_key: string, project_id: string) -> boolean

Check whether project approval starts over upon a rejection or modification.

• @param project_id: The project ID.
• @return: True if approvals restart, False if not.

This method may be called by any logged-in user.

dropAttributeTypeAsHistorical

dropAttributeTypeAsHistorical(session_key: string, object_type: string, id_attr_type: string) -> int

This method drops a Historical Attribute Type. The Attribute Type record isn't deleted, only it is no longer tracked as a historical attribute.

The actual values for historical attribute-types are not deleted either. This method only prevents future Time/Expense/Travel records from recording the historical value of the given Attribute Type.

See the general JXAPI documentation for a general explanation of Historical Attributes.

• @param object_type: must be one of these: [ time_recs, expense_recs, travel_recs ]

• @param id_attr_type: the ID of an Attribute Type

• @return: 0 if successful.

• @raise ValueError: If object_type is not in the allowed list, or if id_attr_type is not a valid Attribute Type.

• @raise RuntimeError: If id_attr_type is not historical for this object_type

This method requires administrator access.

encodeUniqueAttachmentId

encodeUniqueAttachmentId(session_key: string, tablename: string, recid: string, filename: string) -> string

Converts a table name, record ID, and attachment filename into an encoded unique ID for that attachment, similar to the ones returned from addAttachment.

The table name will be canonicalized, so you can use synonyms like "time" for "time_recs", "mileage" for "travel_recs", etc.

• @param tablename: A table name such as 'time_recs', 'expense_recs', 'travel_recs'.

• @param recid: The time/expense/mileage record ID.

• @param filename: The attachment filename.

• @return: The encoded attachment ID.

This method may be called by any logged-in user.

expirationDate

expirationDate(session_key: string) -> string

Returns the date on which the server license expires, as a printable string. This is the expiration date for the "master" site license, and does not reflect the expiration dates of any domains. If the license is set to never expire, the string "Never" is returned. Otherwise the expiration date is returned in YYYYMMDD format.

This method may be called by any logged-in user.

get_my_memorized_entries

get_my_memorized_entries(session_key: string) -> MemorizedEntries[]

Returns all of the current user's memorized entries for all screen types.

The return is a list of MemorizedEntry structures, usually containing three items for time, expense, and mileage.

• @param withNames: include _name keys for each ID. Please note that this changes the 'code' keys to be numbered from code0...code2 instead of code1...code3, to match getSheet and similar API methods.

NOTE: withNames=True probably ought to be default, but as noted above, this would pose a problem for clients expecting the code0 key. Perhaps a new method that does the same but defaults to include names would be better...

• @return: A MemorizedEntries list.

This method may be called by any logged-in user.

get_suggestion_by_id

get_suggestion_by_id(session_key: string, id_suggestion: int) -> SuggestionRecord

Get a suggestion with a particular ID.

• @param id_suggestion: The ID of the suggestion to retrieve.
• @return: A SuggestionRecord object.

This method may be called by any logged-in user.

get_suggestion_by_source_id

get_suggestion_by_source_id(session_key: string, id_user: string, source_category: string, source_id: string) -> SuggestionRecord

Get a suggestion with a particular source ID.

• @param id_user: The ID of the user that owns the suggestion.
• @param source_category: The source category (eg. "generic")
• @param source_id: The source ID of the suggestion to retrieve.
• @return: A SuggestionRecord object.

This method may be called by any logged-in user.

get_suggestions_by_id

get_suggestions_by_id(session_key: string, id_suggestion_list: int[]) -> SuggestionRecord[]

Get multiple suggestions with particular IDs.

• @param id_suggestion_list: A list of IDs of suggestions to retrieve.
• @return: A list of SuggestionRecords corresponding to the specified IDs.

This method may be called by any logged-in user.

get_suggestions_for_date_range

get_suggestions_for_date_range(session_key: string, id_user: string, start_date: string, end_date: string) -> SuggestionRecord[]

Returns a list of available suggestions for a particular user and date range.

To specify an open-ended date range, pass an empty string to the start_date or end_date parameters.

• @param id_user: The user ID to fetch suggestions for.
• @param start_date: The start date of the range, or empty string if open-ended.
• @param end_date: The end date of the range, or empty string if open-ended.
• @return: A list of SuggestionRecord objects.

This method may be called by any logged-in user.

getAccessControlList

getAccessControlList(session_key: string, pattern: AccessControlList) -> AccessControlList

Get a single record from the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccessControlListById

getAccessControlListById(session_key: string, id: string) -> AccessControlList

Get the record with a specified ID from the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccessControlLists

getAccessControlLists(session_key: string, pattern: AccessControlList) -> AccessControlList[]

Get multiple records from the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccrual

getAccrual(session_key: string, pattern: Accrual) -> Accrual

Get a single record from the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccrualById

getAccrualById(session_key: string, id: string) -> Accrual

Get the record with a specified ID from the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccrualEvent

getAccrualEvent(session_key: string, pattern: AccrualEvent) -> AccrualEvent

Get a single record from the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccrualEventById

getAccrualEventById(session_key: string, id: string) -> AccrualEvent

Get the record with a specified ID from the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccrualEvents

getAccrualEvents(session_key: string, pattern: AccrualEvent) -> AccrualEvent[]

Get multiple records from the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAccruals

getAccruals(session_key: string, pattern: Accrual) -> Accrual[]

Get multiple records from the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllAccessControlLists

getAllAccessControlLists(session_key: string) -> AccessControlList[]

Get all records from the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllAccrualEvents

getAllAccrualEvents(session_key: string) -> AccrualEvent[]

Get all records from the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllAccruals

getAllAccruals(session_key: string) -> Accrual[]

Get all records from the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllAssignments

getAllAssignments(session_key: string) -> AssignmentRecord[]

Get all records from the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllAttachmentTableNames

getAllAttachmentTableNames(session_key: string) -> string[]

Returns the names of tables which can have attachments.

• @return: A list of table names (strings).

This method may be called by any logged-in user.

getAllCodes

getAllCodes(session_key: string) -> CodeRecord[]

Get all records from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesCustom4s

getAllCodesCustom4s(session_key: string) -> CodesCustom4Record[]

Get all records from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesCustom5s

getAllCodesCustom5s(session_key: string) -> CodesCustom5Record[]

Get all records from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesCustom6s

getAllCodesCustom6s(session_key: string) -> CodesCustom6Record[]

Get all records from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesCustom7s

getAllCodesCustom7s(session_key: string) -> CodesCustom7Record[]

Get all records from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesExpense4s

getAllCodesExpense4s(session_key: string) -> CodesExpense4Record[]

Get all records from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesExpense5s

getAllCodesExpense5s(session_key: string) -> CodesExpense5Record[]

Get all records from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesExpense6s

getAllCodesExpense6s(session_key: string) -> CodesExpense6Record[]

Get all records from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesExpense7s

getAllCodesExpense7s(session_key: string) -> CodesExpense7Record[]

Get all records from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesTime4s

getAllCodesTime4s(session_key: string) -> CodesTime4Record[]

Get all records from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesTime5s

getAllCodesTime5s(session_key: string) -> CodesTime5Record[]

Get all records from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesTime6s

getAllCodesTime6s(session_key: string) -> CodesTime6Record[]

Get all records from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllCodesTime7s

getAllCodesTime7s(session_key: string) -> CodesTime7Record[]

Get all records from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllColumnDependencies

getAllColumnDependencies(session_key: string) -> ColumnDependency[]

Retrieve all code column dependencies, with IDs converted to names.

This method return all code column dependencies, as ColumnDependency records.

• @return: A list of all ColumnDependency records.

This method may be called by any logged-in user.

getAllColumnDependenciesAsIDs

getAllColumnDependenciesAsIDs(session_key: string) -> ColumnDependency[]

Retrieve all code column dependencies.

This method return all code column dependencies, as ColumnDependency records.

• @return: A list of all ColumnDependency records.

This method may be called by any logged-in user.

getAllColumnRecords

getAllColumnRecords(session_key: string, loggableOnly: boolean) -> AllColumnRecords

Returns all records selectable in UI columns.

TODO: this returns too much info that most clients won't need Also, can we put some enhanced caching on this?!

This methods is intended as a single-round-trip way to fetch all of the information needed to present project and code selection lists to the user. It returns an AllColumnRecords structure which contains a list of all visible and loggable projects and codes from all supported code columns.

Note: This method is only supported in the WS-I endpoint and untyped endpoints. It may or may not work in others.

This method may be called by any logged-in user.

getAllCurrencyConversions

getAllCurrencyConversions(session_key: string) -> CurrencyConversion[]

Get all records from the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllExpenseCodes

getAllExpenseCodes(session_key: string) -> ExpenseCodeRecord[]

Get all records from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllExpenseCurrencys

getAllExpenseCurrencys(session_key: string) -> ExpenseCurrencyRecord[]

Get all records from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllExpenseRecords

getAllExpenseRecords(session_key: string) -> ExpenseRecord[]

Get all records from the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllExpenseSources

getAllExpenseSources(session_key: string) -> ExpenseSourceRecord[]

Get all records from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllGroupMemorizedEntries

getAllGroupMemorizedEntries(session_key: string, mtype: string) -> MemorizedEntries[]

• @return: A list of MemorizedEntries records representing all groups and entry types.

This method requires administrator access.

getAllGroups

getAllGroups(session_key: string) -> GroupRecord[]

Get all records from the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllMileageMeasurements

getAllMileageMeasurements(session_key: string) -> MileageMeasurementRecord[]

Get all records from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllMileageReasons

getAllMileageReasons(session_key: string) -> MileageReasonRecord[]

Get all records from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllMileageRecords

getAllMileageRecords(session_key: string) -> MileageRecord[]

Get all records from the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllMileageVehicles

getAllMileageVehicles(session_key: string) -> MileageVehicleRecord[]

Get all records from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjectApprovals

getAllProjectApprovals(session_key: string) -> ProjectApproval[]

Get all records from the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjectApprovalSettings

getAllProjectApprovalSettings(session_key: string) -> ProjectApprovalSetting[]

Get all records from the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjectApprovers

getAllProjectApprovers(session_key: string) -> ProjectApprover[]

Get all records from the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjectCodeRates

getAllProjectCodeRates(session_key: string) -> ProjectCodeRate[]

Get all records from the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjectDependencies

getAllProjectDependencies(session_key: string, loggableOnly: boolean) -> ProjectDependencies[]

Returns all project dependencies.

This method is intended as a replacement for the many API round-trips that would be required to get all of a user's project information -- instead of a separate call for each dependency type for each project, you can call this single method instead, plus one call to get all records from each relevant table.

The sole argument is a boolean flag which, if true, limits the return to only loggable projects.

Note: This method is only supported in the WS-I endpoint and untyped endpoints.

This method may be called by any logged-in user.

getAllProjectPickerItems

getAllProjectPickerItems(session_key: string) -> ProjectPickerItem[]

Get all records from the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllProjects

getAllProjects(session_key: string) -> ProjectRecord[]

Get all records from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPS_DV_Assignmentss

getAllPS_DV_Assignmentss(session_key: string) -> PS_DV_Assignments[]

Get all records from the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPS_DV_Ruless

getAllPS_DV_Ruless(session_key: string) -> PS_DV_Rules[]

Get all records from the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPSAccrualOverrides

getAllPSAccrualOverrides(session_key: string) -> PSAccrualOverride[]

Get all records from the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPSAccrualTierManagers

getAllPSAccrualTierManagers(session_key: string) -> PSAccrualTierManager[]

Get all records from the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPSCompensationTierManagers

getAllPSCompensationTierManagers(session_key: string) -> PSCompensationTierManager[]

Get all records from the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPunchRecords

getAllPunchRecords(session_key: string) -> PunchRecord[]

Get all records from the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllPXTeams

getAllPXTeams(session_key: string) -> PXTeamRecord[]

Get all records from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllRateCodes

getAllRateCodes(session_key: string) -> RateCodeRecord[]

Get all records from the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllRequestRecords

getAllRequestRecords(session_key: string) -> RequestRecord[]

Get all records from the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllSheetIDs

getAllSheetIDs(session_key: string, sheet_type: string) -> string[]

Returns a list of the IDs of all of the current user's sheets of the specified type.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.

This method may be called by any logged-in user.

getAllSubcodes

getAllSubcodes(session_key: string) -> SubcodeRecord[]

Get all records from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllSubsubcodes

getAllSubsubcodes(session_key: string) -> SubsubcodeRecord[]

Get all records from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllTimeRecords

getAllTimeRecords(session_key: string) -> TimeRecord[]

Get all records from the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllUserMemorizedEntries

getAllUserMemorizedEntries(session_key: string, mtype: string) -> MemorizedEntries[]

• @return: A list of MemorizedEntries records representing all users and entry types.

This method requires administrator access.

getAllUserRoles

getAllUserRoles(session_key: string) -> UserRole[]

Get all records from the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllUsers

getAllUsers(session_key: string) -> UserRecord[]

Get all records from the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllUserSheetNotes

getAllUserSheetNotes(session_key: string) -> UserSheetNote[]

Get all records from the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllVirtualSheetRecords

getAllVirtualSheetRecords(session_key: string) -> VirtualSheetRecord[]

Get all records from the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAllVirtualTimeSheets

getAllVirtualTimeSheets(session_key: string) -> VirtualTimeSheet[]

Get all records from the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getApprovalPlans

getApprovalPlans(session_key: string, ids: string[]) -> ApprovalObject[]

• @param ids: The list of plan IDs to retrieve. Pass an empty list to retrieve all visible plans.

• @return: A list of ApprovalObject structures describing the retrieved plans.

This method is used to retrieve Approval Plan records. If called with no parameters, it returns a list of all visible Approval Plan records. If one or more Plan ID's are given as a list in the optional parameter, the returned records will be restricted to those named ID's. If no Approval Plans are visible, an empty list will be returned.

This method requires administrator access.

getApprovalPlansForUser

getApprovalPlansForUser(session_key: string, userid: string) -> string[]

• @param userid: The ID of the user to retrieve approval plans for.

• @return: A list of three approval plan IDs for time, expense, and mileage.

Gets the approval plan IDs for a user. This method returns three strings with the user's time, expense, and mileage approval plan IDs, in that order. If the user does not have an approval plan assigned to one or more of those sheet types, the returned ID for it will be an empty string.

You must have 'Authority - Administrator' to perform this action for a user other than yourself, or else have one of the following group-scoped abilities over the user: 'Authority - Manager' 'Authority - Timekeeper' 'Authority - Expensekeeper' 'Authority - Mileagekeeper'

getApprovalPlansOfTypeForUsers

getApprovalPlansOfTypeForUsers(session_key: string, sheetType: string, userIds: string[]) -> string[]

• @param sheetType: The sheet type ('time', 'expense', or 'mileage') of approval plans to retrieve.

• @param userIds: The IDs of the users to retrieve approval plans for.

• @return: A list of approval plan IDs.

Return a list of approval plan IDs of the same length as a list of provided user IDs. They are ordered like the lis of user IDs to allow for correlation. This will be based on the type ('time', 'expense', or 'mileage') passed in.

This method requires administrator access.

getAssignment

getAssignment(session_key: string, pattern: AssignmentRecord) -> AssignmentRecord

Get a single record from the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAssignmentAttributes

getAssignmentAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a assignments (Assignment) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getAssignmentAttributeTypes

getAssignmentAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getAssignmentById

getAssignmentById(session_key: string, id: string) -> AssignmentRecord

Get the record with a specified ID from the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAssignments

getAssignments(session_key: string, pattern: AssignmentRecord) -> AssignmentRecord[]

Get multiple records from the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getAttachment

getAttachment(session_key: string, rectype: string, recid: string, filename: string, includeFile: boolean) -> Attachment

Returns information about an attachment, which may include the attachment data itself.

The includeFile parameter determines whether the attachment content is returned. If it is false the other fields of the Attachment object will be filled in, but the "attachment" field (which normally contains the file data) will be empty. If it is true, the "attachment" field will contain the base64 encoded data of the attachment.

Permission to read attachments is tied to permission to read the associated time/expense/mileage record.

• @param rectype: One of 'time', 'expense', or 'mileage'.

• @param recid: The ID of the time/expense/mileage record to retrieve the attachment from.

• @param filename: The filename of the attachment to retrieve.

• @param includeFile: If true, return the attachment content in addition to other information.

• @return: An Attachment record.

getAttachmentByEncodedId

getAttachmentByEncodedId(session_key: string, uniqueId: string, includeFile: boolean) -> Attachment

Returns an attachment given its encoded unique ID.

See getAttachment for more information.

• @param uniqueId: The attachment ID.

• @param includeFile: If true, the attachment data will be included in the returned record.

• @return: An Attachment record.

This method is a superset of the getAttachment method, and is subject to its access restrictions.

getAttachments

getAttachments(session_key: string, rectype: string, recids: string[], filenames: string[], includeFiles: boolean) -> Attachment[]

Returns multiple attachments from multiple records.

You may specify multiple record IDs and multiple filenames, and all matching attachments will be returned. You must specify at least one record ID, but an empty filename list will return all attachments for the specified records.

The includeFiles parameter determines whether the attachment content is returned. If it is false, the "attachment" field of the returned records will be empty; if it is true, the "attachment" field will contain the base64 encoded data of the attachment.

Take care when calling this method with multiple record IDs, especially with includeFiles as True, as it can produce extremely large responses which may be difficult for some client-side RPC libraries to deal with.

Permission to get attachments is tied to permission to read the underlying time/expense/mileage record. If you pass multiple record IDs, a failed visibility check for any one of them will cause this method to fail with an exception.

• @param rectype: One of 'time', 'expense', or 'mileage'.

• @param recids: A non-empty list of record IDs to fetch attachments from.

• @param filenames: A list of filenames of attachments to fetch, or an empty list to get them all.

• @param includeFiles: If true, return the attachment content in each record.

• @return: A list of Attachment records.

getAttribute

getAttribute(session_key: string, object_type: string, object_id: string, id_attr_type: string) -> string

Fetches the value of an attribute (extra field) for a given object type and ID.

In untyped endpoints, this method may be used to fetch the value of any attribute, and the type of its return value depends on the type of the attribute.

In typed endpoints, this method only works for attributes with string values Use getAttributeInteger or getAttributeNumber for attributes with integer and floating point values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to get the attribute value from.

• @param id_attr_type: The ID of the attribute type.

• @return: the attribute value

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if either the object or the attribute type do not exist

getAttributeInteger

getAttributeInteger(session_key: string, object_type: string, object_id: string, id_attr_type: string) -> int

Fetches the value of an integer attribute (extra field) for a given object type and ID.

This method does not exist in untyped endpoints; use getAttribute instead.

In typed endpoints, this method only works for attributes with integer values. Use getAttribute or getAttributeNumber for attributes with string and floating point values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to get the attribute value from.

• @param id_attr_type: The ID of the attribute type.

• @return: the attribute value

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if either the object or the attribute type do not exist

This method is a superset of the getAttribute method, and is subject to its access restrictions.

getAttributeNumber

getAttributeNumber(session_key: string, object_type: string, object_id: string, id_attr_type: string) -> double

Fetches the value of a floating point attribute (extra field) for a given object type and ID.

This method does not exist in untyped endpoints; use getAttribute instead.

In typed endpoints, this method only works for attributes with float values. Use getAttribute or getAttributeNumber for attributes with string and floating point values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to get the attribute value from.

• @param id_attr_type: The ID of the attribute type.

• @return: the attribute value

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if either the object or the attribute type do not exist

This method is a superset of the getAttribute method, and is subject to its access restrictions.

getAttributeObjectTypes

getAttributeObjectTypes(session_key: string) -> string[]

Returns a list of strings naming the Object Types (tables) that are legal to use in conjunction with Attributes.

This method may be called by any logged-in user.

getAttributeTypeByName

getAttributeTypeByName(session_key: string, object_type: string, type_name: string) -> string

Fetches the ID of a named attribute type. (See getAttributeTypeRecordByName if you need the entire record.)

• @param object_type: The object type this attribute type applies to (use getAttributeObjectTypes to determine usable values).

• @param type_name: The name of the attribute type.

• @return: the ID of the attribute type, or an empty string if it is not found

• @raise RuntimeError: if the object type is not valid

This method may be called by any logged-in user.

getAttributeTypeDefaultValue

getAttributeTypeDefaultValue(session_key: string, id_attr_type: string) -> string

Fetches the default value associated with an attribute (extra field).

In untyped endpoints, this method may be used to retrieve values of any type.

In typed endpoints, this method may only be used to retrieve string values. Use getAttributeTypeDefaultValueInteger or getAttributeTypeDefaultValueNumber to retrieve integer and floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @return: the default value of the attribute type

• @raise ValueError: if the specified attribute type does not exist

This method may be called by any logged-in user.

getAttributeTypeDefaultValueInteger

getAttributeTypeDefaultValueInteger(session_key: string, id_attr_type: string) -> int

Fetches the default value associated with an attribute (extra field).

This method does not exist in untyped endpoints; use getAttributeTypeDefaultValue instead.

In typed endpoints, this method may only be used to retrieve integer values. Use getAttributeTypeDefaultValue or getAttributeTypeDefaultValueNumber to retrieve string and floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @return: the default value of the attribute type

• @raise ValueError: if the specified attribute type does not exist

This method is a superset of the getAttributeTypeDefaultValue method, and is subject to its access restrictions.

getAttributeTypeDefaultValueNumber

getAttributeTypeDefaultValueNumber(session_key: string, id_attr_type: string) -> double

Fetches the default value associated with an attribute (extra field).

This method does not exist in untyped endpoints; use getAttributeTypeDefaultValue instead.

In typed endpoints, this method may only be used to retrieve floating point values. Use getAttributeTypeDefaultValue or getAttributeTypeDefaultValueInteger to retrieve string and integer values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @return: the default value of the attribute type

• @raise ValueError: if the specified attribute type does not exist

This method is a superset of the getAttributeTypeDefaultValue method, and is subject to its access restrictions.

getAttributeTypeRecordByName

getAttributeTypeRecordByName(session_key: string, object_type: string, type_name: string) -> AttributeTypeRecord

Fetches a named attribute type.

• @param object_type: The object type this attribute type applies to (use getAttributeObjectTypes to determine usable values).

• @param type_name: The name of the attribute type.

• @return: the attribute type record

• @raise RuntimeError: if the object type is not valid

This method is a superset of the getAttributeTypeByName method, and is subject to its access restrictions.

getAttributeTypeReportability

getAttributeTypeReportability(session_key: string, id_attr_type: string) -> string[]

Returns a list of role ids that can report on the specified attribute type

• @param id_attr_type: the ID of the Attribute Type we want to get the reportability information about

This method may be called by any logged-in user.

getAttributeTypeSelectionValueRecords

getAttributeTypeSelectionValueRecords(session_key: string) -> string

This method returns an Array (of Arrays) representing all the Selection Values that exist for the given Attribute Type ID.

Both the Values themselves and their ID's are returned in pairs.

• @param id_attr_type: the ID of the Attribute Type that we are interested in.

• @return: An Array of 2-length string Arrays is returned, where each 2-length array is the pair (Value, SelectionValueID) The values are returned sorted in ascending order, with the default value (if any) always first.

• @raise ValueError: raised if the Attribute Type does not exist.

This method may be called by any logged-in user.

getAttributeTypeSelectionValues

getAttributeTypeSelectionValues(session_key: string, id_attr_type: string) -> string[]

This method returns an Array (of strings) representing all the Selection Values that exist for the given Attribute Type ID. Only the values themselves are returned, not the Selection Value ID's (for those, use the getAttributeTypeSelectionValueRecords method.)

• @param id_attr_type: the ID of the Attribute Type that we are interested in.

• @return: An Array / list of strings is returned, where each string is a Selection Value for the given Attribute Type. The values themselves are returned, not the Value IDs. The values are returned sorted in ascending order, with the default value (if any) always first.

• @raise ValueError: raised if the Attribute Type does not exist.

This method may be called by any logged-in user.

getBooleanPreference

getBooleanPreference(session_key: string, key: string) -> boolean

Get the value of a boolean Journyx setting.

• @param key: The preference key to retrieve.
• @return: A boolean representing the value of the preference.

Using this on non-boolean preferences will probably not produce a meaningful result.

This method may be called by any logged-in user.

getCode

getCode(session_key: string, pattern: CodeRecord) -> CodeRecord

Get a single record from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodeAttributes

getCodeAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_tasks (Code) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodeAttributeTypes

getCodeAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodeById

getCodeById(session_key: string, id: string) -> CodeRecord

Get the record with a specified ID from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodes

getCodes(session_key: string, pattern: CodeRecord) -> CodeRecord[]

Get multiple records from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom4

getCodesCustom4(session_key: string, pattern: CodesCustom4Record) -> CodesCustom4Record

Get a single record from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom4Attributes

getCodesCustom4Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_custom_4 (CodesCustom4) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesCustom4AttributeTypes

getCodesCustom4AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesCustom4ById

getCodesCustom4ById(session_key: string, id: string) -> CodesCustom4Record

Get the record with a specified ID from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom4s

getCodesCustom4s(session_key: string, pattern: CodesCustom4Record) -> CodesCustom4Record[]

Get multiple records from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom5

getCodesCustom5(session_key: string, pattern: CodesCustom5Record) -> CodesCustom5Record

Get a single record from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom5Attributes

getCodesCustom5Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_custom_5 (CodesCustom5) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesCustom5AttributeTypes

getCodesCustom5AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesCustom5ById

getCodesCustom5ById(session_key: string, id: string) -> CodesCustom5Record

Get the record with a specified ID from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom5s

getCodesCustom5s(session_key: string, pattern: CodesCustom5Record) -> CodesCustom5Record[]

Get multiple records from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom6

getCodesCustom6(session_key: string, pattern: CodesCustom6Record) -> CodesCustom6Record

Get a single record from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom6Attributes

getCodesCustom6Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_custom_6 (CodesCustom6) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesCustom6AttributeTypes

getCodesCustom6AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesCustom6ById

getCodesCustom6ById(session_key: string, id: string) -> CodesCustom6Record

Get the record with a specified ID from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom6s

getCodesCustom6s(session_key: string, pattern: CodesCustom6Record) -> CodesCustom6Record[]

Get multiple records from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom7

getCodesCustom7(session_key: string, pattern: CodesCustom7Record) -> CodesCustom7Record

Get a single record from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom7Attributes

getCodesCustom7Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_custom_7 (CodesCustom7) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesCustom7AttributeTypes

getCodesCustom7AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesCustom7ById

getCodesCustom7ById(session_key: string, id: string) -> CodesCustom7Record

Get the record with a specified ID from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesCustom7s

getCodesCustom7s(session_key: string, pattern: CodesCustom7Record) -> CodesCustom7Record[]

Get multiple records from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense4

getCodesExpense4(session_key: string, pattern: CodesExpense4Record) -> CodesExpense4Record

Get a single record from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense4Attributes

getCodesExpense4Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expense_4 (CodesExpense4) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesExpense4AttributeTypes

getCodesExpense4AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesExpense4ById

getCodesExpense4ById(session_key: string, id: string) -> CodesExpense4Record

Get the record with a specified ID from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense4s

getCodesExpense4s(session_key: string, pattern: CodesExpense4Record) -> CodesExpense4Record[]

Get multiple records from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense5

getCodesExpense5(session_key: string, pattern: CodesExpense5Record) -> CodesExpense5Record

Get a single record from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense5Attributes

getCodesExpense5Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expense_5 (CodesExpense5) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesExpense5AttributeTypes

getCodesExpense5AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesExpense5ById

getCodesExpense5ById(session_key: string, id: string) -> CodesExpense5Record

Get the record with a specified ID from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense5s

getCodesExpense5s(session_key: string, pattern: CodesExpense5Record) -> CodesExpense5Record[]

Get multiple records from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense6

getCodesExpense6(session_key: string, pattern: CodesExpense6Record) -> CodesExpense6Record

Get a single record from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense6Attributes

getCodesExpense6Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expense_6 (CodesExpense6) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesExpense6AttributeTypes

getCodesExpense6AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesExpense6ById

getCodesExpense6ById(session_key: string, id: string) -> CodesExpense6Record

Get the record with a specified ID from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense6s

getCodesExpense6s(session_key: string, pattern: CodesExpense6Record) -> CodesExpense6Record[]

Get multiple records from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense7

getCodesExpense7(session_key: string, pattern: CodesExpense7Record) -> CodesExpense7Record

Get a single record from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense7Attributes

getCodesExpense7Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expense_7 (CodesExpense7) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesExpense7AttributeTypes

getCodesExpense7AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesExpense7ById

getCodesExpense7ById(session_key: string, id: string) -> CodesExpense7Record

Get the record with a specified ID from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesExpense7s

getCodesExpense7s(session_key: string, pattern: CodesExpense7Record) -> CodesExpense7Record[]

Get multiple records from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime4

getCodesTime4(session_key: string, pattern: CodesTime4Record) -> CodesTime4Record

Get a single record from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime4Attributes

getCodesTime4Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_time_4 (CodesTime4) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesTime4AttributeTypes

getCodesTime4AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesTime4ById

getCodesTime4ById(session_key: string, id: string) -> CodesTime4Record

Get the record with a specified ID from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime4s

getCodesTime4s(session_key: string, pattern: CodesTime4Record) -> CodesTime4Record[]

Get multiple records from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime5

getCodesTime5(session_key: string, pattern: CodesTime5Record) -> CodesTime5Record

Get a single record from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime5Attributes

getCodesTime5Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_time_5 (CodesTime5) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesTime5AttributeTypes

getCodesTime5AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesTime5ById

getCodesTime5ById(session_key: string, id: string) -> CodesTime5Record

Get the record with a specified ID from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime5s

getCodesTime5s(session_key: string, pattern: CodesTime5Record) -> CodesTime5Record[]

Get multiple records from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime6

getCodesTime6(session_key: string, pattern: CodesTime6Record) -> CodesTime6Record

Get a single record from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime6Attributes

getCodesTime6Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_time_6 (CodesTime6) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesTime6AttributeTypes

getCodesTime6AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesTime6ById

getCodesTime6ById(session_key: string, id: string) -> CodesTime6Record

Get the record with a specified ID from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime6s

getCodesTime6s(session_key: string, pattern: CodesTime6Record) -> CodesTime6Record[]

Get multiple records from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime7

getCodesTime7(session_key: string, pattern: CodesTime7Record) -> CodesTime7Record

Get a single record from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime7Attributes

getCodesTime7Attributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_time_7 (CodesTime7) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getCodesTime7AttributeTypes

getCodesTime7AttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getCodesTime7ById

getCodesTime7ById(session_key: string, id: string) -> CodesTime7Record

Get the record with a specified ID from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCodesTime7s

getCodesTime7s(session_key: string, pattern: CodesTime7Record) -> CodesTime7Record[]

Get multiple records from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getColumnDependencies

getColumnDependencies(session_key: string, pattern: ColumnDependency) -> ColumnDependency[]

Retrieve code column dependencies, with IDs converted to names.

This method returns code column dependencies (as ColumnDependency records) that match a pattern.

• @param pattern: A ColumnDependency record pattern which is matched against the database.
• @return: A list of matching ColumnDependency records.

This method may be called by any logged-in user.

getColumnDependenciesAsIDs

getColumnDependenciesAsIDs(session_key: string, pattern: ColumnDependency) -> ColumnDependency[]

Retrieve code column dependencies.

This method returns code column dependencies (as ColumnDependency records) that match a pattern.

• @param pattern: A ColumnDependency record pattern which is matched against the database.
• @return: A list of matching ColumnDependency records.

This method may be called by any logged-in user.

getCurrencyConversion

getCurrencyConversion(session_key: string, pattern: CurrencyConversion) -> CurrencyConversion

Get a single record from the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCurrencyConversionById

getCurrencyConversionById(session_key: string, id: string) -> CurrencyConversion

Get the record with a specified ID from the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getCurrencyConversions

getCurrencyConversions(session_key: string, pattern: CurrencyConversion) -> CurrencyConversion[]

Get multiple records from the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getDatesInSheet

getDatesInSheet(session_key: string, sheet_type: string, id: string) -> string[]

Returns a list of the dates covered by the specified sheet.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

This method may be called by any logged-in user.

getDefaultAccessControlList

getDefaultAccessControlList(session_key: string) -> AccessControlList

Get a default record for the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultAccrual

getDefaultAccrual(session_key: string) -> Accrual

Get a default record for the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultAccrualEvent

getDefaultAccrualEvent(session_key: string) -> AccrualEvent

Get a default record for the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultAssignment

getDefaultAssignment(session_key: string) -> AssignmentRecord

Get a default record for the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCode

getDefaultCode(session_key: string) -> CodeRecord

Get a default record for the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesCustom4

getDefaultCodesCustom4(session_key: string) -> CodesCustom4Record

Get a default record for the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesCustom5

getDefaultCodesCustom5(session_key: string) -> CodesCustom5Record

Get a default record for the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesCustom6

getDefaultCodesCustom6(session_key: string) -> CodesCustom6Record

Get a default record for the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesCustom7

getDefaultCodesCustom7(session_key: string) -> CodesCustom7Record

Get a default record for the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesExpense4

getDefaultCodesExpense4(session_key: string) -> CodesExpense4Record

Get a default record for the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesExpense5

getDefaultCodesExpense5(session_key: string) -> CodesExpense5Record

Get a default record for the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesExpense6

getDefaultCodesExpense6(session_key: string) -> CodesExpense6Record

Get a default record for the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesExpense7

getDefaultCodesExpense7(session_key: string) -> CodesExpense7Record

Get a default record for the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesTime4

getDefaultCodesTime4(session_key: string) -> CodesTime4Record

Get a default record for the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesTime5

getDefaultCodesTime5(session_key: string) -> CodesTime5Record

Get a default record for the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesTime6

getDefaultCodesTime6(session_key: string) -> CodesTime6Record

Get a default record for the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCodesTime7

getDefaultCodesTime7(session_key: string) -> CodesTime7Record

Get a default record for the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultCurrencyConversion

getDefaultCurrencyConversion(session_key: string) -> CurrencyConversion

Get a default record for the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultExpenseCode

getDefaultExpenseCode(session_key: string) -> ExpenseCodeRecord

Get a default record for the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultExpenseCurrency

getDefaultExpenseCurrency(session_key: string) -> ExpenseCurrencyRecord

Get a default record for the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultExpenseRecord

getDefaultExpenseRecord(session_key: string) -> ExpenseRecord

Get a default record for the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultExpenseSource

getDefaultExpenseSource(session_key: string) -> ExpenseSourceRecord

Get a default record for the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultGroup

getDefaultGroup(session_key: string) -> GroupRecord

Get a default record for the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultMileageMeasurement

getDefaultMileageMeasurement(session_key: string) -> MileageMeasurementRecord

Get a default record for the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultMileageReason

getDefaultMileageReason(session_key: string) -> MileageReasonRecord

Get a default record for the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultMileageRecord

getDefaultMileageRecord(session_key: string) -> MileageRecord

Get a default record for the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultMileageVehicle

getDefaultMileageVehicle(session_key: string) -> MileageVehicleRecord

Get a default record for the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProject

getDefaultProject(session_key: string) -> ProjectRecord

Get a default record for the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProjectApproval

getDefaultProjectApproval(session_key: string) -> ProjectApproval

Get a default record for the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProjectApprovalSetting

getDefaultProjectApprovalSetting(session_key: string) -> ProjectApprovalSetting

Get a default record for the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProjectApprover

getDefaultProjectApprover(session_key: string) -> ProjectApprover

Get a default record for the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProjectCodeRate

getDefaultProjectCodeRate(session_key: string) -> ProjectCodeRate

Get a default record for the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultProjectPickerItem

getDefaultProjectPickerItem(session_key: string) -> ProjectPickerItem

Get a default record for the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPS_DV_Assignments

getDefaultPS_DV_Assignments(session_key: string) -> PS_DV_Assignments

Get a default record for the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPS_DV_Rules

getDefaultPS_DV_Rules(session_key: string) -> PS_DV_Rules

Get a default record for the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPSAccrualOverride

getDefaultPSAccrualOverride(session_key: string) -> PSAccrualOverride

Get a default record for the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPSAccrualTierManager

getDefaultPSAccrualTierManager(session_key: string) -> PSAccrualTierManager

Get a default record for the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPSCompensationTierManager

getDefaultPSCompensationTierManager(session_key: string) -> PSCompensationTierManager

Get a default record for the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPunchRecord

getDefaultPunchRecord(session_key: string) -> PunchRecord

Get a default record for the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultPXTeam

getDefaultPXTeam(session_key: string) -> PXTeamRecord

Get a default record for the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultRateCode

getDefaultRateCode(session_key: string) -> RateCodeRecord

Get a default record for the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultRecord

getDefaultRecord(session_key: string, table_name: string, pname: string) -> Record

This method returns a usable default record suitable for the given table name. The display_name parameter is optional, but if it is supplied, the record will use that name where appropriate, either in the [pretty / display] name or the description (or in the case of user records, as the user ID.) This method raises the ValueError fault if the table_name is not in the list of valid names returned by the getSearchableTables method.

This method may be called by any logged-in user.

getDefaultRequestRecord

getDefaultRequestRecord(session_key: string) -> RequestRecord

Get a default record for the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultSubcode

getDefaultSubcode(session_key: string) -> SubcodeRecord

Get a default record for the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultSubsubcode

getDefaultSubsubcode(session_key: string) -> SubsubcodeRecord

Get a default record for the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultTimeRecord

getDefaultTimeRecord(session_key: string) -> TimeRecord

Get a default record for the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultUser

getDefaultUser(session_key: string) -> UserRecord

Get a default record for the users (User) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultUserRole

getDefaultUserRole(session_key: string) -> UserRole

Get a default record for the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultUserSheetNote

getDefaultUserSheetNote(session_key: string) -> UserSheetNote

Get a default record for the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultVirtualSheetRecord

getDefaultVirtualSheetRecord(session_key: string) -> VirtualSheetRecord

Get a default record for the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDefaultVirtualTimeSheet

getDefaultVirtualTimeSheet(session_key: string) -> VirtualTimeSheet

Get a default record for the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getDefaultRecord method, and is subject to its access restrictions.

getDisplaySettings

getDisplaySettings(session_key: string) -> DisplaySettings

Get settings used for user-facing display and entry of Journyx data.

This method returns a structure containing settings needed to properly present an entry sheet to the current user. It includes, for all three screen types, at least:

• the printable label of the screen type
• the names of the project, code, and comment columns
• the priorities of the project, code, and comment columns (which determine if they should be shown and in what order)
• time_columns and related, which give more info about the columns in the order as seen on the entry screen.
• the default foreign key id (or value, in the case of comments) of the aforementioned columns

The values include local customizations and are based on the time, expense, and mileage entry sheets assigned to the current user.

• @param user: the userID to use (defaults to logged in user if none given)
• @param respectTimekeeperPrefs: if this is set to false, the GUI settings such as column order are based on what the user sees. If True, then we check 'timekeepminetheirs' setting to determine whether to show the original sheet owner's settings or "my" (logged in user) settings
• @param approverView: apply settings appropriate to an Approver's View of the sheet. See comments in wtmod.EntryGUI.translateGuiRecordToOptionsDict
• @return: A DisplaySettings structure.

This method may be called by any logged-in user.

getEnabledExpenseFields

getEnabledExpenseFields(session_key: string) -> string[]

• @return: A list of expense fields.

Returns a list of the supported expense fields for the current user. The return value is a list of strings where each pair is the field name and printable name of a field that is enabled for the current user, in the order those fields appear on the user's expense entry page. (Of the fields described above, only the project, expense_code, currency, source, and comment fields can appear in this list; the rest are mandatory and will not appear in the return from this function.)

This method may be called by any logged-in user.

getEnabledTimeFields

getEnabledTimeFields(session_key: string) -> string[]

• @return: A list of field names, as strings.

Returns a list of the supported time record fields for the current user. The return value is a list of strings where each pair of elements is the field name and printable name of a field that is enabled for the current user, in the order those fields appear on the user's time entry page. (Of the fields described above, the only configurable ones are project, code, subcode, subsubcode, and comment; the others are mandatory and will not be listed in the return from this function.)

This method may be called by any logged-in user.

getEntryNoteById

getEntryNoteById(session_key: string, entrytype: string, entryid: string, separator: string) -> string

• @param entrytype: One of 'time', 'expense', or 'mileage'.

• @param entryid: The ID of the entry to fetch notes for.

• @param separator: A string to insert between notes.

• @return: A string which is the concatenation of all notes for the entry.

Get the text of notes associated with a specific time, expense, or mileage record.

getExpenseCode

getExpenseCode(session_key: string, pattern: ExpenseCodeRecord) -> ExpenseCodeRecord

Get a single record from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseCodeAttributes

getExpenseCodeAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expenses (ExpenseCode) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getExpenseCodeAttributeTypes

getExpenseCodeAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getExpenseCodeById

getExpenseCodeById(session_key: string, id: string) -> ExpenseCodeRecord

Get the record with a specified ID from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseCodes

getExpenseCodes(session_key: string, pattern: ExpenseCodeRecord) -> ExpenseCodeRecord[]

Get multiple records from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseColumnNames

getExpenseColumnNames(session_key: string) -> string[]

• @return: A list of expense column names.

This method returns the printable names of the project, expense code, expense source, currency, and comment columns, in that order, using the settings in the current user's time GUI. If a particular column is disabled, an empty string will be present in the returned list rather than its printable name.

This method may be called by any logged-in user.

getExpenseCurrency

getExpenseCurrency(session_key: string, pattern: ExpenseCurrencyRecord) -> ExpenseCurrencyRecord

Get a single record from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseCurrencyAttributes

getExpenseCurrencyAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_currencies (ExpenseCurrency) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getExpenseCurrencyAttributeTypes

getExpenseCurrencyAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getExpenseCurrencyById

getExpenseCurrencyById(session_key: string, id: string) -> ExpenseCurrencyRecord

Get the record with a specified ID from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseCurrencys

getExpenseCurrencys(session_key: string, pattern: ExpenseCurrencyRecord) -> ExpenseCurrencyRecord[]

Get multiple records from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseMileageConversionRates

getExpenseMileageConversionRates(session_key: string, start_date: string, end_date: string) -> ExpenseMileageConversion[]

Get mileage/expense conversion rates.

This method returns active mileage conversion rates, optionally limiting the result to those active in a date range. Unless the current user is an admin, only conversions applying to visible currencies and codes will be returned.

The start and end date must be in YYYYMMDD format and are optional. If they are specified, only conversions that are or were active at some point within the specified range will be returned.

• @param start_date: The start date in YYYYMMDD format, or an empty string.
• @param end_date: The end date in YYYYMMDD format, or an empty string.
• @return: A list of ExpenseMileageConversion records.

getExpenseRecord

getExpenseRecord(session_key: string, pattern: ExpenseRecord) -> ExpenseRecord

Get a single record from the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseRecordById

getExpenseRecordById(session_key: string, id: string) -> ExpenseRecord

Get the record with a specified ID from the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseRecords

getExpenseRecords(session_key: string, pattern: ExpenseRecord) -> ExpenseRecord[]

Get multiple records from the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseRecordsWithNames

getExpenseRecordsWithNames(session_key: string, pattern: ExpenseRecord) -> ExpenseRecord[]

Get multiple records from the expense_recs (ExpenseRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseRecordWithNames

getExpenseRecordWithNames(session_key: string, pattern: ExpenseRecord) -> ExpenseRecord

Get a single record from the expense_recs (ExpenseRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseSource

getExpenseSource(session_key: string, pattern: ExpenseSourceRecord) -> ExpenseSourceRecord

Get a single record from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseSourceAttributes

getExpenseSourceAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_expense_sources (ExpenseSource) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getExpenseSourceAttributeTypes

getExpenseSourceAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getExpenseSourceById

getExpenseSourceById(session_key: string, id: string) -> ExpenseSourceRecord

Get the record with a specified ID from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getExpenseSources

getExpenseSources(session_key: string, pattern: ExpenseSourceRecord) -> ExpenseSourceRecord[]

Get multiple records from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getGroup

getGroup(session_key: string, pattern: GroupRecord) -> GroupRecord

Get a single record from the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getGroupAttributes

getGroupAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a groups (Group) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getGroupAttributeTypes

getGroupAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getGroupById

getGroupById(session_key: string, id: string) -> GroupRecord

Get the record with a specified ID from the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getGroupMemorizedEntries

getGroupMemorizedEntries(session_key: string, mtype: string, group: string) -> MemorizedEntry[]

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param group: The ID of the group.

• @return: A list of MemorizedEntry structures.

Fetches memorized entries assigned to a group. This method does not return the memorized entries assigned to specific users in the group, just those assigned to the group itself.

This method requires administrator access.

getGroupMemorizedEntriesWithNames

getGroupMemorizedEntriesWithNames(session_key: string, mtype: string, group: string) -> MemorizedEntry[]

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param group: The ID of the group.

• @return: A list of MemorizedEntry structures.

Fetches memorized entries assigned to a group, converting group, project, and code IDs to their corresponding names on the server side. This method does not return the memorized entries assigned to specific users in the group, just those assigned to the group itself.

This method is a superset of the getGroupMemorizedEntries method, and is subject to its access restrictions.

getGroupObjectClasses

getGroupObjectClasses(session_key: string) -> string[]

Returns a complete list of names that are valid to use for the object_class parameter of the above three methods. The list may include synonyms for the same class.

Here is the basic set of names of allowed Group members, not including any aliases:

• users
• roles
• projects
• time_guis
• expense_guis
• mileage_guis
• punch_guis
• tasks
• paytypes
• billtypes
• expenses
• expense_sources
• expense_currencies
• mileage_reasons
• mileage_vehicles
• mileage_measurements

This method may be called by any logged-in user.

getGroups

getGroups(session_key: string, pattern: GroupRecord) -> GroupRecord[]

Get multiple records from the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodes

getHiddenCodes(session_key: string, pattern: CodeRecord) -> CodeRecord[]

Get hidden records from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesCustom4s

getHiddenCodesCustom4s(session_key: string, pattern: CodesCustom4Record) -> CodesCustom4Record[]

Get hidden records from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesCustom5s

getHiddenCodesCustom5s(session_key: string, pattern: CodesCustom5Record) -> CodesCustom5Record[]

Get hidden records from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesCustom6s

getHiddenCodesCustom6s(session_key: string, pattern: CodesCustom6Record) -> CodesCustom6Record[]

Get hidden records from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesCustom7s

getHiddenCodesCustom7s(session_key: string, pattern: CodesCustom7Record) -> CodesCustom7Record[]

Get hidden records from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesExpense4s

getHiddenCodesExpense4s(session_key: string, pattern: CodesExpense4Record) -> CodesExpense4Record[]

Get hidden records from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesExpense5s

getHiddenCodesExpense5s(session_key: string, pattern: CodesExpense5Record) -> CodesExpense5Record[]

Get hidden records from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesExpense6s

getHiddenCodesExpense6s(session_key: string, pattern: CodesExpense6Record) -> CodesExpense6Record[]

Get hidden records from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesExpense7s

getHiddenCodesExpense7s(session_key: string, pattern: CodesExpense7Record) -> CodesExpense7Record[]

Get hidden records from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesTime4s

getHiddenCodesTime4s(session_key: string, pattern: CodesTime4Record) -> CodesTime4Record[]

Get hidden records from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesTime5s

getHiddenCodesTime5s(session_key: string, pattern: CodesTime5Record) -> CodesTime5Record[]

Get hidden records from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesTime6s

getHiddenCodesTime6s(session_key: string, pattern: CodesTime6Record) -> CodesTime6Record[]

Get hidden records from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenCodesTime7s

getHiddenCodesTime7s(session_key: string, pattern: CodesTime7Record) -> CodesTime7Record[]

Get hidden records from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenExpenseCodes

getHiddenExpenseCodes(session_key: string, pattern: ExpenseCodeRecord) -> ExpenseCodeRecord[]

Get hidden records from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenExpenseCurrencys

getHiddenExpenseCurrencys(session_key: string, pattern: ExpenseCurrencyRecord) -> ExpenseCurrencyRecord[]

Get hidden records from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenExpenseSources

getHiddenExpenseSources(session_key: string, pattern: ExpenseSourceRecord) -> ExpenseSourceRecord[]

Get hidden records from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenMileageMeasurements

getHiddenMileageMeasurements(session_key: string, pattern: MileageMeasurementRecord) -> MileageMeasurementRecord[]

Get hidden records from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenMileageReasons

getHiddenMileageReasons(session_key: string, pattern: MileageReasonRecord) -> MileageReasonRecord[]

Get hidden records from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenMileageVehicles

getHiddenMileageVehicles(session_key: string, pattern: MileageVehicleRecord) -> MileageVehicleRecord[]

Get hidden records from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenProjects

getHiddenProjects(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Get hidden records from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenProjectsWithNames

getHiddenProjectsWithNames(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Get hidden records from the projects (Project) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenPXTeams

getHiddenPXTeams(session_key: string, pattern: PXTeamRecord) -> PXTeamRecord[]

Get hidden records from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenSubcodes

getHiddenSubcodes(session_key: string, pattern: SubcodeRecord) -> SubcodeRecord[]

Get hidden records from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenSubsubcodes

getHiddenSubsubcodes(session_key: string, pattern: SubsubcodeRecord) -> SubsubcodeRecord[]

Get hidden records from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenUsers

getHiddenUsers(session_key: string, pattern: UserRecord) -> UserRecord[]

Get hidden records from the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHiddenUsersWithNames

getHiddenUsersWithNames(session_key: string, pattern: UserRecord) -> UserRecord[]

Get hidden records from the users (User) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getHistoricalAttributeObjectTypes

getHistoricalAttributeObjectTypes(session_key: string) -> string[]

Returns a list of strings naming the Object Types (tables) that are legal to use as 'historical' attributes.

Currently these tables are legal:

• time_recs
• expense_recs
• travel_recs

This method may be called by any logged-in user.

getHistoricalAttributeTypes

getHistoricalAttributeTypes(session_key: string, object_type: string) -> string[]

Returns a list of Attribute Type IDs that are currently active as 'historical record attributes' for the given object type across all domains.

If you need to filter the Attribute Type IDs by domain (or any other value) you will have to do it as post-processing to this method, by looking up each Attribute Type ID that is returned and deciding if it should be filtered (based on the domain or other criteria.)

See the general JXAPI documentation for a general explanation of Historical Attributes.

• @param object_type: a valid table name for Historical attribute types (as defined by the method getHistoricalAttributeObjectTypes.) [ Currently this should only be one of: time_recs, expense_recs, travel_recs ]

• @raise RuntimeError: raised if the given object_type is not a valid object-class for Historical Attributes.

This method may be called by any logged-in user.

getJournalsForProject

getJournalsForProject(session_key: string, projectid: string) -> string[]

• @param projectid: The project ID.

• @return: An array of journal IDs.

Get a list of journal IDs associated with a project.

getLatestSheetID

getLatestSheetID(session_key: string, sheet_type: string) -> string

Returns the ID of the most current sheet for the current user.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.

This method may be called by any logged-in user.

getLoggableCodes

getLoggableCodes(session_key: string, pattern: CodeRecord) -> CodeRecord[]

Get loggable records from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesCustom4s

getLoggableCodesCustom4s(session_key: string, pattern: CodesCustom4Record) -> CodesCustom4Record[]

Get loggable records from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesCustom5s

getLoggableCodesCustom5s(session_key: string, pattern: CodesCustom5Record) -> CodesCustom5Record[]

Get loggable records from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesCustom6s

getLoggableCodesCustom6s(session_key: string, pattern: CodesCustom6Record) -> CodesCustom6Record[]

Get loggable records from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesCustom7s

getLoggableCodesCustom7s(session_key: string, pattern: CodesCustom7Record) -> CodesCustom7Record[]

Get loggable records from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesExpense4s

getLoggableCodesExpense4s(session_key: string, pattern: CodesExpense4Record) -> CodesExpense4Record[]

Get loggable records from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesExpense5s

getLoggableCodesExpense5s(session_key: string, pattern: CodesExpense5Record) -> CodesExpense5Record[]

Get loggable records from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesExpense6s

getLoggableCodesExpense6s(session_key: string, pattern: CodesExpense6Record) -> CodesExpense6Record[]

Get loggable records from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesExpense7s

getLoggableCodesExpense7s(session_key: string, pattern: CodesExpense7Record) -> CodesExpense7Record[]

Get loggable records from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesTime4s

getLoggableCodesTime4s(session_key: string, pattern: CodesTime4Record) -> CodesTime4Record[]

Get loggable records from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesTime5s

getLoggableCodesTime5s(session_key: string, pattern: CodesTime5Record) -> CodesTime5Record[]

Get loggable records from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesTime6s

getLoggableCodesTime6s(session_key: string, pattern: CodesTime6Record) -> CodesTime6Record[]

Get loggable records from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableCodesTime7s

getLoggableCodesTime7s(session_key: string, pattern: CodesTime7Record) -> CodesTime7Record[]

Get loggable records from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableExpenseCodes

getLoggableExpenseCodes(session_key: string, pattern: ExpenseCodeRecord) -> ExpenseCodeRecord[]

Get loggable records from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableExpenseCurrencys

getLoggableExpenseCurrencys(session_key: string, pattern: ExpenseCurrencyRecord) -> ExpenseCurrencyRecord[]

Get loggable records from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableExpenseSources

getLoggableExpenseSources(session_key: string, pattern: ExpenseSourceRecord) -> ExpenseSourceRecord[]

Get loggable records from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableMileageMeasurements

getLoggableMileageMeasurements(session_key: string, pattern: MileageMeasurementRecord) -> MileageMeasurementRecord[]

Get loggable records from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableMileageReasons

getLoggableMileageReasons(session_key: string, pattern: MileageReasonRecord) -> MileageReasonRecord[]

Get loggable records from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableMileageVehicles

getLoggableMileageVehicles(session_key: string, pattern: MileageVehicleRecord) -> MileageVehicleRecord[]

Get loggable records from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableProjects

getLoggableProjects(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Get loggable records from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableProjectsWithNames

getLoggableProjectsWithNames(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Warning: not available in all endpoints

Please note that the availability of this method may vary depending on if you access a versioned or unversioned endpoint. The unversioned endpoint typically corresponds to the oldest available versioned endpoint.

This method became available in the 12.1 endpoint.

Get loggable records from the projects (Project) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableSubcodes

getLoggableSubcodes(session_key: string, pattern: SubcodeRecord) -> SubcodeRecord[]

Get loggable records from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getLoggableSubsubcodes

getLoggableSubsubcodes(session_key: string, pattern: SubsubcodeRecord) -> SubsubcodeRecord[]

Get loggable records from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageMeasurement

getMileageMeasurement(session_key: string, pattern: MileageMeasurementRecord) -> MileageMeasurementRecord

Get a single record from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageMeasurementAttributes

getMileageMeasurementAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_travel_measurements (MileageMeasurement) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getMileageMeasurementAttributeTypes

getMileageMeasurementAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getMileageMeasurementById

getMileageMeasurementById(session_key: string, id: string) -> MileageMeasurementRecord

Get the record with a specified ID from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageMeasurements

getMileageMeasurements(session_key: string, pattern: MileageMeasurementRecord) -> MileageMeasurementRecord[]

Get multiple records from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageReason

getMileageReason(session_key: string, pattern: MileageReasonRecord) -> MileageReasonRecord

Get a single record from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageReasonAttributes

getMileageReasonAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_travel_reasons (MileageReason) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getMileageReasonAttributeTypes

getMileageReasonAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getMileageReasonById

getMileageReasonById(session_key: string, id: string) -> MileageReasonRecord

Get the record with a specified ID from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageReasons

getMileageReasons(session_key: string, pattern: MileageReasonRecord) -> MileageReasonRecord[]

Get multiple records from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageRecord

getMileageRecord(session_key: string, pattern: MileageRecord) -> MileageRecord

Get a single record from the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageRecordById

getMileageRecordById(session_key: string, id: string) -> MileageRecord

Get the record with a specified ID from the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageRecords

getMileageRecords(session_key: string, pattern: MileageRecord) -> MileageRecord[]

Get multiple records from the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageRecordsWithNames

getMileageRecordsWithNames(session_key: string, pattern: MileageRecord) -> MileageRecord[]

Get multiple records from the travel_recs (MileageRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageRecordWithNames

getMileageRecordWithNames(session_key: string, pattern: MileageRecord) -> MileageRecord

Get a single record from the travel_recs (MileageRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageVehicle

getMileageVehicle(session_key: string, pattern: MileageVehicleRecord) -> MileageVehicleRecord

Get a single record from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageVehicleAttributes

getMileageVehicleAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_travel_vehicles (MileageVehicle) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getMileageVehicleAttributeTypes

getMileageVehicleAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getMileageVehicleById

getMileageVehicleById(session_key: string, id: string) -> MileageVehicleRecord

Get the record with a specified ID from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMileageVehicles

getMileageVehicles(session_key: string, pattern: MileageVehicleRecord) -> MileageVehicleRecord[]

Get multiple records from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getMobileAppSettings

getMobileAppSettings(session_key: string) -> MobileAppSettings

Return settings intended for use by the Journyx mobile app.

This method is primarily intended for future internal use. Currently the only setting exposed here is whether mobile time submission is enabled.

• @return: A MobileAppSettings structure.

This method may be called by any logged-in user.

getMobileUIType

getMobileUIType(session_key: string) -> string

Returns the current user's mobile UI type.

This is the value of the user's 'Mobile UI Type' attribute, or "Grid" if not defined.

This method may be called by any logged-in user.

getNextSheetID

getNextSheetID(session_key: string, sheet_type: string, id: string) -> string

Returns the ID of the sheet after the one specified by the id parameter.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

This method may be called by any logged-in user.

getNextTimeSheetIDs

getNextTimeSheetIDs(session_key: string, ids: string[]) -> string[]

Returns a list of subsequent timesheet IDs for a list of origination timesheet IDs. They are ordered the same as the ID list to allow for correlation.

This method may be called by any logged-in user.

getNotesForJournal

getNotesForJournal(session_key: string, journalid: string, userid: string, startdate: string, enddate: string) -> NoteRecord[]

• @param journalid: The ID of the journal.

• @param userid: An optional user ID for result filtering, or an empty string for no user restriction.

• @param startdate: An optional start date for result filtering, or an empty string for no date restriction.

• @param enddate: An optional end date for result filtering, or an empty string for no date restriction.

• @return: A list of matching note records.

Get all notes in a journal.

getPeriodDates

getPeriodDates(session_key: string, sheet_type: string, date: string) -> string[]

Returns a list of the dates in the reporting period containing the specified date. Note: This function may create a sheet containing the specified date as a side effect.

The returned dates are formatted according to the server's long date format setting.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param date: the date to check in F8 format (YYYYMMDD)

This method may be called by any logged-in user.

getPeriodDatesISO

getPeriodDatesISO(session_key: string, sheet_type: string, date: string) -> string[]

Returns a list of the dates in the reporting period containing the specified date. Note: This function may create a sheet containing the specified date as a side effect.

The returned dates will be in YYYYMMDD format.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param date: the date to check in F8 format (YYYYMMDD)

This method may be called by any logged-in user.

getPeriodForDate

getPeriodForDate(session_key: string, date: string, full_sheets: boolean) -> Period

Calls getPeriodForDateWithOptions using the default options.

getPeriodForDateWithOptions

getPeriodForDateWithOptions(session_key: string, date: string, full_sheets: boolean) -> Period

Get all sheet information for a specific date.

• @param date: A date within the period.

• @param full_sheets: If true, return full sheet information. If false, do not include row detail.

• @param only_project: See getSheet

• @param respectTimekeeperPrefs: ^

• @param subtotal_order: ^

• @param includeLeave: ^

• @param approverView: ^

• @return: A Period structure.

getPreference

getPreference(session_key: string, key: string) -> string

Get the value of a Journyx setting.

• @param key: The preference key to retrieve.
• @return: The preference value, as a string.

Note that the return from this method is always a string, even if the preference value on the server side is not.

This method may be called by any logged-in user.

getPreferenceValue

getPreferenceValue(session_key: string) -> string

• @param prefDescription: The preference ID or description.

• @return: The preference records, as a list of lists.

• @raise ValueError: If the specified preference is not found.

(This method is not available in typed endpoints.)

Given a preference description or ID, returns a list of the matching preference records. Each preference record is returned as a list of fields.

This method may be called by any logged-in user.

getPreviousSheetID

getPreviousSheetID(session_key: string, sheet_type: string, id: string) -> string

Returns the ID of the sheet before the one specified by the id parameter.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

This method may be called by any logged-in user.

getProject

getProject(session_key: string, pattern: ProjectRecord) -> ProjectRecord

Get a single record from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApproval

getProjectApproval(session_key: string, pattern: ProjectApproval) -> ProjectApproval

Get a single record from the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprovalById

getProjectApprovalById(session_key: string, id: string) -> ProjectApproval

Get the record with a specified ID from the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprovalDetail

getProjectApprovalDetail(session_key: string, sheet_type: string, sheet_id: string, project_id: string) -> Sheet

Return detail about a project approval.

Returns a Sheet object containing detail for a particular project approval entry. Pass the sheet type ("time", "expense", or "mileage"), sheet id, and project id from the ProjectApprovalInfo structure to this method to retrieve the sheet.

If the period contains records not related to the specified project, they may not be present in the sheet returned from this method, depending on server settings; as such the total of the visible rows and the sheet total may not be the same, and this should not be considered an error.

• @param sheet_type: one of 'time', 'expense', or 'mileage'

• @param sheet_id: the sheet ID

• @param project_id: the project ID

• @return: a Sheet data structure

getProjectApprovals

getProjectApprovals(session_key: string, pattern: ProjectApproval) -> ProjectApproval[]

Get multiple records from the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprovalSetting

getProjectApprovalSetting(session_key: string, project_id: string, setting_type: string) -> string

Retrieve a project approval setting for a project.

• @param project_id: The project to retrieve the setting for.
• @param setting_type: The setting to retrieve.
• @return: The setting value, as a string (regardless of its native type).

getProjectApprovalSettingById

getProjectApprovalSettingById(session_key: string, id: string) -> ProjectApprovalSetting

Get the record with a specified ID from the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprovalSettings

getProjectApprovalSettings(session_key: string, pattern: ProjectApprovalSetting) -> ProjectApprovalSetting[]

Get multiple records from the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprover

getProjectApprover(session_key: string, pattern: ProjectApprover) -> ProjectApprover

Get a single record from the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApproverById

getProjectApproverById(session_key: string, id: string) -> ProjectApprover

Get the record with a specified ID from the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectApprovers

getProjectApprovers(session_key: string, project_id: string) -> ProjectApprover[]

Get the approvers for a project.

• @param project_id: The project ID.
• @return: A list of ProjectApprover records.

getProjectApproversByList

getProjectApproversByList(session_key: string, project_id: string, project_ids: string[], all: boolean) -> ProjectApprover[]

Get project approvers for a list of projects.

• @param project_id: Any project ID.
• @param project_ids: The list of projects to get approvers for.
• @param all: If True, return both backup and primary approvers; if False, primary only.
• @return: A list of ProjectApprover records covering all projects in project_ids.

getProjectAttributes

getProjectAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a projects (Project) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getProjectAttributeTypes

getProjectAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getProjectBackupApprovers

getProjectBackupApprovers(session_key: string, project_id: string) -> ProjectApprover[]

Get the backup approvers for a project.

• @param project_id: The project ID.
• @return: A list of ProjectApprover records.

getProjectById

getProjectById(session_key: string, id: string) -> ProjectRecord

Get the record with a specified ID from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectCodeRate

getProjectCodeRate(session_key: string, pattern: ProjectCodeRate) -> ProjectCodeRate

Get a single record from the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectCodeRateById

getProjectCodeRateById(session_key: string, id: string) -> ProjectCodeRate

Get the record with a specified ID from the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectCodeRates

getProjectCodeRates(session_key: string, pattern: ProjectCodeRate) -> ProjectCodeRate[]

Get multiple records from the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectDependencies

getProjectDependencies(session_key: string, project_id: string, code_type: string) -> CodeRecord[]

Lists dependencies of a project.

• @param project_id: The ID of the project to inspect.

• @param code_type: The type of code to list dependencies on.

• @return: a list of codes the project depends on

getProjectDependenciesList

getProjectDependenciesList(session_key: string, project_ids: string[]) -> ProjectDependencies[]

Get a list of dependencies for specific projects.

This method returns project dependencies for the calling user, either for a list of projects specified by ID, or for all of the user's projects if the ID list is empty.

While this potentially represents a lot of data from multiple tables, this method is far more efficient than the old getProjectDependencies method, so you should not use the old method if at all possible.

• @param project_ids: A list of project IDs to get dependencies for.
• @return: A list of ProjectDependencies objects, one per project.

This method may be called by any logged-in user.

getProjectPickerItem

getProjectPickerItem(session_key: string, pattern: ProjectPickerItem) -> ProjectPickerItem

Get a single record from the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectPickerItemById

getProjectPickerItemById(session_key: string, id: string) -> ProjectPickerItem

Get the record with a specified ID from the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectPickerItems

getProjectPickerItems(session_key: string, pattern: ProjectPickerItem) -> ProjectPickerItem[]

Get multiple records from the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjects

getProjects(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Get multiple records from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectsAwaitingMyApproval

getProjectsAwaitingMyApproval(session_key: string, backup: boolean) -> ProjectApprovalInfo[]

Return project approvals awaiting action.

Returns a list of ProjectApprovalInfo structures describing all pending project approvals for the current user. If the parameter is false, returns approvals for which the user is a primary approver, and if true returns those for which the user is a backup approver. Use :py:func:getProjectApprovalDetail to get the detail (hours, attachments, etc.) associated with a project approval.

• @param backup: If true, returns pending backup approvals instead of primary ones.
• @return: A list of project approval entries.

getProjectsWithNames

getProjectsWithNames(session_key: string, pattern: ProjectRecord) -> ProjectRecord[]

Get multiple records from the projects (Project) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getProjectWithNames

getProjectWithNames(session_key: string, pattern: ProjectRecord) -> ProjectRecord

Get a single record from the projects (Project) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_Assignments

getPS_DV_Assignments(session_key: string, pattern: PS_DV_Assignments) -> PS_DV_Assignments

Get a single record from the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_AssignmentsById

getPS_DV_AssignmentsById(session_key: string, id: string) -> PS_DV_Assignments

Get the record with a specified ID from the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_Assignmentss

getPS_DV_Assignmentss(session_key: string, pattern: PS_DV_Assignments) -> PS_DV_Assignments[]

Get multiple records from the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_Rules

getPS_DV_Rules(session_key: string, pattern: PS_DV_Rules) -> PS_DV_Rules

Get a single record from the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_RulesById

getPS_DV_RulesById(session_key: string, id: string) -> PS_DV_Rules

Get the record with a specified ID from the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPS_DV_Ruless

getPS_DV_Ruless(session_key: string, pattern: PS_DV_Rules) -> PS_DV_Rules[]

Get multiple records from the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualOverride

getPSAccrualOverride(session_key: string, pattern: PSAccrualOverride) -> PSAccrualOverride

Get a single record from the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualOverrideById

getPSAccrualOverrideById(session_key: string, id: string) -> PSAccrualOverride

Get the record with a specified ID from the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualOverrides

getPSAccrualOverrides(session_key: string, pattern: PSAccrualOverride) -> PSAccrualOverride[]

Get multiple records from the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualTierManager

getPSAccrualTierManager(session_key: string, pattern: PSAccrualTierManager) -> PSAccrualTierManager

Get a single record from the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualTierManagerById

getPSAccrualTierManagerById(session_key: string, id: string) -> PSAccrualTierManager

Get the record with a specified ID from the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSAccrualTierManagers

getPSAccrualTierManagers(session_key: string, pattern: PSAccrualTierManager) -> PSAccrualTierManager[]

Get multiple records from the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSCompensationTierManager

getPSCompensationTierManager(session_key: string, pattern: PSCompensationTierManager) -> PSCompensationTierManager

Get a single record from the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSCompensationTierManagerById

getPSCompensationTierManagerById(session_key: string, id: string) -> PSCompensationTierManager

Get the record with a specified ID from the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPSCompensationTierManagers

getPSCompensationTierManagers(session_key: string, pattern: PSCompensationTierManager) -> PSCompensationTierManager[]

Get multiple records from the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPunchesForDate

getPunchesForDate(session_key: string, date: string) -> PunchRecord[]

Return the current user's punches for a specific date.

This method returns the current user's punches for the specified date (in YYMMDD format), or today if the date parameter is an empty string. The return list only includes punches which have not been converted to time records, similar to those that appear on the allocation entry grid in the web interface. (For other searches, use the standard table methods for PunchRecords.)

This method may be called by any logged-in user.

getPunchRecord

getPunchRecord(session_key: string, pattern: PunchRecord) -> PunchRecord

Get a single record from the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPunchRecordById

getPunchRecordById(session_key: string, id: string) -> PunchRecord

Get the record with a specified ID from the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPunchRecords

getPunchRecords(session_key: string, pattern: PunchRecord) -> PunchRecord[]

Get multiple records from the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPXTeam

getPXTeam(session_key: string, pattern: PXTeamRecord) -> PXTeamRecord

Get a single record from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPXTeamAttributes

getPXTeamAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a px_teams (PXTeam) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getPXTeamAttributeTypes

getPXTeamAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getPXTeamById

getPXTeamById(session_key: string, id: string) -> PXTeamRecord

Get the record with a specified ID from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getPXTeams

getPXTeams(session_key: string, pattern: PXTeamRecord) -> PXTeamRecord[]

Get multiple records from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRateCode

getRateCode(session_key: string, pattern: RateCodeRecord) -> RateCodeRecord

Get a single record from the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRateCodeById

getRateCodeById(session_key: string, id: string) -> RateCodeRecord

Get the record with a specified ID from the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRateCodes

getRateCodes(session_key: string, pattern: RateCodeRecord) -> RateCodeRecord[]

Get multiple records from the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRateRule

getRateRule(session_key: string, rulename: string) -> RateRule

• @param rulename: The name of the rule to retrieve.

• @return: A RateRule structure describing the rule.

Retrieves a rate rule by name.

This method requires administrator access.

getRateRuleNames

getRateRuleNames(session_key: string) -> string[]

• @return: A list of rule names.

Returns the names of all defined rate rules.

This method requires administrator access.

getRecentColumnRecords

getRecentColumnRecords(session_key: string, num_periods: int, loggableOnly: boolean) -> AllColumnRecords

Returns all recently used project and code records.

This method is intended as a single round trip way to fetch relevant project and code information, without the transfer overhead of getAllColumnRecords in cases where there may be a lot of items that the user isn't actively interested in (old projects and the like).

Unlike getAllColumnRecords which returns all viewable records, this one returns only projects which have recently had time/expense/custom records booked against them (for a value of 'recent' in periods specified by the first parameter, plus the user's memorized entries) and returns only those projects and the code records that are part of their dependencies.

Note: This method is only supported in the WS-I endpoint for .NET. It may or may not work in others.

This method may be called by any logged-in user.

getRecentProjectDependencies

getRecentProjectDependencies(session_key: string, num_periods: int, loggableOnly: boolean) -> ProjectDependencies[]

Returns dependencies for recently used projects.

This method is similar to getAllProjectDependencies but instead of returning dependencies for all projects, it limits the selection of projects to those which are either used in a memorized entry, or which have been used in num_periods past periods. This is intended to lighten the processing load on the client when there are many projects.

Note: This method is supported only in WS-I endpoints (jxapi_wsi, jxapi_wsi_j, or >= 9.6 API type "wsi") and untyped endpoints and may not work in others.

• @param num_periods: Number of periods to look at, including the most recent one.

• @param loggableOnly: True if only loggable projects should be returned.

• @return: A list of ProjectDependencies records.

This method may be called by any logged-in user.

getRecentSheetIDsForUser

getRecentSheetIDsForUser(session_key: string, sheet_type: string, user_id: string, num_sheets: int) -> string[]

Returns the IDs of recent sheets for a specific user, subject to the permissions of the session.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param user_id: The ID of the user to return sheet IDs for.
• @param num_sheets: The maximum number of recent sheet IDs to return.
• @param state: either 'all' or 'open', 'submitted', 'approved', 'rejected'
  • filter on the sheet state. Default is 'all'

This method may be called by any logged-in user.

getRecentSheetStatus

getRecentSheetStatus(session_key: string, sheet_type: string, num: int) -> string[]

Returns a list of number recent sheet IDs and their associated statuses, beginning with the most recent sheet and going backwards in time. The return value is a list of strings, each of which contains five comma-delimited fields: the sheet ID, the start and end dates of the sheet, the status, and the reason (if any) associated with the sheet.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param num: (default: 8) - number of 'recent' sheets to return.

This method may be called by any logged-in user.

getRecordIDsInSheet

getRecordIDsInSheet(session_key: string, sheet_type: string, id: string) -> string[]

Returns a list of the IDs of all time records associated with the specified sheet.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

This method may be called by any logged-in user.

getRecordsForSheet

getRecordsForSheet(session_key: string, sheet_type: string, sheet_id: string, time_in_seconds: int) -> Record[]

Given a string sheet type and ID, this returns a list of all records associated with that sheet.

For example, if the sheet_type is 'time', then all the time records that belong to that sheet will be returned. The format of the Time, Expense, and Mileage records is documented separately in the jxAPI specification. The strings time, expense, and mileage are supported for the sheet_type.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.

• @param sheet_id: The ID of the sheet to examine.

• @param time_in_seconds: If 0, time values are returned as fractional hours; if 1, they are returned as integer seconds.

• @return: A list of TimeRecord, ExpenseRecord, or MileageRecord

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have one of the following group-scoped abilities over the user: 'Authority - Manager' 'Authority - Timekeeper' 'Authority - Expensekeeper' 'Authority - Mileagekeeper'

getRecordsList

getRecordsList(session_key: string, table_name: string, pattern: Record, withNames: boolean, only_hidden: boolean, show_active: boolean, show_inactive: boolean, activity_date: string, loggableOnly: boolean) -> Record[]

Retrieve records from the Journyx database.

• @param table_name: The name of the table to retrieve records from.
• @param pattern: A pattern record to match.
• @param withNames: If true, perform ID to name conversion if available for this type.
• @param only_hidden: If true, return hidden records instead of visible ones (if supported by the table).
• @param show_active: If true, return active records (if supported by the table).
• @param show_inactive: If true, return inactive records (if supported by the table).
• @param activity_date: If true, return records active since the specified date (if supported by the table).
• @param loggableOnly: If true, return only loggable records (if supported by the table).
• @param countOnly: If true, return a count of matching records instead of a list of records (untyped endpoints only).
• @return: A list of records.

This method is the general interface to all retrieval of records from the Journyx database. At minimum, you must pass a table name and pattern record; the latter may be empty to retrieve the entire table. Pattern matching is currently by simple equality only.

If withNames is True and the table supports ID to name conversion, some fields will contain the pretty name of a foreign record reference rather than its ID.

For untyped endpoints only, you can set the countOnly parameter to True to get a count of records instead of a full list.

The rest of the parameters control various filtering options that are not able to be expressed as part of a pattern record. Whether they do anything is dependent on the semantics of the table and its contents; see the type reference for more detail.

In typed endpoints, note that the returned records will actually be of the type corresponding to the table you are getting records from, eg. ProjectRecord for records from the "projects" table.

This method may be called by any logged-in user.

getRecordsListWithDictString

getRecordsListWithDictString(session_key: string, table_name: string, dict_string: string) -> Record[]

This method takes two parameters, and is used to do generic searches on any of the supported tables. It returns lists of Records whose format depends on the table searched. For instance, if the table_name parameter is "users" then the return value will be a list of UserRecords.

table_name must be in the list of supported names returned by getSearchableTables(), or a ValueError exception is raised.

dict_string must be a string which, when passed to eval(), produces a search dictionary that will be passed to the get() method of the appropriate table object. A sample value for the users table might be::

"{'id_user':('IN', ['andrew','dylan'])}"

This method was created to provide an alternative to getRecordsList(), which doesn't support LIKE, IN, or other advanced clauses. This made the retrieval of multiple record painful.

NOTE: The results of this method are subject to normal group membership "viewability" checks.

NOTE: Instead of regular eval(), this uses ast.literal_eval() which is a safer version that only allows primitive values.

This method may be called by any logged-in user.

getRecordStructure

getRecordStructure(session_key: string, table_name: string) -> RecordStructureElement[]

Describes the contents of a table's records. The return values are RecordStructureElement structures, each of which has the members "name" and "type", both strings. The type can be one of "integer", "float", "boolean", or "string".

• @param table_name: The name of the table to describe.

• @return: a list of structures describing each field in the table

This method may be called by any logged-in user.

getRequestRecord

getRequestRecord(session_key: string, pattern: RequestRecord) -> RequestRecord

Get a single record from the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRequestRecordById

getRequestRecordById(session_key: string, id: string) -> RequestRecord

Get the record with a specified ID from the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRequestRecords

getRequestRecords(session_key: string, pattern: RequestRecord) -> RequestRecord[]

Get multiple records from the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getRuleSet

getRuleSet(session_key: string, setname: string) -> RuleSet

• @param setname: The name of the policy to retrieve.

• @return: A RuleSet structure describing the policy.

Retrieves an existing policy.

This method requires administrator access.

getRuleSetNames

getRuleSetNames(session_key: string) -> string[]

• @return: A list of policy names.

Returns the names of all defined policies.

This method requires administrator access.

getSearchableTables

getSearchableTables(session_key: string) -> string[]

Returns a list of table names that are valid as parameters to other methods below that require a table name as an argument. If any method described elsewhere lists table_name as a parameter, then the table must be in the list returned by this method (unless otherwise noted) or the method will raise an exception.

This method may be called by any logged-in user.

getSheet

getSheet(session_key: string, sheet_type: string, sheet_id: string) -> Sheet

Get an entire sheet.

This method returns a complete sheet as a single data structure, organized similarly to how it would appear on a standard entry screen. (Rows for each project/codes combo, cells with total hours/miles/expense, etc.) Most of this information is also available piecemeal from other jxAPI methods, but this one combines it all for easy access.

• @param sheet_type: the sheet type, 'time', 'expense', or 'mileage'.

• @param sheet_id: the sheet ID.

• @param only_project: limit the sheet to records matching the given project ID (for Project Approvals views.)

• @param respectTimekeeperPrefs: if this is set to false, the GUI settings such as column order are based on what the user sees. If True, then we check 'timekeepminetheirs' setting to determine whether to show the original sheet owner's settings or "my" (logged in user) settings

• @param subtotal_order: specify a different column order for subtotalling purposes. If not given, the order defaults to the sheet's column order which is fine for most uses.

• @param includeLeave: set to True to have a 'leave_and_holidays' key returned in the response with a list of unrealized/unsaved holidays and leave requests. Off by default because of the extra overhead...

• @param approverView: apply settings appropriate to an Approver's View of the sheet. Note: this does NOT automatically load the approver's entry screen settings. Mainly it relates to whether the "Basic Time User" restrictions should be enforced on which columns are visible. See comments in jxo.users.getGuiSettings Also, in approver view, recent_entries ("lookback") is disabled because it's not shown, also we don't set certain flags like is_suggestion_engine_available

• @return: a Sheet data structure.

getSheetAuditSettings

getSheetAuditSettings(session_key: string, sheet_type: string, sheet_id: string) -> SheetAuditSettings

Returns an object describing the Audit Settings relevant to this user entry sheet.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param sheet_id: Sheet ID.
• @return: A SheetAuditSettings instance.

This method may be called by any logged-in user.

getSheetByDate

getSheetByDate(session_key: string, sheet_type: string, date: string) -> Sheet

See getSheet() Params are the same except instead of a sheetID, you pass in a date in YYYYMMDD format.

getSheetIDByDate

getSheetIDByDate(session_key: string, sheet_type: string, date: string) -> string

Returns the ID of a sheet covering the specified date (for the current user).

This method may be called by any logged-in user.

getSheetReason

getSheetReason(session_key: string, sheet_type: string, id: string) -> string

Returns a string describing why a sheet was rejected. If the specified timesheet has not, in fact, been rejected the return value will be an empty string.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have one of the following group-scoped abilities over the user: 'Authority - Manager' 'Authority - Timekeeper' 'Authority - Expensekeeper' 'Authority - Mileagekeeper'

getSheetRejectedStatuses

getSheetRejectedStatuses(session_key: string, sheet_type: string) -> string[]

Returns a list of possible statuses for a rejected sheet. The return value is a list of strings that can be compared against the sheet status to determine if it has been rejected. (At the present time, the sole member of this list will be the string "Rejected", but this function is provided because that may change in the future, or in localized versions of the Journyx server.)

• @param sheet_type: One of 'time', 'expense', or 'mileage'.

This method may be called by any logged-in user.

getSheets

getSheets(session_key: string, sheet_ids: string[]) -> SheetObject[]

Returns information about one or more sheets.

• @param sheet_ids: A list of sheet IDs to retrieve.

• @return: A list of SheetObject records describing the requested sheets.

IDs that do not match an existing sheet will be silently ignored.

This method may be called by any logged-in user.

getSheetsAwaitingMyApproval

getSheetsAwaitingMyApproval(session_key: string, sheet_type: string, group: boolean) -> SheetInfo[]

Get sheets awaiting approval by the current user.

• @param sheet_type: One of 'time', 'expense', or 'mileage'

• @param group: if True (default: False) return those awaiting Group Approval.

• @return: A list of Sheet objects.

getSheetStatus

getSheetStatus(session_key: string, sheet_type: string, id: string) -> string

Returns the status of the specified sheet. The return value is a printable string such as "Approved" or "Rejected".

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

This method may be called by any logged-in user.

getSubcode

getSubcode(session_key: string, pattern: SubcodeRecord) -> SubcodeRecord

Get a single record from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getSubcodeAttributes

getSubcodeAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_pay_types (Subcode) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getSubcodeAttributeTypes

getSubcodeAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getSubcodeById

getSubcodeById(session_key: string, id: string) -> SubcodeRecord

Get the record with a specified ID from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getSubcodes

getSubcodes(session_key: string, pattern: SubcodeRecord) -> SubcodeRecord[]

Get multiple records from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getSubsubcode

getSubsubcode(session_key: string, pattern: SubsubcodeRecord) -> SubsubcodeRecord

Get a single record from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getSubsubcodeAttributes

getSubsubcodeAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a codes_bill_types (Subsubcode) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getSubsubcodeAttributeTypes

getSubsubcodeAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getSubsubcodeById

getSubsubcodeById(session_key: string, id: string) -> SubsubcodeRecord

Get the record with a specified ID from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getSubsubcodes

getSubsubcodes(session_key: string, pattern: SubsubcodeRecord) -> SubsubcodeRecord[]

Get multiple records from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeColumnNames

getTimeColumnNames(session_key: string) -> string[]

• @return: A list of time column names.

This method returns the printable names of the project, task (code), pay type (subcode), bill type (subsubcode), and comment columns, in that order, using the settings in the current user's time GUI. If a particular column is disabled, an empty string will be present in the returned list rather than its printable name.

This method may be called by any logged-in user.

getTimeRecord

getTimeRecord(session_key: string, pattern: TimeRecord) -> TimeRecord

Get a single record from the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeRecordById

getTimeRecordById(session_key: string, id: string) -> TimeRecord

Get the record with a specified ID from the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeRecords

getTimeRecords(session_key: string, pattern: TimeRecord) -> TimeRecord[]

Get multiple records from the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeRecordsWithNames

getTimeRecordsWithNames(session_key: string, pattern: TimeRecord) -> TimeRecord[]

Get multiple records from the time_recs (TimeRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeRecordWithNames

getTimeRecordWithNames(session_key: string, pattern: TimeRecord) -> TimeRecord

Get a single record from the time_recs (TimeRecord) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getTimeSheetIDsByDateAndUsers

getTimeSheetIDsByDateAndUsers(session_key: string, date: string, userIds: string[]) -> string[]

Return a list of sheet IDs for the given date. This list will be of the same length as the list of user IDs passed in, and will be ordered identically in order to allow for correlation back to your user list.

Sheets are created if they do not exist.

This method may be called by any logged-in user.

getTimeSheetStatuses

getTimeSheetStatuses(session_key: string, ids: string[]) -> string[]

Returns a list of status strings for a list of provided timesheet IDs. They are ordered the same as the ID list to allow for correlation. Values are printable strings like "Approved" or "Rejected".

This method may be called by any logged-in user.

getTotalHoursInTimeSheet

getTotalHoursInTimeSheet(session_key: string, id: string) -> double

Returns the total hours reported in the specified timesheet.

This method may be called by any logged-in user.

getTotalHoursInTimeSheets

getTotalHoursInTimeSheets(session_key: string, ids: string[]) -> double[]

Returns a list of hour totals for a list of provided timesheet IDs. They are ordered the same as the ID list to allow for correlation.

This method may be called by any logged-in user.

getUser

getUser(session_key: string, pattern: UserRecord) -> UserRecord

Get a single record from the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserAbilities

getUserAbilities(session_key: string, userid: string) -> string[]

Returns a user's list of abilities.

Each ability is a string representing one permission capability inside Journyx. These differ from roles in that abilities are the actual permissions granted, while a role is a set of abilities grouped together for easier management.

Passing an empty userid returns the abilities for the current user.

While there are many abilities, some useful ones to check for may include:

• 'admin' - full admin access to Journyx and all jxAPI methods
• 'approver' - can approve submitted sheets (depending on approval plans)
• 'Access - Time Entry', 'Access - Expense Entry', 'Access - Mileage Entry' - access to the three main entry screens
• 'punchuser' - defaults to the punch in/out screen

Note that to check abilities for any user other than yourself, you must have write access (admin, manager, time/expense/mileage keeper) over that user.

• @param userid: The ID (not the login!) of the user to check.

• @return: A list of ability tokens, as strings.

getUserAccruals

getUserAccruals(session_key: string, user: string) -> AccrualRecord[]

• @param user: The ID of the user.

• @return: A list of AccrualRecord structures.

Fetches a user's accruals.

Note: This method is deprecated with the changes to accruals in 10.1; use getAccruals et. al. instead to access the full accrual records. This is true if your server is running 10.1 even if you request an older API version.

This method requires administrator access.

getUserAttributes

getUserAttributes(session_key: string, id: string) -> AttributeQueryResult[]

Get all attributes for a users (User) record.

See coredb for more information about this method.

This method is a superset of the queryAttributes method, and is subject to its access restrictions.

getUserAttributeTypes

getUserAttributeTypes(session_key: string) -> AttributeTypeRecord[]

Get all attribute types for the users (User) table.

See coredb for more information about this method.

This method is a superset of the queryAttributeTypes method, and is subject to its access restrictions.

getUserById

getUserById(session_key: string, id: string) -> UserRecord

Get the record with a specified ID from the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserDetails

getUserDetails(session_key: string, userIdOrLogin: string) -> UserDetails

Return a data structure with basic details about a user, defaulting to the current user.

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

• @param userIdOrLogin: optional - look up a user by their internal database ID or their login. If not given, defaults to the current jxAPI session user. If looking up details for a different user, you must have manager or admin authority over that user.
• @return: a UserDetails structure with details about the user.

getUserMemorizedEntries

getUserMemorizedEntries(session_key: string, mtype: string, user: string) -> MemorizedEntry[]

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage')

• @param user: The ID of the user.

• @return: A list of MemorizedEntry structures.

Fetches a user's memorized entries. Entries assigned to the groups the user is in are not returned, only those assigned specifically to the user.

This method requires administrator access, unless the user specified by the "user" parameter is the current user.

getUserMemorizedEntriesWithNames

getUserMemorizedEntriesWithNames(session_key: string, mtype: string, user: string) -> MemorizedEntry[]

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage')

• @param user: The ID of the user.

• @return: A list of MemorizedEntry structures.

Fetches a user's memorized entries, converting group, project, and code IDs to their corresponding names if available. Entries assigned to groups the user is in are not returned, only those assigned specifically to the user.

This method is a superset of the getUserMemorizedEntries method, and is subject to its access restrictions.

getUserPermissions

getUserPermissions(session_key: string, user: string) -> string[]

• @param user: The ID of the user.

• @return: A list of strings.

Returns a list of modules which the user is permitted to access. Currently the possible values are 'time' and 'expense' to indicate that the user is allowed to report time and/or expenses.

This method may be called by any logged-in user.

getUserRole

getUserRole(session_key: string, pattern: UserRole) -> UserRole

Get a single record from the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserRoleById

getUserRoleById(session_key: string, id: string) -> UserRole

Get the record with a specified ID from the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserRoles

getUserRoles(session_key: string, user: string) -> string[]

• @param user: The ID of the user.

• @return: A list of role names, as strings.

Returns a list of roles assigned to a user, which must be specified by its ID (not login).

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have one of the following group-scoped abilities over the user:

• 'Authority - Manager'
• 'Authority - Timekeeper'
• 'Authority - Expensekeeper'
• 'Authority - Mileagekeeper'

getUsers

getUsers(session_key: string, pattern: UserRecord) -> UserRecord[]

Get multiple records from the users (User) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUsersByActiveStatus

getUsersByActiveStatus(session_key: string, pattern: UserRecord, show_active: boolean, show_inactive: boolean, activity_date: string, withNames: boolean, hidden: boolean) -> UserRecord[]

• @param pattern: A pattern to restrict the user search by.
• @param activity_date: An empty string to get all inactive users, or a YYMMDD date to get inactive users since that date.
• @param show_active: If true, includes active users in the result set.
• @param show_inactive: If true, includes inactive users in the result set.
• @param withNames: If true, name to ID conversion will be performed.
• @param hidden: If false, returns non-hidden users; if true, returns hidden users.

This method incorporates all of the functionality of getUsers, getUsersWithNames, and getHiddenUsers (when the appropriate flags are set), and additionally allows retrieval of inactive users (which are not shown by default in other record retrieval methods) either alone or in combination with active users.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserSheetNote

getUserSheetNote(session_key: string, pattern: UserSheetNote) -> UserSheetNote

Get a single record from the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserSheetNoteById

getUserSheetNoteById(session_key: string, id: string) -> UserSheetNote

Get the record with a specified ID from the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserSheetNotes

getUserSheetNotes(session_key: string, pattern: UserSheetNote) -> UserSheetNote[]

Get multiple records from the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUsersWithNames

getUsersWithNames(session_key: string, pattern: UserRecord) -> UserRecord[]

Get multiple records from the users (User) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getUserWithNames

getUserWithNames(session_key: string, pattern: UserRecord) -> UserRecord

Get a single record from the users (User) table, converting IDs to names.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualSheetRecord

getVirtualSheetRecord(session_key: string, pattern: VirtualSheetRecord) -> VirtualSheetRecord

Get a single record from the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualSheetRecordById

getVirtualSheetRecordById(session_key: string, id: string) -> VirtualSheetRecord

Get the record with a specified ID from the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualSheetRecords

getVirtualSheetRecords(session_key: string, pattern: VirtualSheetRecord) -> VirtualSheetRecord[]

Get multiple records from the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualTimeSheet

getVirtualTimeSheet(session_key: string, pattern: VirtualTimeSheet) -> VirtualTimeSheet

Get a single record from the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualTimeSheetById

getVirtualTimeSheetById(session_key: string, id: string) -> VirtualTimeSheet

Get the record with a specified ID from the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

getVirtualTimeSheets

getVirtualTimeSheets(session_key: string, pattern: VirtualTimeSheet) -> VirtualTimeSheet[]

Get multiple records from the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

hide_suggestion

hide_suggestion(session_key: string, id_suggestion: int) -> SuggestionRecord

Hide a suggestion (without deleting it).

• @param id_suggestion: The ID of the suggestion to hide.
• @return: The (now hidden) SuggestionRecord object.

This method may be called by any logged-in user.

hide_suggestion_series

hide_suggestion_series(session_key: string, id_suggestion_list: int[]) -> boolean

Hides multiple suggestion series.

Note that this method takes suggestion IDs, not series IDs. By passing it the ID of a suggestion in a series, it will hide all future events in that series, if any.

• @param id_suggestion_list: A list of suggestion IDs in the series to hide.
• @return: Always True if no exception is thrown.

This method may be called by any logged-in user.

hide_suggestions

hide_suggestions(session_key: string, id_suggestion_list: int[]) -> SuggestionRecord[]

Hide multiple suggestions (without deleting them).

• @param id_suggestion_list: A list of IDs of the suggestions to hide.
• @return: A list of the (now hidden) SuggestionRecord objects.

This method may be called by any logged-in user.

hideCode

hideCode(session_key: string, id: string) -> int

Hide a record in the codes_tasks (Code) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesCustom4

hideCodesCustom4(session_key: string, id: string) -> int

Hide a record in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesCustom5

hideCodesCustom5(session_key: string, id: string) -> int

Hide a record in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesCustom6

hideCodesCustom6(session_key: string, id: string) -> int

Hide a record in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesCustom7

hideCodesCustom7(session_key: string, id: string) -> int

Hide a record in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesExpense4

hideCodesExpense4(session_key: string, id: string) -> int

Hide a record in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesExpense5

hideCodesExpense5(session_key: string, id: string) -> int

Hide a record in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesExpense6

hideCodesExpense6(session_key: string, id: string) -> int

Hide a record in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesExpense7

hideCodesExpense7(session_key: string, id: string) -> int

Hide a record in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesTime4

hideCodesTime4(session_key: string, id: string) -> int

Hide a record in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesTime5

hideCodesTime5(session_key: string, id: string) -> int

Hide a record in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesTime6

hideCodesTime6(session_key: string, id: string) -> int

Hide a record in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method requires administrator access.

hideCodesTime7

hideCodesTime7(session_key: string, id: string) -> int

Hide a record in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method requires administrator access.

hideExpenseCode

hideExpenseCode(session_key: string, id: string) -> int

Hide a record in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method requires administrator access.

hideExpenseCurrency

hideExpenseCurrency(session_key: string, id: string) -> int

Hide a record in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method requires administrator access.

hideExpenseSource

hideExpenseSource(session_key: string, id: string) -> int

Hide a record in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method requires administrator access.

hideMileageMeasurement

hideMileageMeasurement(session_key: string, id: string) -> int

Hide a record in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method requires administrator access.

hideMileageReason

hideMileageReason(session_key: string, id: string) -> int

Hide a record in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method requires administrator access.

hideMileageVehicle

hideMileageVehicle(session_key: string, id: string) -> int

Hide a record in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method requires administrator access.

hideProject

hideProject(session_key: string, id: string) -> int

Hide a record in the projects (Project) table.

See coredb for more information about this method.

This method requires administrator access.

hidePXTeam

hidePXTeam(session_key: string, id: string) -> int

Hide a record in the px_teams (PXTeam) table.

See coredb for more information about this method.

This method requires administrator access.

hideSubcode

hideSubcode(session_key: string, id: string) -> int

Hide a record in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method requires administrator access.

hideSubsubcode

hideSubsubcode(session_key: string, id: string) -> int

Hide a record in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method requires administrator access.

hideUser

hideUser(session_key: string, id: string) -> int

Hide a record in the users (User) table.

See coredb for more information about this method.

This method requires administrator access.

hostname

hostname(session_key: string) -> string

Returns the hostname of the server.

This method may be called by any logged-in user.

importData

importData(session_key: string, module_name: string, data: string) -> ImportResults

Import data into a table using standard Journyx imports.

This method takes the printable name of an importer (eg. "Users") and the content to be imported as a string, and performs the import of that data. The return value is an ImportResults object containing the error, warning, and message strings returned by the importer.

The calling user must have permission to use the selected importer.

• @param module_name: The name of the import module to use.
• @param data: The data to import, as a single string.

This method requires any one of the following abilities: "admin", "msp_admin", "qb_admin"

importFile

importFile(session_key: string, module_name: string, filename: string) -> ImportResults

Import a file into a table using standard Journyx imports.

This method takes the printable name of an importer (eg. "Users") and the name of a server-side file, and performs the import of that file. The return value is an ImportResults object containing the error, warning, and message strings returned by the importer.

The calling user must have permission to use the selected importer.

This method uses the default character set and unknown character policy set by the server and user preferences. To specify a character set and/or policy, see importFileWithEncoding.

• @param module_name: The import module name to use.
• @param filename: The name of a server-side file to import.

This method requires any one of the following abilities: "admin", "msp_admin", "qb_admin"

importFileWithEncoding

importFileWithEncoding(session_key: string, module_name: string, filename: string, charset: string, charset_policy: string) -> ImportResults

Import a file into a table using standard Journyx imports, specifying a character encoding.

This method takes the printable name of an importer (eg. "Users") and the name of a server-side file, and performs the import of that file. The return value is an ImportResults object containing the error, warning, and message strings returned by the importer.

The calling user must have permission to use the selected importer.

• @param module_name: The import module name to use.
• @param filename: The name of a server-side file to import.
• @param charset: The character encoding of the file.
• @param charset_policy: The unknown character policy: 'strict', 'ignore', or 'replace'.

This method requires any one of the following abilities: "admin", "msp_admin", "qb_admin"

installDate

installDate(session_key: string) -> string

Returns the date on which the server software was installed, as a printable string.

This method may be called by any logged-in user.

is_exchange_only_available_suggestion_source

is_exchange_only_available_suggestion_source(session_key: string) -> boolean

Check whether Exchange is the only available suggestion source. If there are any other sources or Exchange is not set up, this will return false.

• @return: True if Exchange is the only suggestion source.

This method may be called by any logged-in user.

is_suggestion_engine_available

is_suggestion_engine_available(session_key: string) -> boolean

Check whether the suggestion engine is enabled and configured.

• @return: True if the suggestion engine is available.

This method may be called by any logged-in user.

isProjectApprovalActive

isProjectApprovalActive(session_key: string, project_id: string) -> boolean

Check if project approval is active for a project.

• @param project_id: The project ID to check.
• @return: True if approvals are active for this project, False otherwise.

isProjectApprovalCompleteForLevel

isProjectApprovalCompleteForLevel(session_key: string, level: double, sheet_id: string) -> boolean

Check whether a sheet is project approved at a particular level.

• @param level: The level to check approval for.
• @param sheet_id: The sheet ID.
• @return: True if the sheet is project approved at this level, False otherwise.

isProjectApprovalCompleteForLevelAndSheet

isProjectApprovalCompleteForLevelAndSheet(session_key: string, level: double, sheet_id: string) -> boolean

Check whether a sheet is project approved at a particular level, as well as period approved.

• @param level: The project approval level to check for.
• @param sheet_id: The sheet ID.
• @return: True if the sheet is both period approved and project approved at this level, False otherwise.

isProjectApprovalIntegrated

isProjectApprovalIntegrated(session_key: string, project_id: string) -> boolean

Check whether project approval support is integrated or independent.

• @param project_id: A valid project ID.
• @return: Boolean true if using integrated project approvals, false if using independent ones.

This method may be called by any logged-in user.

isProjectApproved

isProjectApproved(session_key: string, sheet_id: string) -> boolean

Check whether a sheet is project approved.

• @param sheet_id: The sheet ID.
• @return: True if the sheet is project approved, False otherwise.

isPXEnabled

isPXEnabled(session_key: string) -> boolean

Returns a boolean flag indicating whether Journyx PX features are enabled.

This method may be called by any logged-in user.

licensedHost

licensedHost(session_key: string) -> string

Returns the hostname specified in the server license.

This method may be called by any logged-in user.

licensedUsers

licensedUsers(session_key: string) -> int

Returns the number of users allowed by the server license, as a printable string. This is the maximum number of licensed users for the whole site, and does not reflect any domain-specific restrictions. If an unlimited number of users are licensed, this method will return -1 (negative one.)

This method may be called by any logged-in user.

listGroupObjects

listGroupObjects(session_key: string, group_id_name: string, object_class: string) -> string[]

Lists all IDs of the members of a group that are of a specified type.

• @param group_id_name: The ID or printable name of the group.

• @param object_class: The name of the 'class' (or table) of the objects to search for.

• @return: a list of IDs of matching objects

• @raise ValueError: if the group ID/name does not uniquely identify a group

This method requires administrator access.

listObjectGroups

listObjectGroups(session_key: string, object_class: string, object_id: string) -> string[]

Returns a list of all groups an object is a member of.

• @param object_class: The class of the object to query, for example 'users'.
• @param object_id: The ID of the object to query.
• @return: a list of the IDs of the groups the object belongs to
• @raise ValueError: if the specified object class is not a valid one for group membership

NOTE: You must have the 'Authority - Administrator' role ability to perform this action.

This method requires administrator access.

login

login(username: string, password: string, keep_old_sessions: int) -> string

• @param username: The login ID of the user to log in as.

• @param password: The user's password.

• @param keep_old_sessions: If false all existing sessions for this user will be deleted. (unless the system gdef CONCURRENTSESSIONS=yes)

• @param is_gui: if True, skip the terms of use check

• set this when the login request is coming from the web UI

• we want them to sign in before accepting terms.

• @return: The session key.

• @raise RuntimeError: If the login fails.

Creates a new session allowing access to the jxAPI with the rights of the specified user, returning a session key which must be passed back to the jxAPI on all method calls (except those which explicitly do not require a login).

While some endpoints may pass the session key back to the jxAPI in different ways, with each call, normally it is added as the first parameter to each method call, before that call's defined parameters, if any.

The login attempt may fail and raise an exception in several ways:

• the login ID is not found, or the password is incorrect
• the user's domain license has expired and all users in that domain are locked out
• the user's password has expired and needs to be changed (the changeUserPassword method can be used to do this through the jxAPI)

If the login fails the exception detail will include an appropriate message describing the problem.

Note that in most cases the keep_old_sessions parameter should be false (zero), to cause all other sessions for this user (including GUI logins) to be invalidated upon a successful login, as the interaction of multiple simultaneous sessions may produce unexpected results and must be carefully managed by the client. Please consult with Journyx before enabling keep_old_sessions in a production environment.

This method does not require a login session, and may be called by any client.

logout

logout(session_key: string) -> int

• @return: 0

Invalidates this login session.

This method may be called by any logged-in user.

longDateFormat

longDateFormat(session_key: string) -> string

Returns a string identifying the long date display format used by the server:

• "LONG1" : Weekday, Month dd, yyyy
• "LONG2" : Month dd, yyyy
• "LONG3" : Weekday, dd Month, yyyy
• "LONG4" : dd Month, yyyy

Note that this affects the way dates are displayed in the UI only; dates passed in records or to other jxAPI methods are always YYYYMMDD unless specified otherwise.

This method may be called by any logged-in user.

makeAttributeTypeAsHistorical

makeAttributeTypeAsHistorical(session_key: string, object_type: string, id_attr_type: string) -> int

This method makes an Attribute Type (indicated by the second parameter) 'historical' for the object_type (either time, expense, or travel/mileage.) None is normally returned.

See the general JXAPI documentation for a general explanation of Historical Attributes.

• @param object_type: must be one of these: [ time_recs, expense_recs, travel_recs ]

• @param id_attr_type: the ID of an Attribute Type

• @return: 0 if successful.

• @raise ValueError: If object_type is not in the allowed list

• @raise ValueError: If id_attr_type is not a valid Attribute Type

• @raise RuntimeError: If id_attr_type is already historical for this object_type

This method requires administrator access.

modify_approval_plan

modify_approval_plan(session_key: string, sheet_type: string, planid: string, plan: ApprovalObject) -> boolean

Modifies an approval plan.

Note that certain fields in the ApprovalObject passed to this method cannot be modified, including type, id, bizid, and apprtype.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param planid: The plan ID.
• @param plan: The modified plan.
• @return: True if no exception occurred.

modifyAccessControlList

modifyAccessControlList(session_key: string, id: string, record: AccessControlList) -> int

Modify an existing record in the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAccessControlLists

modifyAccessControlLists(session_key: string, records: AccessControlList[]) -> int

Modify multiple full records in the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAccrual

modifyAccrual(session_key: string, id: string, record: Accrual) -> int

Modify an existing record in the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAccrualEvent

modifyAccrualEvent(session_key: string, id: string, record: AccrualEvent) -> int

Modify an existing record in the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAccrualEvents

modifyAccrualEvents(session_key: string, records: AccrualEvent[]) -> int

Modify multiple full records in the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAccruals

modifyAccruals(session_key: string, records: Accrual[]) -> int

Modify multiple full records in the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAssignment

modifyAssignment(session_key: string, id: string, record: AssignmentRecord) -> int

Modify an existing record in the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAssignments

modifyAssignments(session_key: string, records: AssignmentRecord[]) -> int

Modify multiple full records in the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyAttributeTypeDescription

modifyAttributeTypeDescription(session_key: string, id_attr_type: string, new_desc: string) -> int

Changes the description (not the display name or ID) of the given Attribute Type.

• @param id_attr_type: the ID of the Attribute Type we are changing the name of.

• @param new_desc: the new description for the attribute type.

• @return: 0 if the change was successful.

• @raise ValueError: raised if the Attribute Type ID does not exist, or the new description is longer than 252 characters.

This method requires administrator access.

modifyAttributeTypeName

modifyAttributeTypeName(session_key: string, id_attr_type: string, new_name: string) -> int

Changes the display name (not the ID) of the given Attribute Type.

• @param id_attr_type: the ID of the Attribute Type we are changing the name of.

• @param new_name: the new name of the attribute type.

• @return: 0 if the name change was successful.

• @raise ValueError: raised if the Attribute Type ID does not exist, or the new name is longer than 30 characters.

This method requires administrator access.

modifyAttributeTypeReportability

modifyAttributeTypeReportability(session_key: string, id_attr_type: string, role_list: string[]) -> int

Changes the roles who have permission to report on the given Attribute Type.

• @param id_attr_type: the ID of the Attribute Type we are changing the authorities of.
• @param role_list: This array contains a list of unique ids from the wtmod.role class

This method requires administrator access.

modifyBackupProjectApprover

modifyBackupProjectApprover(session_key: string, project_id: string, approval_id: string, user_id: string, level: double) -> string

Modifies a project backup approval record by removing the old one and inserting the replacement. Returns the ID of the new record.

• @param project_id: The ID of the project to modify approvals for.
• @param approval_id: The ID of the project approval record to modify.
• @param user_id: The user ID of the new approver.
• @param level: The level to put the new approver at.
• @return: The ID of a new project approval record.

modifyCode

modifyCode(session_key: string, id: string, record: CodeRecord) -> int

Modify an existing record in the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodes

modifyCodes(session_key: string, records: CodeRecord[]) -> int

Modify multiple full records in the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom4

modifyCodesCustom4(session_key: string, id: string, record: CodesCustom4Record) -> int

Modify an existing record in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom4s

modifyCodesCustom4s(session_key: string, records: CodesCustom4Record[]) -> int

Modify multiple full records in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom5

modifyCodesCustom5(session_key: string, id: string, record: CodesCustom5Record) -> int

Modify an existing record in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom5s

modifyCodesCustom5s(session_key: string, records: CodesCustom5Record[]) -> int

Modify multiple full records in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom6

modifyCodesCustom6(session_key: string, id: string, record: CodesCustom6Record) -> int

Modify an existing record in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom6s

modifyCodesCustom6s(session_key: string, records: CodesCustom6Record[]) -> int

Modify multiple full records in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom7

modifyCodesCustom7(session_key: string, id: string, record: CodesCustom7Record) -> int

Modify an existing record in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesCustom7s

modifyCodesCustom7s(session_key: string, records: CodesCustom7Record[]) -> int

Modify multiple full records in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense4

modifyCodesExpense4(session_key: string, id: string, record: CodesExpense4Record) -> int

Modify an existing record in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense4s

modifyCodesExpense4s(session_key: string, records: CodesExpense4Record[]) -> int

Modify multiple full records in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense5

modifyCodesExpense5(session_key: string, id: string, record: CodesExpense5Record) -> int

Modify an existing record in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense5s

modifyCodesExpense5s(session_key: string, records: CodesExpense5Record[]) -> int

Modify multiple full records in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense6

modifyCodesExpense6(session_key: string, id: string, record: CodesExpense6Record) -> int

Modify an existing record in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense6s

modifyCodesExpense6s(session_key: string, records: CodesExpense6Record[]) -> int

Modify multiple full records in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense7

modifyCodesExpense7(session_key: string, id: string, record: CodesExpense7Record) -> int

Modify an existing record in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesExpense7s

modifyCodesExpense7s(session_key: string, records: CodesExpense7Record[]) -> int

Modify multiple full records in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime4

modifyCodesTime4(session_key: string, id: string, record: CodesTime4Record) -> int

Modify an existing record in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime4s

modifyCodesTime4s(session_key: string, records: CodesTime4Record[]) -> int

Modify multiple full records in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime5

modifyCodesTime5(session_key: string, id: string, record: CodesTime5Record) -> int

Modify an existing record in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime5s

modifyCodesTime5s(session_key: string, records: CodesTime5Record[]) -> int

Modify multiple full records in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime6

modifyCodesTime6(session_key: string, id: string, record: CodesTime6Record) -> int

Modify an existing record in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime6s

modifyCodesTime6s(session_key: string, records: CodesTime6Record[]) -> int

Modify multiple full records in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime7

modifyCodesTime7(session_key: string, id: string, record: CodesTime7Record) -> int

Modify an existing record in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCodesTime7s

modifyCodesTime7s(session_key: string, records: CodesTime7Record[]) -> int

Modify multiple full records in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCurrencyConversion

modifyCurrencyConversion(session_key: string, id: string, record: CurrencyConversion) -> int

Modify an existing record in the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyCurrencyConversions

modifyCurrencyConversions(session_key: string, records: CurrencyConversion[]) -> int

Modify multiple full records in the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseCode

modifyExpenseCode(session_key: string, id: string, record: ExpenseCodeRecord) -> int

Modify an existing record in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseCodes

modifyExpenseCodes(session_key: string, records: ExpenseCodeRecord[]) -> int

Modify multiple full records in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseCurrency

modifyExpenseCurrency(session_key: string, id: string, record: ExpenseCurrencyRecord) -> int

Modify an existing record in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseCurrencys

modifyExpenseCurrencys(session_key: string, records: ExpenseCurrencyRecord[]) -> int

Modify multiple full records in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseRecord

modifyExpenseRecord(session_key: string, id: string, record: ExpenseRecord) -> int

Modify an existing record in the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseRecords

modifyExpenseRecords(session_key: string, records: ExpenseRecord[]) -> int

Modify multiple full records in the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseRecordsWithNames

modifyExpenseRecordsWithNames(session_key: string, records: ExpenseRecord[]) -> int

Modify multiple existing records in the expense_recs (ExpenseRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseRecordWithNames

modifyExpenseRecordWithNames(session_key: string, id: string, record: ExpenseRecord) -> int

Modify an existing record in the expense_recs (ExpenseRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseSource

modifyExpenseSource(session_key: string, id: string, record: ExpenseSourceRecord) -> int

Modify an existing record in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyExpenseSources

modifyExpenseSources(session_key: string, records: ExpenseSourceRecord[]) -> int

Modify multiple full records in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyGroup

modifyGroup(session_key: string, id: string, record: GroupRecord) -> int

Modify an existing record in the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyGroupMemorizedEntry

modifyGroupMemorizedEntry(session_key: string, mtype: string, id: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to modify.

• @param mrec: The modified memorized entry.

• @return: The ID of the modified memorized entry.

Modifies an existing memorized entry for a group. Although it is not necessary to specify the group (since every memorized entry has a unique ID) this method will not modify memorized entries assigned to individual users, nor can you use it to move a memorized entry from one group to another.

This method requires administrator access.

modifyGroupMemorizedEntryWithNames

modifyGroupMemorizedEntryWithNames(session_key: string, mtype: string, id: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to modify.

• @param mrec: The modified memorized entry.

• @return: the ID of the modified memorized entry

Modifies an existing memorized entry for a group, converting group, project, and code names to their corresponding IDs on the server side. Although it is not necessary to specify the group (since every memorized entry has a unique ID) this method will not modify memorized entries assigned to individual users, nor can you use it to move a memorized entry from one group to another.

This method is a superset of the modifyGroupMemorizedEntry method, and is subject to its access restrictions.

modifyGroups

modifyGroups(session_key: string, records: GroupRecord[]) -> int

Modify multiple full records in the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageMeasurement

modifyMileageMeasurement(session_key: string, id: string, record: MileageMeasurementRecord) -> int

Modify an existing record in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageMeasurements

modifyMileageMeasurements(session_key: string, records: MileageMeasurementRecord[]) -> int

Modify multiple full records in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageReason

modifyMileageReason(session_key: string, id: string, record: MileageReasonRecord) -> int

Modify an existing record in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageReasons

modifyMileageReasons(session_key: string, records: MileageReasonRecord[]) -> int

Modify multiple full records in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageRecord

modifyMileageRecord(session_key: string, id: string, record: MileageRecord) -> int

Modify an existing record in the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageRecords

modifyMileageRecords(session_key: string, records: MileageRecord[]) -> int

Modify multiple full records in the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageRecordsWithNames

modifyMileageRecordsWithNames(session_key: string, records: MileageRecord[]) -> int

Modify multiple existing records in the travel_recs (MileageRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageRecordWithNames

modifyMileageRecordWithNames(session_key: string, id: string, record: MileageRecord) -> int

Modify an existing record in the travel_recs (MileageRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageVehicle

modifyMileageVehicle(session_key: string, id: string, record: MileageVehicleRecord) -> int

Modify an existing record in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyMileageVehicles

modifyMileageVehicles(session_key: string, records: MileageVehicleRecord[]) -> int

Modify multiple full records in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyNoteText

modifyNoteText(session_key: string, noteid: string, text: string) -> int

• @param noteid: The ID of the note.

• @param text: The new text of the note.

• @return: 1 if successful.

Modify the text of an existing note.

Note that modifying the text of a note to an empty string actually deletes it entirely.

modifyProject

modifyProject(session_key: string, id: string, record: ProjectRecord) -> int

Modify an existing record in the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectApproval

modifyProjectApproval(session_key: string, id: string, record: ProjectApproval) -> int

Modify an existing record in the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectApprovals

modifyProjectApprovals(session_key: string, records: ProjectApproval[]) -> int

Modify multiple full records in the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectApprovalSetting

modifyProjectApprovalSetting(session_key: string, id: string, record: ProjectApprovalSetting) -> int

Modify an existing record in the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectApprovalSettings

modifyProjectApprovalSettings(session_key: string, records: ProjectApprovalSetting[]) -> int

Modify multiple full records in the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectApprover

modifyProjectApprover(session_key: string, project_id: string, approval_id: string, user_id: string, level: double) -> string

Modifies a project approval record by removing the old one and inserting the replacement. Returns the ID of the new record.

• @param project_id: The ID of the project to modify approvals for.
• @param approval_id: The ID of the project approval record to modify.
• @param user_id: The user ID of the new approver.
• @param level: The level to put the new approver at.
• @return: The ID of a new project approval record.

modifyProjectApprovers

modifyProjectApprovers(session_key: string, records: ProjectApprover[]) -> int

Modify multiple full records in the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectCodeRate

modifyProjectCodeRate(session_key: string, id: string, record: ProjectCodeRate) -> int

Modify an existing record in the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectCodeRates

modifyProjectCodeRates(session_key: string, records: ProjectCodeRate[]) -> int

Modify multiple full records in the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectPickerItem

modifyProjectPickerItem(session_key: string, id: string, record: ProjectPickerItem) -> int

Modify an existing record in the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectPickerItems

modifyProjectPickerItems(session_key: string, records: ProjectPickerItem[]) -> int

Modify multiple full records in the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjects

modifyProjects(session_key: string, records: ProjectRecord[]) -> int

Modify multiple full records in the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectsWithNames

modifyProjectsWithNames(session_key: string, records: ProjectRecord[]) -> int

Modify multiple existing records in the projects (Project) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyProjectWithNames

modifyProjectWithNames(session_key: string, id: string, record: ProjectRecord) -> int

Modify an existing record in the projects (Project) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPS_DV_Assignments

modifyPS_DV_Assignments(session_key: string, id: string, record: PS_DV_Assignments) -> int

Modify an existing record in the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPS_DV_Assignmentss

modifyPS_DV_Assignmentss(session_key: string, records: PS_DV_Assignments[]) -> int

Modify multiple full records in the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPS_DV_Rules

modifyPS_DV_Rules(session_key: string, id: string, record: PS_DV_Rules) -> int

Modify an existing record in the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPS_DV_Ruless

modifyPS_DV_Ruless(session_key: string, records: PS_DV_Rules[]) -> int

Modify multiple full records in the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSAccrualOverride

modifyPSAccrualOverride(session_key: string, id: string, record: PSAccrualOverride) -> int

Modify an existing record in the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSAccrualOverrides

modifyPSAccrualOverrides(session_key: string, records: PSAccrualOverride[]) -> int

Modify multiple full records in the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSAccrualTierManager

modifyPSAccrualTierManager(session_key: string, id: string, record: PSAccrualTierManager) -> int

Modify an existing record in the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSAccrualTierManagers

modifyPSAccrualTierManagers(session_key: string, records: PSAccrualTierManager[]) -> int

Modify multiple full records in the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSCompensationTierManager

modifyPSCompensationTierManager(session_key: string, id: string, record: PSCompensationTierManager) -> int

Modify an existing record in the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPSCompensationTierManagers

modifyPSCompensationTierManagers(session_key: string, records: PSCompensationTierManager[]) -> int

Modify multiple full records in the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPunchRecord

modifyPunchRecord(session_key: string, id: string, record: PunchRecord) -> int

Modify an existing record in the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPunchRecords

modifyPunchRecords(session_key: string, records: PunchRecord[]) -> int

Modify multiple full records in the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPXTeam

modifyPXTeam(session_key: string, id: string, record: PXTeamRecord) -> int

Modify an existing record in the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyPXTeams

modifyPXTeams(session_key: string, records: PXTeamRecord[]) -> int

Modify multiple full records in the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyRateCode

modifyRateCode(session_key: string, id: string, record: RateCodeRecord) -> int

Modify an existing record in the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyRateCodes

modifyRateCodes(session_key: string, records: RateCodeRecord[]) -> int

Modify multiple full records in the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyRateRule

modifyRateRule(session_key: string, rulename: string, raterule: RateRule) -> string

• @param rulename: The name of the rate rule to modify.

• @param raterule: The RateRule structure describing the modified rule.

• @return: The name of the modified rate rule.

Modifies an existing rate rule.

This method requires administrator access.

modifyRecord

modifyRecord(session_key: string, tablename: string, rec_id: string, record: Record, withNames: boolean) -> int

Modify a record or records in the Journyx database.

• @param tablename: The name of the table to modify records in.
• @param rec_id: The ID of the record to modify; ignored if modifying multiple records.
• @param record: The modified record (or list of records).
• @param withNames: If true, perform name/ID conversion if available for this type.
• @param multiple: If true, modify multiple records instead of a single one.
• @return: A meaningless integer.

This method modifies existing records in the Journyx database. To modify a single record, pass its ID along with the modified version of the record (note that the ID field of the record should in this case be left blank unless you wish to change it). For multiple records (untyped endpoints only) leave the rec_id parameter blank, set multiple to True, and pass a list of multiple records with ID fields filled. In either case the records to modify will be selected by ID comparison.

If withNames is True, name to ID conversion will be performed on certain fields if supported by the type. Please consult the type documentation for more information on which types support name to ID conversion and on which fields.

To add multiple records with a typed endpoint, see modifyRecords.

modifyRecords

modifyRecords(session_key: string, tablename: string, records: Record[], withNames: boolean) -> int

Modify multiple records in the Journyx database.

• @param tablename: The name of the table to modify records in.
• @param records: A list of records to modify.
• @param withNames: If true, perform name to ID conversion if available for this type.
• @return: A meaningless integer.

This is a variant of modifyRecord to allow typed endpoints to modify multiple records at once. Note that the original record to modify will be selected by consulting the ID field of the modified records you supply (so it is not possible to change a record's ID using this method).

If withNames is true, name to ID conversion will be performed on certain fields if supported by the type. Please consult the type documentation for more details.

modifyRequestRecord

modifyRequestRecord(session_key: string, id: string, record: RequestRecord) -> int

Modify an existing record in the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyRequestRecords

modifyRequestRecords(session_key: string, records: RequestRecord[]) -> int

Modify multiple full records in the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyRuleSet

modifyRuleSet(session_key: string, setname: string, ruleset: RuleSet) -> string

• @param setname: The name of the policy to modify.

• @param ruleset: A RuleSet structure describing the modified policy.

• @return: The name of the modified policy.

Modifies an existing policy.

This method requires administrator access.

modifySubcode

modifySubcode(session_key: string, id: string, record: SubcodeRecord) -> int

Modify an existing record in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifySubcodes

modifySubcodes(session_key: string, records: SubcodeRecord[]) -> int

Modify multiple full records in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifySubsubcode

modifySubsubcode(session_key: string, id: string, record: SubsubcodeRecord) -> int

Modify an existing record in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifySubsubcodes

modifySubsubcodes(session_key: string, records: SubsubcodeRecord[]) -> int

Modify multiple full records in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyTimeRecord

modifyTimeRecord(session_key: string, id: string, record: TimeRecord) -> int

Modify an existing record in the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyTimeRecords

modifyTimeRecords(session_key: string, records: TimeRecord[]) -> int

Modify multiple full records in the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyTimeRecordsWithNames

modifyTimeRecordsWithNames(session_key: string, records: TimeRecord[]) -> int

Modify multiple existing records in the time_recs (TimeRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyTimeRecordWithNames

modifyTimeRecordWithNames(session_key: string, id: string, record: TimeRecord) -> int

Modify an existing record in the time_recs (TimeRecord) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUser

modifyUser(session_key: string, id: string, record: UserRecord) -> int

Modify an existing record in the users (User) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUserAccrual

modifyUserAccrual(session_key: string, id: string, accrual: AccrualRecord) -> string

• @param id: The ID of the accrual to modify.

• @param accrual: The modified accrual.

• @return: the ID of the modified accrual.

Modifies an existing accrual. Note that it is not possible to reassign an accrual to a different user, nor is it possible or necessary to specify the user when calling this method.

Note: This method is deprecated as of Journyx 10.1, even if you request an older API version.

This method requires administrator access.

modifyUserMemorizedEntry

modifyUserMemorizedEntry(session_key: string, mtype: string, id: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to modify.

• @param mrec: The modified memorized entry.

• @return: The ID of the modified memorized entry.

Modifies an existing memorized entry. Although it is not necessary to specify the user (since each memorized entry has a unique ID) it is not possible to use this method to move a memorized entry from one user to another.

This method requires administrator access.

modifyUserMemorizedEntryWithNames

modifyUserMemorizedEntryWithNames(session_key: string, mtype: string, id: string, mrec: MemorizedEntry) -> string

• @param mtype: The memorized entry type ('time', 'expense', or 'mileage').

• @param id: The ID of the memorized entry to modify.

• @param mrec: The modified memorized entry.

• @return: The ID of the modified memorized entry.

Modifies an existing memorized entry, converting provided group, project, and code names to their corresponding IDs on the server side. Although it is not necessary to specify the user (since each memorized entry has a unique ID) it is not possible to use this method to move a memorized entry from one user to another.

This method is a superset of the modifyUserMemorizedEntry method, and is subject to its access restrictions.

modifyUserRole

modifyUserRole(session_key: string, id: string, record: UserRole) -> int

Modify an existing record in the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUserRoles

modifyUserRoles(session_key: string, records: UserRole[]) -> int

Modify multiple full records in the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUsers

modifyUsers(session_key: string, records: UserRecord[]) -> int

Modify multiple full records in the users (User) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUserSheetNote

modifyUserSheetNote(session_key: string, id: string, record: UserSheetNote) -> int

Modify an existing record in the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUserSheetNotes

modifyUserSheetNotes(session_key: string, records: UserSheetNote[]) -> int

Modify multiple full records in the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUsersWithNames

modifyUsersWithNames(session_key: string, records: UserRecord[]) -> int

Modify multiple existing records in the users (User) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyUserWithNames

modifyUserWithNames(session_key: string, id: string, record: UserRecord) -> int

Modify an existing record in the users (User) table, converting names to IDs.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyVirtualSheetRecord

modifyVirtualSheetRecord(session_key: string, id: string, record: VirtualSheetRecord) -> int

Modify an existing record in the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyVirtualSheetRecords

modifyVirtualSheetRecords(session_key: string, records: VirtualSheetRecord[]) -> int

Modify multiple full records in the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyVirtualTimeSheet

modifyVirtualTimeSheet(session_key: string, id: string, record: VirtualTimeSheet) -> int

Modify an existing record in the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

modifyVirtualTimeSheets

modifyVirtualTimeSheets(session_key: string, records: VirtualTimeSheet[]) -> int

Modify multiple full records in the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the modifyRecord method, and is subject to its access restrictions.

punch

punch(session_key: string, inout: string, datetime: string) -> string

Punch in or out.

This method is equivalent to clicking the punch in/out button on the allocation entry screen. If the second parameter is an empty string the punch records the current time; otherwise you may specify a date and time as an ISO8601 string with time zone to have the punch recorded for that time instead.

The first parameter can be either "in" or "out" as a hint to the server about whether the punch is meant as a starting or ending time. However, in most cases this is inferred from the presence and number of other punches on the same day, and the only thing this parameter typically affects is how cross-midnight work periods are handled.

• @param inout: One of "in" or "out".
• @param datetime: The date and time to punch at, as an ISO8601 string.
• @return: A status message.

This method may be called by any logged-in user.

punch_sheet

punch_sheet(session_key: string, sheet_id: string, inout: string) -> SheetSaveResult

Punch in or out to an Allocation/Punch sheet UI.

• @param sheet_id: The sheet ID.
• @param inout: Either 'in' or 'out'.
• @return: A SheetSaveResult structure containing the updated sheet.

queryAttributes

queryAttributes(session_key: string, object_type: string, object_id_list: string[], id_attr_type_list: string[]) -> AttributeQueryResult[]

Searches the attribute table of an object type to find attribute values for a range of object IDs or attribute type IDs.

Note that attribute values are always returned as strings, even if they are actually of a numeric type.

• @param object_type: The object type to search (use getAttributeObjectTypes to determine usable values).

• @param object_id_list: A list of object IDs to search for attributes. If the list is empty, all objects of the specified type will be searched.

• @param id_attr_type_list: A list of attribute type IDs to search for. If the list is empty, all attributes will be returned.

• @return: a list of matching attributes

This method may be called by any logged-in user.

queryAttributesByValue

queryAttributesByValue(session_key: string, object_type: string, values_list: string[], type_name_list: string[]) -> AttributeQueryResult[]

Searches the attribute table of an object type for attributes matching a value or values.

• @param object_type: The object type to search.

• @param values_list: The list of values to search for. If the values are all integer or floating point you may use queryAttributesByValueInteger or queryAttributesByValueNumber respectively; otherwise, convert them all to strings and use this method.

• @param type_name_list: The list of attribute types to search, by ID or name. If the list is empty, all attributes will be searched.

• @return: a list of matching attributes

• @raise RuntimeError: if the object type is not valid or any specified attribute types do not exist

• @raise ValueError: if the list of values to search for is empty.

This method may be called by any logged-in user.

queryAttributesByValueInteger

queryAttributesByValueInteger(session_key: string, object_type: string, values_list: int[], type_name_list: string[]) -> AttributeQueryResult[]

Searches the attribute table of an object type for attributes matching a value or values.

• @param object_type: The object type to search.

• @param values_list: The list of values to search for. If the values are not all integers, you may use queryAttributesByValueNumber if they are floating point numbers. For other types or if the values are of mixed types, convert them all to strings and use queryAttributesByValue instead.

• @param type_name_list: The list of attribute types to search, by ID or name. If the list is empty, all attributes will be searched.

• @return: a list of matching attributes

• @raise RuntimeError: if the object type is not valid or any specified attribute types do not exist

• @raise ValueError: if the list of values to search for is empty.

This method is a superset of the queryAttributesByValue method, and is subject to its access restrictions.

queryAttributesByValueNumber

queryAttributesByValueNumber(session_key: string, object_type: string, values_list: double[], type_name_list: string[]) -> AttributeQueryResult[]

Searches the attribute table of an object type for attributes matching a value or values.

• @param object_type: The object type to search.

• @param values_list: The list of values to search for. If the values are not all floating point numbers, you may use queryAttributesByValueInteger if they are integers. For other types or if the values are of mixed types, convert them all to strings and use queryAttributesByValue instead.

• @param type_name_list: The list of attribute types to search, by ID or name. If the list is empty, all attributes will be searched.

• @return: a list of matching attributes

• @raise RuntimeError: if the object type is not valid or any specified attribute types do not exist

• @raise ValueError: if the list of values to search for is empty.

This method is a superset of the queryAttributesByValue method, and is subject to its access restrictions.

queryAttributeTypes

queryAttributeTypes(session_key: string, attr_type_srec: AttributeTypeRecord) -> AttributeTypeRecord[]

This method allows you to search the entire table of Attribute Types, searching on any of the fields.

• @param attr_type_srec: An Attribute Type record. The results that are returned by this method will be limited by the fields in this search record parameter. Passing an empty Structure will result in all Attribute Type records in the product (across all domains)! Likewise, not specifying the id_domain column in your search record will include all domains in the search.

• @return: Array of AttributeType records of attrib types that match your search criteria. If no records match, an empty Array is returned.

• @raise TypeError: if the search record parameter is not in the correct format (a Structure or dictionary / hash) or one of the keys is incorrect (not a field defined in the AttributeTypeRecord definition.)

This example returns all 'editable' Project-related Attribute Types in the domain specified in the variable my_domain_id. (The 'visibility' codes are documented separately.)

search_rec = { 'table_name': 'projects',
            'id_domain': my_domain_id,
            'visibility': 1,}

results = Session.queryAttributeTypes(search_rec)

for result in results:
    print 'ID: ', result['id_attr_type']

This method may be called by any logged-in user.

queryUserAttributesByLogin

queryUserAttributesByLogin(session_key: string) -> string

This method is a way to query the User Attribute table to get attribute values for a range of different Object IDs or Attribute Type IDs.

This method is not available in typed endpoints.

• @param object_id_list: This array should contain the Journyx login names (NOT IDs) of the Users whose attributes you wish to examine. All Users may be searched by providing a null or empty list.

• @param id_attr_type_list: This array should contain the Attribute Type IDs to restrict the result set. If any empty or Null list is provided, values for ALL attribute types (for this Object Type) will be returned.

The return value from this method is an Array of Attribute Arrays. Each Attribute Array in the return array has this format:

( User Login, Attribute Type ID, Attribute Type PName, Value)

Note that the Value may be either String or Numeric depending on the data-type of the particular AttributeType record.

If no records are found that match, an empty list will be returned.

• @raise RuntimeError: If the object_type is invalid.
• @raise TypeError: raised if the object_id_list and id_attr_type_list parameters are not in the proper array-of-strings format.

NOTE: The results of this method are subject to normal group membership "viewability" checks.

This method may be called by any logged-in user.

refresh_suggestions

refresh_suggestions(session_key: string, id_user: string, start_datetime: string, end_datetime: string, source_categories: string[], entry_type: string, separate_hidden: boolean) -> SuggestionRefreshResult

Refresh suggestions for the given user, such as by pulling new calendar events.

• @param id_user: The user ID.
• @param start_datetime: The start of the date range to refresh (YYYYMMDD or empty).
• @param end_datetime: The end of the date range to refresh (YYYYMMDD or empty).
• @param source_categories: List of sources to pull from, or empty for all sources.
• @param entry_type: One of 'time', 'expense', or 'custom'.
• @param separate_hidden: If True, do not include hidden items in the main suggestion list.
• @return: A SuggestionRefreshResult object.

This method may be called by any logged-in user.

rejectProject

rejectProject(session_key: string, sheet_id: string, project_id: string, reason: string) -> int

Reject a project that is pending approval.

• @param sheet_id: The sheet ID to reject the project in.
• @param project_id: The project ID to reject.
• @param reason: The reason for rejection.
• @return: A meaningless value.

removeAccessControlList

removeAccessControlList(session_key: string, id: string) -> int

Remove an existing record from the access_control_lists (AccessControlList) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeAccrual

removeAccrual(session_key: string, id: string) -> int

Remove an existing record from the timebank (Accrual) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeAccrualEvent

removeAccrualEvent(session_key: string, id: string) -> int

Remove an existing record from the time_banks_log (AccrualEvent) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeAssignment

removeAssignment(session_key: string, id: string) -> int

Remove an existing record from the assignments (Assignment) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeAttributeTypeDefaultValue

removeAttributeTypeDefaultValue(session_key: string, id_attr_type: string) -> int

Removes the default value for an Attribute Type (sets it to null.)

• @param id_attr_type: the ID of the Attribute Type

• @return: 0 if successful.

• @raise ValueError: raised if the Attribute Type ID does not exist. If there is no default value, None is returned.

This method requires administrator access.

removeCode

removeCode(session_key: string, id: string) -> int

Remove an existing record from the codes_tasks (Code) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodeFromGroup

removeCodeFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_tasks (Code) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesCustom4

removeCodesCustom4(session_key: string, id: string) -> int

Remove an existing record from the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesCustom4FromGroup

removeCodesCustom4FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_custom_4 (CodesCustom4) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesCustom5

removeCodesCustom5(session_key: string, id: string) -> int

Remove an existing record from the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesCustom5FromGroup

removeCodesCustom5FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_custom_5 (CodesCustom5) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesCustom6

removeCodesCustom6(session_key: string, id: string) -> int

Remove an existing record from the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesCustom6FromGroup

removeCodesCustom6FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_custom_6 (CodesCustom6) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesCustom7

removeCodesCustom7(session_key: string, id: string) -> int

Remove an existing record from the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesCustom7FromGroup

removeCodesCustom7FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_custom_7 (CodesCustom7) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesExpense4

removeCodesExpense4(session_key: string, id: string) -> int

Remove an existing record from the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesExpense4FromGroup

removeCodesExpense4FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expense_4 (CodesExpense4) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesExpense5

removeCodesExpense5(session_key: string, id: string) -> int

Remove an existing record from the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesExpense5FromGroup

removeCodesExpense5FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expense_5 (CodesExpense5) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesExpense6

removeCodesExpense6(session_key: string, id: string) -> int

Remove an existing record from the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesExpense6FromGroup

removeCodesExpense6FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expense_6 (CodesExpense6) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesExpense7

removeCodesExpense7(session_key: string, id: string) -> int

Remove an existing record from the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesExpense7FromGroup

removeCodesExpense7FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expense_7 (CodesExpense7) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesTime4

removeCodesTime4(session_key: string, id: string) -> int

Remove an existing record from the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesTime4FromGroup

removeCodesTime4FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_time_4 (CodesTime4) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesTime5

removeCodesTime5(session_key: string, id: string) -> int

Remove an existing record from the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesTime5FromGroup

removeCodesTime5FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_time_5 (CodesTime5) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesTime6

removeCodesTime6(session_key: string, id: string) -> int

Remove an existing record from the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesTime6FromGroup

removeCodesTime6FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_time_6 (CodesTime6) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeCodesTime7

removeCodesTime7(session_key: string, id: string) -> int

Remove an existing record from the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeCodesTime7FromGroup

removeCodesTime7FromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_time_7 (CodesTime7) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeColumnDependency

removeColumnDependency(session_key: string, parent_table: string, parent_id: string, child_table: string, child_id: string) -> int

Remove a column dependency.

This method removes a dependency between code columns.

• @param parent_table: The name or printable name of the parent table.

• @param parent_id: The ID or printable name of the parent item.

• @param child_table: The name or printable name of the child table.

• @param child_id: The ID or printable name of the child item.

• @return: 1.

This method requires administrator access.

removeCurrencyConversion

removeCurrencyConversion(session_key: string, id: string) -> int

Remove an existing record from the currency_convert (CurrencyConversion) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeExpenseCode

removeExpenseCode(session_key: string, id: string) -> int

Remove an existing record from the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeExpenseCodeFromGroup

removeExpenseCodeFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expenses (ExpenseCode) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeExpenseCurrency

removeExpenseCurrency(session_key: string, id: string) -> int

Remove an existing record from the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeExpenseCurrencyFromGroup

removeExpenseCurrencyFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_currencies (ExpenseCurrency) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeExpenseRecord

removeExpenseRecord(session_key: string, id: string) -> int

Remove an existing record from the expense_recs (ExpenseRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeExpenseSource

removeExpenseSource(session_key: string, id: string) -> int

Remove an existing record from the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeExpenseSourceFromGroup

removeExpenseSourceFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_expense_sources (ExpenseSource) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeGroup

removeGroup(session_key: string, id: string) -> int

Remove an existing record from the groups (Group) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeMileageMeasurement

removeMileageMeasurement(session_key: string, id: string) -> int

Remove an existing record from the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeMileageMeasurementFromGroup

removeMileageMeasurementFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_travel_measurements (MileageMeasurement) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeMileageReason

removeMileageReason(session_key: string, id: string) -> int

Remove an existing record from the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeMileageReasonFromGroup

removeMileageReasonFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_travel_reasons (MileageReason) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeMileageRecord

removeMileageRecord(session_key: string, id: string) -> int

Remove an existing record from the travel_recs (MileageRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeMileageVehicle

removeMileageVehicle(session_key: string, id: string) -> int

Remove an existing record from the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeMileageVehicleFromGroup

removeMileageVehicleFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_travel_vehicles (MileageVehicle) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeObjectFromGroup

removeObjectFromGroup(session_key: string, group_id_name: string, object_class: string, object_id_name: string) -> int

This method will revoke the given Object's membership in a Group.

A ValueError is raised if the Group OR Object ID/name cannot be mapped to a single unique ID. In other words, if you try to remove an object from the group "Test Group", and there is more than one group named "Test Group", a ValueError will be raised. Likewise, if the Object name cannot be disambiguated, the ValueError will be raised.

In this case, you will need to provide the specific ID of the group and/or object, which can be found with the getGroup(search_rec) method, or the various other methods for searching for objects.

ValueError is also raised if the object_class is not one of the supported classes. See the getGroupObjectClasses method.

• @param group_id_name: The ID or pretty name of the group.
• @param object_class: The name of the class of object to remove from the group.
• @param object_id_name: The ID or pretty name of the object to remove from the group.
• @return: zero if the object was successfully removed from the group

This method requires any one of the following abilities: "admin", "msp_admin"

removeProject

removeProject(session_key: string, id: string) -> int

Remove an existing record from the projects (Project) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeProjectApproval

removeProjectApproval(session_key: string, id: string) -> int

Remove an existing record from the project_approval (ProjectApproval) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeProjectApprovalBackupRecords

removeProjectApprovalBackupRecords(session_key: string, project_id: string, recids: string[]) -> int

Remove one or more backup project approval records.

• @param project_id: The project ID.
• @param recids: The IDs of the ProjectApproval objects to remove.
• @return: A meaningless value.

removeProjectApprovalRecords

removeProjectApprovalRecords(session_key: string, project_id: string, recids: string[]) -> int

Remove one or more project approval records.

• @param project_id: The project ID.
• @param recids: The IDs of the ProjectApproval objects to remove.
• @return: A meaningless value.

removeProjectApprovalSetting

removeProjectApprovalSetting(session_key: string, id: string) -> int

Remove an existing record from the project_approval_settings (ProjectApprovalSetting) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeProjectApprover

removeProjectApprover(session_key: string, id: string) -> int

Remove an existing record from the project_approvers (ProjectApprover) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeProjectCodeRate

removeProjectCodeRate(session_key: string, id: string) -> int

Remove an existing record from the project_code_rates (ProjectCodeRate) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeProjectDependency

removeProjectDependency(session_key: string, project_id: string, code_type: string, code_id: string) -> int

• @param project_id: The ID of the project.

• @param code_type: The code type of the dependency.

• @param code_id: The ID of the dependent code.

• @return: 0

• @raise ValueError: If the project ID, code ID, or code type is not found.

Removes a dependent code ID from a projects dependencies.

NOTE: You must have one of the following role abilities to perform this action:

• 'Authority - Administrator'
• 'Project - Add'
• 'Project - Modify'
• 'Project - Delete'

removeProjectFromGroup

removeProjectFromGroup(session_key: string, id: string, group: string) -> int

Remove a projects (Project) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeProjectPickerItem

removeProjectPickerItem(session_key: string, id: string) -> int

Remove an existing record from the project_picker (ProjectPickerItem) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePS_DV_Assignments

removePS_DV_Assignments(session_key: string, id: string) -> int

Remove an existing record from the PS_DV_Assignments (PS_DV_Assignments) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePS_DV_Rules

removePS_DV_Rules(session_key: string, id: string) -> int

Remove an existing record from the PS_DV_Rules (PS_DV_Rules) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePSAccrualOverride

removePSAccrualOverride(session_key: string, id: string) -> int

Remove an existing record from the PSAccrualOverride (PSAccrualOverride) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePSAccrualTierManager

removePSAccrualTierManager(session_key: string, id: string) -> int

Remove an existing record from the PSAccrualTierManager (PSAccrualTierManager) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePSCompensationTierManager

removePSCompensationTierManager(session_key: string, id: string) -> int

Remove an existing record from the PSCompensationTierManager (PSCompensationTierManager) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePunchRecord

removePunchRecord(session_key: string, id: string) -> int

Remove an existing record from the punch_time_recs (PunchRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePXTeam

removePXTeam(session_key: string, id: string) -> int

Remove an existing record from the px_teams (PXTeam) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removePXTeamFromGroup

removePXTeamFromGroup(session_key: string, id: string, group: string) -> int

Remove a px_teams (PXTeam) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeRateCode

removeRateCode(session_key: string, id: string) -> int

Remove an existing record from the rate_codes (RateCode) table.

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.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeRecord

removeRecord(session_key: string, table_name__s: string, record__st: Record) -> int

Removes a record from the Journyx database. You must supply the table name and a 'search record.' The search record must NOT be blank (i.e, you cannot delete all records with a blank search record.) Currently no search clauses other than simple string matches are supported. If you wish to delete an object with a specific ID, create a searchrec where the only field is the ID column set to your chosen value.

• @param table_name__s: table to delete from
• @param record__st: a 'search record'
• @return: always 0 (integer) - this is NOT the number of records deleted.

removeRequestRecord

removeRequestRecord(session_key: string, id: string) -> int

Remove an existing record from the request_recs (RequestRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeRoleFromUser

removeRoleFromUser(session_key: string, name: string, role: string) -> int

• @param name: The ID of the user.

• @param role: The role to remove from the user.

• @return: 0

• @raise ValueError: If the user or role is not found, or the role name is ambiguous.

Removes a role from a user, which must be specified by its ID (not login). The role may be specified by the role ID or its display name, provided that the name can be unambiguously matched with a single role ID.

This method requires administrator access.

removeSubcode

removeSubcode(session_key: string, id: string) -> int

Remove an existing record from the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeSubcodeFromGroup

removeSubcodeFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_pay_types (Subcode) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeSubsubcode

removeSubsubcode(session_key: string, id: string) -> int

Remove an existing record from the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeSubsubcodeFromGroup

removeSubsubcodeFromGroup(session_key: string, id: string, group: string) -> int

Remove a codes_bill_types (Subsubcode) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeTimeRecord

removeTimeRecord(session_key: string, id: string) -> int

Remove an existing record from the time_recs (TimeRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeUser

removeUser(session_key: string, id: string) -> int

Remove an existing record from the users (User) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeUserFromGroup

removeUserFromGroup(session_key: string, id: string, group: string) -> int

Remove a users (User) record from a group.

See coredb for more information about this method.

This method is a superset of the removeObjectFromGroup method, and is subject to its access restrictions.

removeUserRole

removeUserRole(session_key: string, id: string) -> int

Remove an existing record from the userroles (UserRole) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeUserSheetNote

removeUserSheetNote(session_key: string, id: string) -> int

Remove an existing record from the user_sheet_notes (UserSheetNote) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeVirtualSheetRecord

removeVirtualSheetRecord(session_key: string, id: string) -> int

Remove an existing record from the virtual_sheet_records (VirtualSheetRecord) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

removeVirtualTimeSheet

removeVirtualTimeSheet(session_key: string, id: string) -> int

Remove an existing record from the virtual_time_sheets (VirtualTimeSheet) table.

See coredb for more information about this method.

This method is a superset of the removeRecord method, and is subject to its access restrictions.

save_sheet

save_sheet(session_key: string, sheet: Sheet, submit: boolean, extra_data: Item[]) -> SheetSaveResult

Save and submit a sheet to the server.

• @param sheet: The sheet structure to save or submit.

• @param submit: If true, submits the sheet for approval after saving it.

• @param extra_data: A key/value list of extra flags and other data

• @return: A SheetSaveResult structure with the results of the operation.

This method saves an entire sheet to the server, using the same internal processes as the web interface including processing by validation rules and PS plugins. It is equivalent to filling in the fields of the web form and clicking the Save or Submit button.

In general, if your usage of the jxAPI is similar to normal time/expense/custom entry, you should use this method instead of adding records directly, since direct record manipulation bypasses many important parts of the entry process (such as validation and auditing).

Note that many of the fields in the Sheet object are read-only metadata and will be ignored by this method. The fields used for submission are:

• type (must be set to 'time', 'expense', 'mileage', or 'custom')
• id (must be set; use getPeriodForDate to determine the existing sheet ID)
• user (may be left blank to imply current user)
• dates (must be set; use getPeriodForDate to determine correct period dates)
• rows (project/code IDs only, names are ignored) row punch lists
• punchlists
• column_data - get this from the previous getSheet (or save_sheet) and pass the same value back to your next save_sheet. If you don't provide this, all time will be treated as NEW entries, which can potentially "double up" the time on every save.

Note that at present, you cannot save attachments with this method, and the contents of those fields in each cell will be ignored.

The extra_data parameter is a key/value list (or dictionary, in endpoints that understand them) which can contain additional settings beyond what is contained in the sheet structure itself. In addition to settings which are understood by the API, you may use this parameter to pass values back to your own code (in a callback handler, for example). The following settings are currently available:

• submit_with_warnings: Submit despite the presence of DVT warnings. (No effect if DVT is not installed.)
• action: The action to perform ('save', 'submit', 'approve', 'reject') (Not actually required for save or submit, but they are included for completeness.)
• reason: The rejection reason, if action == 'reject'.
• filter_html: If True, and any warning/error/etc. messages are returned, remove all HTML tags from them.

In addition, the extra_data field in the SheetSaveResult may include the following fields:

• has_dvt: True if DVT is installed.
• has_dvt_warnings: True if DVT is installed and the save operation reported DVT warnings. (The actual warning messages are in the error list.)

searchCodes

searchCodes(session_key: string, search_string: string) -> CodeRecord[]

Perform a string search of codes_tasks (Code) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesCustom4s

searchCodesCustom4s(session_key: string, search_string: string) -> CodesCustom4Record[]

Perform a string search of codes_custom_4 (CodesCustom4) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesCustom5s

searchCodesCustom5s(session_key: string, search_string: string) -> CodesCustom5Record[]

Perform a string search of codes_custom_5 (CodesCustom5) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesCustom6s

searchCodesCustom6s(session_key: string, search_string: string) -> CodesCustom6Record[]

Perform a string search of codes_custom_6 (CodesCustom6) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesCustom7s

searchCodesCustom7s(session_key: string, search_string: string) -> CodesCustom7Record[]

Perform a string search of codes_custom_7 (CodesCustom7) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesExpense4s

searchCodesExpense4s(session_key: string, search_string: string) -> CodesExpense4Record[]

Perform a string search of codes_expense_4 (CodesExpense4) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesExpense5s

searchCodesExpense5s(session_key: string, search_string: string) -> CodesExpense5Record[]

Perform a string search of codes_expense_5 (CodesExpense5) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesExpense6s

searchCodesExpense6s(session_key: string, search_string: string) -> CodesExpense6Record[]

Perform a string search of codes_expense_6 (CodesExpense6) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesExpense7s

searchCodesExpense7s(session_key: string, search_string: string) -> CodesExpense7Record[]

Perform a string search of codes_expense_7 (CodesExpense7) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesTime4s

searchCodesTime4s(session_key: string, search_string: string) -> CodesTime4Record[]

Perform a string search of codes_time_4 (CodesTime4) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesTime5s

searchCodesTime5s(session_key: string, search_string: string) -> CodesTime5Record[]

Perform a string search of codes_time_5 (CodesTime5) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesTime6s

searchCodesTime6s(session_key: string, search_string: string) -> CodesTime6Record[]

Perform a string search of codes_time_6 (CodesTime6) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchCodesTime7s

searchCodesTime7s(session_key: string, search_string: string) -> CodesTime7Record[]

Perform a string search of codes_time_7 (CodesTime7) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchExpenseCodes

searchExpenseCodes(session_key: string, search_string: string) -> ExpenseCodeRecord[]

Perform a string search of codes_expenses (ExpenseCode) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchExpenseCurrencys

searchExpenseCurrencys(session_key: string, search_string: string) -> ExpenseCurrencyRecord[]

Perform a string search of codes_currencies (ExpenseCurrency) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchExpenseSources

searchExpenseSources(session_key: string, search_string: string) -> ExpenseSourceRecord[]

Perform a string search of codes_expense_sources (ExpenseSource) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchGroups

searchGroups(session_key: string, search_string: string) -> GroupRecord[]

Perform a string search of groups (Group) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchMileageMeasurements

searchMileageMeasurements(session_key: string, search_string: string) -> MileageMeasurementRecord[]

Perform a string search of codes_travel_measurements (MileageMeasurement) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchMileageReasons

searchMileageReasons(session_key: string, search_string: string) -> MileageReasonRecord[]

Perform a string search of codes_travel_reasons (MileageReason) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchMileageVehicles

searchMileageVehicles(session_key: string, search_string: string) -> MileageVehicleRecord[]

Perform a string search of codes_travel_vehicles (MileageVehicle) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchProjects

searchProjects(session_key: string, search_string: string) -> ProjectRecord[]

Perform a string search of projects (Project) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchProjectsWithNames

searchProjectsWithNames(session_key: string, search_string: string) -> ProjectRecord[]

Warning: not available in all endpoints

Please note that the availability of this method may vary depending on if you access a versioned or unversioned endpoint. The unversioned endpoint typically corresponds to the oldest available versioned endpoint.

This method became available in the 12.1 endpoint.

Perform a string search of projects (Project) records, converting foreign record IDs to names.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchPXTeams

searchPXTeams(session_key: string, search_string: string) -> PXTeamRecord[]

Perform a string search of px_teams (PXTeam) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchRateCodes

searchRateCodes(session_key: string, search_string: string) -> RateCodeRecord[]

Perform a string search of rate_codes (RateCode) records.

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.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchRecords

searchRecords(session_key: string, table_name: string, search_string: string, searchfields: string[]) -> Record[]

Search a table and return matching records.

This method does a basic string search on a table, searching a subset of fields as defined in the table definition, and returns the records that match. Not all tables are searchable. Search fields usually include the pretty name and description of the record, if it has them.

• @param table_name: The name of the table to search.
• @param search_string: The string to search for.
• @param searchfields: The names of the fields to search in, or leave empty for defaults.

This method is a superset of the getRecordsList method, and is subject to its access restrictions.

searchSubcodes

searchSubcodes(session_key: string, search_string: string) -> SubcodeRecord[]

Perform a string search of codes_pay_types (Subcode) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchSubsubcodes

searchSubsubcodes(session_key: string, search_string: string) -> SubsubcodeRecord[]

Perform a string search of codes_bill_types (Subsubcode) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchUsers

searchUsers(session_key: string, search_string: string) -> UserRecord[]

Perform a string search of users (User) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchUserSheetNotes

searchUserSheetNotes(session_key: string, search_string: string) -> UserSheetNote[]

Perform a string search of user_sheet_notes (UserSheetNote) records.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

searchUsersWithNames

searchUsersWithNames(session_key: string, search_string: string) -> UserRecord[]

Perform a string search of users (User) records, converting foreign record IDs to names.

See coredb for more information about this method.

This method is a superset of the searchRecords method, and is subject to its access restrictions.

set_project_children_inherit_dependencies

set_project_children_inherit_dependencies(session_key: string, project_id: string, value: boolean) -> boolean

Sets a project option such that dependencies are automatically copied to children.

• @param project_id: The project ID.
• @param value: True or False
• @return: True (throws exception if operation fails).

This method requires administrator access.

setAssignmentAttributes

setAssignmentAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a assignments (Assignment) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setAttribute

setAttribute(session_key: string, object_type: string, object_id: string, id_attr_type: string, value: string, overwrite_existing: boolean) -> int

Sets the value of an attribute (extra field) on an object.

In untyped endpoints, this method can be used to set the value of any attribute regardless of type.

In typed endpoints, this method can only be used to set string values. Use setAttributeInteger or setAttributeNumber to set integer or floating point values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to set the attribute value on.

• @param id_attr_type: The ID of the attribute type.

• @param value: The attribute value to set.

• @param overwrite_existing: If true, an existing value for this attribute will be overwritten with the new value. If false, and a value already exist, an exception will be raised and no changes will be made.

• @return: 0

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if the object or attribute type does not exist, or the value is improper for the type of the attribute

This method requires any one of the following abilities: "admin", "msp_admin"

setAttributeInteger

setAttributeInteger(session_key: string, object_type: string, object_id: string, id_attr_type: string, value: int, overwrite_existing: boolean) -> int

Sets the value of an integer attribute (extra field) on an object.

This method does not exist in untyped endpoints; use setAttribute instead.

In typed endpoints, this method only sets integer values. Use setAttribute or setAttributeNumber to set string and floating point values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to set the attribute value on.

• @param id_attr_type: The ID of the attribute type.

• @param value: The attribute value to set.

• @param overwrite_existing: If true, an existing value for this attribute will be overwritten with the new value. If false, and a value already exist, an exception will be raised and no changes will be made.

• @return: 0

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if the object or attribute type does not exist, or the value is improper for the type of the attribute

This method is a superset of the setAttribute method, and is subject to its access restrictions.

setAttributeNumber

setAttributeNumber(session_key: string, object_type: string, object_id: string, id_attr_type: string, value: double, overwrite_existing: boolean) -> int

Sets the value of a floating point attribute (extra field) on an object.

This method does not exist in untyped endpoints; use setAttribute instead.

In typed endpoints, this method only sets integer values. Use setAttribute or setAttributeInteger to set string and integer values, respectively.

• @param object_type: The object type; see getAttributeObjectTypes to determine usable values.

• @param object_id: The ID of the object to set the attribute value on.

• @param id_attr_type: The ID of the attribute type.

• @param value: The attribute value to set.

• @param overwrite_existing: If true, an existing value for this attribute will be overwritten with the new value. If false, and a value already exist, an exception will be raised and no changes will be made.

• @return: 0

• @raise RuntimeError: if the object type is not valid

• @raise ValueError: if the object or attribute type does not exist, or the value is improper for the type of the attribute

This method is a superset of the setAttribute method, and is subject to its access restrictions.

setAttributesForObject

setAttributesForObject(session_key: string, object_type: AttributeValue[]) -> int

Set multiple attributes for a single object.

Given a list of AttributeValue objects that contain an attribute name and value, sets all of those attribute values on the given object in a single API call. The 'name' field of an AttributeValue object can contain either an attribute type ID or printable name, and the value must be a string, which will be coerced to the appropriate type if the attribute is a numeric one.

Note that if an exception is caused while setting an attribute, this method will exit without setting the attributes listed after the one that caused the exception.

• @param object_type: the table name of the object to set attributes on.

• @param object_id: the ID of the object to set attributes on.

• @param attributes: a list of attribute names and values to set.

• @return: 0 if successful.

setAttributeTypeDefaultValue

setAttributeTypeDefaultValue(session_key: string, id_attr_type: string, default_value: string) -> int

Sets the default value for an attribute type (extra field). Default attribute values are applied when new records are created; changing the default value will not alter any attribute values on already-existing records.

In untyped endpoints, this method may be used to set values of any type.

In typed endpoints, this method may only be used to set string values. Use setAttributeTypeDefaultValueInteger or setAttributeTypeDefaultValueNumber to set integer and floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param default_value: The new default value for this attribute type.

• @raise ValueError: if the attribute type does not exist, the value is inappropriate for its data type, or if it is a selection list

This method requires administrator access.

setAttributeTypeDefaultValueInteger

setAttributeTypeDefaultValueInteger(session_key: string, id_attr_type: string, default_value: int) -> int

Sets the default value for an attribute type (extra field). Default attribute values are applied when new records are created; changing the default value will not alter any attribute values on already-existing records.

This method is not available in untyped endpoints; use setAttributeTypeDefaultValue instead.

In typed endpoints, this method may only be used to set string values. Use setAttributeTypeDefaultValue or setAttributeTypeDefaultValueNumber to set string and floating point values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param default_value: The new default value for this attribute type.

• @raise ValueError: if the attribute type does not exist, the value is inappropriate for its data type, or if it is a selection list

This method is a superset of the setAttributeTypeDefaultValue method, and is subject to its access restrictions.

setAttributeTypeDefaultValueNumber

setAttributeTypeDefaultValueNumber(session_key: string, id_attr_type: string, default_value: double) -> int

Sets the default value for an attribute type (extra field). Default attribute values are applied when new records are created; changing the default value will not alter any attribute values on already-existing records.

This method is not available in untyped endpoints; use setAttributeTypeDefaultValue instead.

In typed endpoints, this method may only be used to set string values. Use setAttributeTypeDefaultValue or setAttributeTypeDefaultValueInteger to set string and integer values, respectively.

• @param id_attr_type: The ID of the attribute type.

• @param default_value: The new default value for this attribute type.

• @raise ValueError: if the attribute type does not exist, the value is inappropriate for its data type, or if it is a selection list

This method is a superset of the setAttributeTypeDefaultValue method, and is subject to its access restrictions.

setAttributeTypeSelectionDefault

setAttributeTypeSelectionDefault(session_key: string, id_attr_value: string) -> int

This method makes a particular Selection Value the default for its Attribute Type (overriding any default that existed before.)

• @param id_attr_value: the ID of the Selection Value (not the ID of the Attribute Type!) that is to become the new default.

• @return: 0 if successful.

• @raise ValueError: raised if the Selection Value ID (id_attr_value) does not exist.

This method requires administrator access.

setCodeAttributes

setCodeAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_tasks (Code) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesCustom4Attributes

setCodesCustom4Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_custom_4 (CodesCustom4) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesCustom5Attributes

setCodesCustom5Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_custom_5 (CodesCustom5) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesCustom6Attributes

setCodesCustom6Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_custom_6 (CodesCustom6) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesCustom7Attributes

setCodesCustom7Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_custom_7 (CodesCustom7) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesExpense4Attributes

setCodesExpense4Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expense_4 (CodesExpense4) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesExpense5Attributes

setCodesExpense5Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expense_5 (CodesExpense5) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesExpense6Attributes

setCodesExpense6Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expense_6 (CodesExpense6) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesExpense7Attributes

setCodesExpense7Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expense_7 (CodesExpense7) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesTime4Attributes

setCodesTime4Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_time_4 (CodesTime4) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesTime5Attributes

setCodesTime5Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_time_5 (CodesTime5) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesTime6Attributes

setCodesTime6Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_time_6 (CodesTime6) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setCodesTime7Attributes

setCodesTime7Attributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_time_7 (CodesTime7) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setExpenseCodeAttributes

setExpenseCodeAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expenses (ExpenseCode) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setExpenseCurrencyAttributes

setExpenseCurrencyAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_currencies (ExpenseCurrency) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setExpenseSourceAttributes

setExpenseSourceAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_expense_sources (ExpenseSource) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setGroupAttributes

setGroupAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a groups (Group) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setMileageMeasurementAttributes

setMileageMeasurementAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_travel_measurements (MileageMeasurement) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setMileageReasonAttributes

setMileageReasonAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_travel_reasons (MileageReason) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setMileageVehicleAttributes

setMileageVehicleAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_travel_vehicles (MileageVehicle) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setPreference

setPreference(session_key: string, key: string, value: string, newpref: boolean) -> boolean

Set the value of a Journyx setting.

• @param key: The preference key to set.
• @param value: The preference value to set.
• @param newpref: Set to True if this is a new preference, False if it already exists.

Note that in typed endpoints, the value must be a string, so setting non-string preferences may not be possible. In untyped endpoints, it may be any type supported by the underlying database.

This method requires any one of the following abilities: "admin", "msp_admin", "qb_admin"

setProjectApprovalSetting

setProjectApprovalSetting(session_key: string, project_id: string, setting_type: string, value: string) -> int

Modify a project approval setting for a project.

• @param project_id: The project to modify the setting for.
• @param setting_type: The setting to modify.
• @param value: The value of the setting.
• @return: A meaningless value.

Note that non-string settings are not supported by this method in typed endpoints.

setProjectAttributes

setProjectAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a projects (Project) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setPXTeamAttributes

setPXTeamAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a px_teams (PXTeam) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setSubcodeAttributes

setSubcodeAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_pay_types (Subcode) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setSubsubcodeAttributes

setSubsubcodeAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a codes_bill_types (Subsubcode) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

setUserAttributeByLogin

setUserAttributeByLogin(session_key: string, object_id: string, id_attr_type: string, value: string, overwrite_existing: boolean) -> int

This method is used to set a single specific Attribute value for a given User Login and Attribute Type ID.

In typed endpoints, this method can only be used to set string values; no alternatives for other types are currently available.

• @param object_id: the Journyx user login of the user for whom we are setting a value.

• @param id_attr_type: the ID of the Attribute Type that we are going to set.

• @param value: the actual value to set. The type should correspond to the data-type of the Attribute Type record.

• @param overwrite_existing: if True, any existing value for this ObjectID/AttributeTypeID combination will be silently overwritten with the new value. If False, and a value already exists, an exception will be raised.

• @return: If setting the attribute was successful, then 0 is returned.

• @raise ValueError: The Object ID does not exist

• @raise ValueError: The Attribute Type ID does not exist

• @raise ValueError: The value is inappropriate for the Attribute Type For instance, a string was given when a number is required.

• @raise ValueError: If overwrite_existing is false, and a value already exists.

NOTE: You must have the 'Authority - Administrator' role ability to perform this action.

This method requires any one of the following abilities: "admin", "msp_admin", "msp_user"

setUserAttributes

setUserAttributes(session_key: string, id: string, attributes: AttributeValue[]) -> int

Set multiple attributes for a users (User) record.

See coredb for more information about this method.

This method is a superset of the setAttributesForObject method, and is subject to its access restrictions.

singleSignOnStatus

singleSignOnStatus() -> SingleSignOnStatus

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.

Returns a structure with information about whether Single Sign On is enabled. Keys:

• ssoEnabled: boolean (is SSO enabled or not?)
• loginURL: the URL to initiate SSO (will be same if SSO is not enabled)
• ssoType: a string describing the SSO type, or None/null if SSO not enabled. Currently this can be one of these values: 'Azure': if Azure SSO is enabled 'SAML': if the SAML (psauth_shib) plugin is enabled 'PSRedirectedLoginUrl': unilateral redirect to outside URL for login (rare) Null/None: if SSO is not enabled.

This method does not require a login session, and may be called by any client.

submitSheet

submitSheet(session_key: string, sheet_type: string, id: string) -> int

Submits the specified sheet for approval.

• @param sheet_type: One of 'time', 'expense', or 'mileage'.
• @param id: the ID of the sheet to check

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have one of the following group-scoped abilities over the user: 'Authority - Manager' 'Authority - Timekeeper' 'Authority - Expensekeeper' 'Authority - Mileagekeeper'

timezone

timezone() -> int

Returns the Journyx server timezone offset from UTC.

• @return: The number of seconds to subtract from UTC to get server local time.

This method does not require a login session, and may be called by any client.

uname

uname(session_key: string) -> string

Returns the name of the server operating system.

This method may be called by any logged-in user.

UnassignApprovalPlan

UnassignApprovalPlan(session_key: string, id: string, users: string[]) -> int

• @param id: The ID or name of the approval plan to unassign from the user(s).

• @param users: The list of user IDs to unassign the approval plan from.

• @return: 0

Given a string Plan ID or name, and a list of one or more user Ids, this removes the assignment of the Plan from the user(s).

An exception is raised is the user does not have the authority to do this, or if the Plan ID supplied is not valid, or if any of the user ID's are not valid.

Returns a zero to indicate that the Plan was unassigned from all given users. An exception is not raised if a user was not already assigned to the given Plan ID.

This method requires administrator access.

unassignApprovalPlan

unassignApprovalPlan(session_key: string, id: string, users: string[]) -> int

• @param id: The ID or name of the approval plan to unassign from the user(s).

• @param users: The list of user IDs to unassign the approval plan from.

• @return: 0

Given a string Plan ID or name, and a list of one or more user Ids, this removes the assignment of the Plan from the user(s).

An exception is raised is the user does not have the authority to do this, or if the Plan ID supplied is not valid, or if any of the user ID's are not valid.

Returns a zero to indicate that the Plan was unassigned from all given users. An exception is not raised if a user was not already assigned to the given Plan ID.

This method requires administrator access.

unassignApprovalPlanForUser

unassignApprovalPlanForUser(session_key: string, userid: string, plantype: string) -> int

• @param userid: The ID of the user to unassign approval plans from.

• @param plantype: The type of approval plan to remove: 'time', 'expense', 'mileage', or 'all'

• @return: 1

• @raise RuntimeError: if the user has any sheets in process

Un-assigns approval plans from a user. You cannot unassign an approval plan if the user has any sheets of that type which are still in the process of being approved. If that is the case this method will fail with an exception.

This method requires administrator access.

unhide_suggestion

unhide_suggestion(session_key: string, id_suggestion: int) -> SuggestionRecord

Restore a hidden suggestion to showable state.

• @param id_suggestion: The ID of the suggestion to unhide.
• @return: The SuggestionRecord object.

This method may be called by any logged-in user.

unhide_suggestion_series

unhide_suggestion_series(session_key: string, id_suggestion_list: int[]) -> boolean

Unhides multiple suggestion series.

Note that this method takes suggestion IDs, not series IDs. By passing it the ID of a suggestion in a series, it will unhide all events in that series, if any.

• @param id_suggestion_list: A list of suggestion IDs in the series to unhide.
• @return: Always True if no exception is thrown.

This method may be called by any logged-in user.

unhide_suggestions

unhide_suggestions(session_key: string, id_suggestion_list: int[]) -> SuggestionRecord[]

Restore multiple hidden suggestions to showable state.

• @param id_suggestion_list: A list of IDs of suggestions to unhide.
• @return: A list of the SuggestionRecord objects.

This method may be called by any logged-in user.

unhideCode

unhideCode(session_key: string, id: string) -> int

Unhide a record in the codes_tasks (Code) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesCustom4

unhideCodesCustom4(session_key: string, id: string) -> int

Unhide a record in the codes_custom_4 (CodesCustom4) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesCustom5

unhideCodesCustom5(session_key: string, id: string) -> int

Unhide a record in the codes_custom_5 (CodesCustom5) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesCustom6

unhideCodesCustom6(session_key: string, id: string) -> int

Unhide a record in the codes_custom_6 (CodesCustom6) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesCustom7

unhideCodesCustom7(session_key: string, id: string) -> int

Unhide a record in the codes_custom_7 (CodesCustom7) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesExpense4

unhideCodesExpense4(session_key: string, id: string) -> int

Unhide a record in the codes_expense_4 (CodesExpense4) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesExpense5

unhideCodesExpense5(session_key: string, id: string) -> int

Unhide a record in the codes_expense_5 (CodesExpense5) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesExpense6

unhideCodesExpense6(session_key: string, id: string) -> int

Unhide a record in the codes_expense_6 (CodesExpense6) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesExpense7

unhideCodesExpense7(session_key: string, id: string) -> int

Unhide a record in the codes_expense_7 (CodesExpense7) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesTime4

unhideCodesTime4(session_key: string, id: string) -> int

Unhide a record in the codes_time_4 (CodesTime4) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesTime5

unhideCodesTime5(session_key: string, id: string) -> int

Unhide a record in the codes_time_5 (CodesTime5) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesTime6

unhideCodesTime6(session_key: string, id: string) -> int

Unhide a record in the codes_time_6 (CodesTime6) table.

See coredb for more information about this method.

This method requires administrator access.

unhideCodesTime7

unhideCodesTime7(session_key: string, id: string) -> int

Unhide a record in the codes_time_7 (CodesTime7) table.

See coredb for more information about this method.

This method requires administrator access.

unhideExpenseCode

unhideExpenseCode(session_key: string, id: string) -> int

Unhide a record in the codes_expenses (ExpenseCode) table.

See coredb for more information about this method.

This method requires administrator access.

unhideExpenseCurrency

unhideExpenseCurrency(session_key: string, id: string) -> int

Unhide a record in the codes_currencies (ExpenseCurrency) table.

See coredb for more information about this method.

This method requires administrator access.

unhideExpenseSource

unhideExpenseSource(session_key: string, id: string) -> int

Unhide a record in the codes_expense_sources (ExpenseSource) table.

See coredb for more information about this method.

This method requires administrator access.

unhideMileageMeasurement

unhideMileageMeasurement(session_key: string, id: string) -> int

Unhide a record in the codes_travel_measurements (MileageMeasurement) table.

See coredb for more information about this method.

This method requires administrator access.

unhideMileageReason

unhideMileageReason(session_key: string, id: string) -> int

Unhide a record in the codes_travel_reasons (MileageReason) table.

See coredb for more information about this method.

This method requires administrator access.

unhideMileageVehicle

unhideMileageVehicle(session_key: string, id: string) -> int

Unhide a record in the codes_travel_vehicles (MileageVehicle) table.

See coredb for more information about this method.

This method requires administrator access.

unhideProject

unhideProject(session_key: string, id: string) -> int

Unhide a record in the projects (Project) table.

See coredb for more information about this method.

This method requires administrator access.

unhidePXTeam

unhidePXTeam(session_key: string, id: string) -> int

Unhide a record in the px_teams (PXTeam) table.

See coredb for more information about this method.

This method requires administrator access.

unhideSubcode

unhideSubcode(session_key: string, id: string) -> int

Unhide a record in the codes_pay_types (Subcode) table.

See coredb for more information about this method.

This method requires administrator access.

unhideSubsubcode

unhideSubsubcode(session_key: string, id: string) -> int

Unhide a record in the codes_bill_types (Subsubcode) table.

See coredb for more information about this method.

This method requires administrator access.

unhideUser

unhideUser(session_key: string, id: string) -> int

Unhide a record in the users (User) table.

See coredb for more information about this method.

This method requires administrator access.

updateExpenseValue

updateExpenseValue(session_key: string, id: string, value: double) -> int

• @param id: The ID of the expense record.

• @param value: The new expense value.

• @return: 0

Updates the value of an existing expense record.

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have 'Authority - Expensekeeper' over this user.

updateTimeValue

updateTimeValue(session_key: string, id: string, value: double) -> int

• @param id: The ID of the time record.

• @param value: The new number of hours to set.

• @return: 0

Updates the hours of an existing time record.

Use the updateTimeValue method when you want to change just the hours reported in an existing time record, without fetching and modifying the entire record.

NOTE: You must have the 'Authority - Administrator' role ability to perform this action for a user other than yourself, or else have 'Authority - Timekeeper' over this user.

version

version() -> string

• @return: The Journyx version number as a string.

Returns the version of the Journyx server software, which may not be exactly the same as the jxAPI version returned by the apiVersion method (since the jxAPI often does not change even though other parts of the product are updated).

This method does not require a login session, and may be called by any client.

versionArray

versionArray() -> int[]

• @return: The Journyx server actual version number as an array of 4 numbers: [majorVersion, minorVersion, maintenanceLevel, buildNumber]

This method does not require a login session, and may be called by any client.

versionCheck

versionCheck(major: int, minor: int, revision: int, patchlevel: int) -> int

• @param major: The major version number to check.

• @param minor: The minor version number to check.

• @param revision: The update number to check.

• @param patchlevel: The maintenance version number to check.

• @return: 1 if the version matches, 0 otherwise.

Checks a specified set of version numbers and returns an integer 1 if the jxAPI is running the specified version.

This method does not require a login session, and may be called by any client.

whoami

whoami(session_key: string) -> string

Identify the current user.

• @return: The ID (not the login!) of the calling user.

This method may be called by any logged-in user.