Skip to main content

ExpenseEntryScreensCollectionResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true
uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users
$countinteger

The total number of items matching the query; not the number of items in the current response.

Example: 100
$skipinteger

The number of items skipped in the query; in other words, the offset of the first item in the current response compared to the total set of items in the collection. When used as a query parameter, this is the number of items to skip over.

Example: 0
$topinteger

The number of items returned in the current response. When used as a query parameter, this is the maximum number of items to return.

Example: 10
@nextLinkstring

The URL to fetch the next set (page) of results.

Example: https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10
results object[]

An Entry Screen is the configuration of the Entry Sheet, including the fields and layout of the sheet, as well as the Entry Periods assigned to the sheet, which defines the time period such as weekly, bi-weekly, etc. The Entry Screen config determines which Entry Columns appear on a user's entry sheet, and in what order, along with many other entry screen configuration options.

  • Array [
    • iduuid

    The internal ID of the resource or object.

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

    Example: 64BBA147B9AC41D9978062300826C89F
    uriuri-reference

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

    Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F
    tablenamestring

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

    Example: users
    table_labelstring

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

    Example: codes_pay_types
    creatorstring

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

    Example: 64BBA147B9AC41D9978062300826C89F
    creator_fullnamestring

    The full name of the user who created the object.

    Example: John Doe
    creator_properties object

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

    expense_guistring

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

    time_guistring

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

    travel_guistring

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

    daysinlistinteger

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

    emailstring

    The email address of the user.

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

    first_namestring

    The first name of the user.

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

    id_userstring

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

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

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

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

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

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

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

    reserved2float

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

    reserved3float

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

    timerecs_outinteger

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

    time_gui_propertiesobject

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

    travel_gui_propertiesobject

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

    expense_gui_propertiesobject

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

    create_timestampfloat

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

    Example: 1696021987.01375
    create_timestamp_date_longstring

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

    Example: Wednesday, March 22, 2023
    create_timestamp_date_shortstring

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

    Example: 03/22/2023
    create_timestamp_datetime_longstring

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

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

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

    Example: 03/22/2023 12:18:46 CDT
    create_timestamp_isodate-time

    The creation timestamp in ISO 8601 format.

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

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

    Example: 64BBA147B9AC41D9978062300826C89F
    modifier_fullnamestring

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

    Example: John Doe
    modifier_properties object

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

    expense_guistring

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

    time_guistring

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

    travel_guistring

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

    daysinlistinteger

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

    emailstring

    The email address of the user.

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

    first_namestring

    The first name of the user.

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

    id_userstring

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

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

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

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

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

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

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

    reserved2float

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

    reserved3float

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

    timerecs_outinteger

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

    time_gui_propertiesobject

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

    travel_gui_propertiesobject

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

    expense_gui_propertiesobject

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

    modify_timestampfloat

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

    Example: 1696021987.01375
    modify_timestamp_date_longstring

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

    Example: Wednesday, March 22, 2023
    modify_timestamp_date_shortstring

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

    Example: 03/22/2023
    modify_timestamp_datetime_longstring

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

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

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

    Example: 03/22/2023 12:18:46 CDT
    modify_timestamp_isodate-time

    The last modification timestamp in ISO 8601 format.

    Example: 2023-03-22T12:18:46-05:00
    group_names object[]

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

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

    See GroupFields for additional information about Groups and this field.

  • Array [
    • iduuid

    The Group ID.

    pnamestring

    The Group name.

    uristring

    The URI of the Group.

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

  • ]
    • id_domainstring

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

    Example: install_root_dom
    id_guistring

    The internal ID of the Entry Screen config. Same as the id field.

    Example: 81740F5FC7334279B91B6B8E1421F5BA
    allocated_must_match_punchesboolean

    If true, the total time allocated for a day (among project time) must be equal to the total time punched in for that day. If false, the two values can be different.

    Example: true
    anchorstring

    This field controls the display of the Project Tree on entry screens.

    • yes - show inline tree
    • popup - show popup tree
    • no - don't show tree

    Possible values: [yes, popup, no]

    Example: yes
    arrowsboolean

    If true, the Entry Screen will display arrows to navigate between periods. Otherwise, the arrows will not be shown.

    Example: true
    attachment_ruleinteger

    The attachment rule for this Entry Screen which determines which types of files can be attached.

    • 0 - any file type
    • 1 - images and PDFs only
    • 2 - PDFs only
    • 3 - images only

    Possible values: [0, 1, 2, 3]

    Example: 0
    auto_addnumber

    If 1, automatically add this Entry Screen to new Groups.

    Possible values: [0, 1]

    Example: 1
    backwardsnumber

    If 1, the period navigation arrows (backwards/forwards) will be reversed, such that the left arrow moves forward in time.

    Possible values: [0, 1]

    Example: 1
    blankrowsstring

    The number of blank rows to show. If value is u then it's the user preference.

    Example: 2
    comment_defaultstring

    The default value for the Comment field.

    Example: null
    comment_max_charsinteger

    The maximum number of characters allowed in the Comment field.

    Example: 255
    comment_priorityinteger

    The priority (ordering) of the Comment field. Higher numbers appear to the left. 0 is disabled.

    Example: 12
    days_backstring

    Unused legacy field.

    Example: u
    default_vue_screenstring

    The default viewing mode for "modern" (Vue) Entry Screens, either day or period.

    Possible values: [day, period]

    Example: day
    diary_notesnumber

    If 1, use "Entry Field Notes", which allow comments to be attached to individual days for each entry row.

    Example: 1
    gridnumber

    This defines the basic type of Entry Screen. For Expense Entry and Custom Entry, only type 1 is available. The rest are Time Entry only.

    • 0 - a "Line Item Entry" screen
    • 1 - a normal "Grid" entry screen (most common)
    • 2 - Allocation entry with manual in/out times
      • Also known as "Display in/out times at the top of the entry screen" with "Manually enter the in/out times"
    • 3 - Allocation Entry with Punch In/Out times
      • "Display in/out times at the top of the entry screen" with "Press a button to populate the in/out times"
    • 4 - Allocation entry with button to punch in/out with automatic Time Entry creation from Punches.
      • "Display in/out times at the top of the entry screen" with "Press a button to populate the in/out times and create default time entry "
    • 5 - "Summary Entry Screen" (Vue based)
    • 6 - Job Start/Stop Entry Screen (Vue based)

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Example: 1
    group_defaultstring

    The default value for the Group field. The Group field (as an Entry Column) is normally disabled in most configurations.

    Example: null
    group_priorityinteger

    The priority (ordering) of the Group field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    hiddenboolean

    If true, the Entry Screen is hidden; it is not a member of any groups and is not visible to or usable by anyone other than administrators.

    Example: false
    id_timesheetstring

    The "Entry Period" associated with this Entry Screen, which defines the date range / time period of the entry screen. See List Entry Periods.

    Example: default_weekly
    javascriptboolean

    This is a legacy setting and is no longer used.

    Example: true
    last_modifiedstring

    Legacy setting; see modify_timestamp and related fields instead.

    Example: 1695752609.754111
    max_attachmentsinteger

    The maximum number of file attachments (e.g. receipt images) allowed across the entire entry screen (the full entry period).

    Example: 20
    minute_incrementnumber

    The time increment for time entry in minutes.

    Example: 5
    pnamestring

    The name of the Entry Screen.

    Example: Weekly Time Entry
    post_htmlstring

    Additional raw HTML to display at the bottom of the Entry Screen.

    Example: <h3>Please submit your sheets weekly</h3>
    pre_htmlstring

    Additional raw HTML to display at the top of the Entry Screen.

    Example: <h2>ExampleCo Timesheets</h2>
    project_defaultstring

    The default value for the Project field.

    Example: root
    project_priorityinteger

    The priority (ordering) of the Project field. Higher numbers appear to the left. 0 is disabled.

    Example: 12
    row_ordernumber

    Unused legacy field.

    Example: 0
    show_interim_submitboolean

    If true, enable "Interim Submit" button. This allows a user to submit their time for approval before the end of the period and a final submission.

    Example: true
    show_mileage_entrystring

    Unused legacy field.

    Example: null
    show_project_descboolean

    If true, show the Project Description in addition to the Project Name.

    Example: true
    sidewaysnumber

    Unused legacy field.

    startstopnumber

    Unused legacy field.

    Example: 0
    submit_messagestring

    A custom message to display to users in a confirmation dialog when they submit their time.

    Example: Have you reviewed your time for the week?
    submit_warnings_messagestring

    A custom message to display to users in a confirmation dialog when they submit their entry sheet when there are warnings present, e.g., validation rule problems.

    Example: You have warnings on your sheet. Are you sure you want to submit?
    text2_defaultstring

    The default value for the Text2 field.

    Example: null
    text2_max_charsinteger

    The maximum number of characters allowed in the Text2 field.

    Example: 255
    text2_priorityinteger

    The priority (ordering) of the Text2 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    text3_defaultstring

    The default value for the Text3 field.

    Example: null
    text3_max_charsinteger

    The maximum number of characters allowed in the Text3 field.

    Example: 255
    text3_priorityinteger

    The priority (ordering) of the Text3 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    totalsstring

    How totals are shown for rows and columns:

    • n - none - don't show totals
    • r - rows - show totals for rows only
    • c - columns - show totals for columns only
    • b - both - show totals for rows and columns

    Possible values: [n, r, c, b]

    Example: b
    use_24_hourboolean

    If true, use 24-hour time format. If false, use 12-hour format.

    Example: false
    use_deps_for_hiddenboolean

    If true, apply Project and Column Dependencies to hidden columns

    Example: true
    use_suggestionsboolean

    If true, allow use of "Suggestions" (e.g. from Outlook calendar) on this Entry Screen.

    code_expense_4_defaultstring

    The default value for the Expense Code 4 field.

    This is the codes_expense_4 Entry Code.

    Example: null
    code_expense_4_priorityinteger

    The priority (ordering) of the Expense Code 4 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    code_expense_5_defaultstring

    The default value for the Expense Code 5 field.

    This is the codes_expense_5 Entry Code.

    Example: null
    code_expense_5_priorityinteger

    The priority (ordering) of the Expense Code 5 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    code_expense_6_defaultstring

    The default value for the Expense Code 6 field.

    This is the codes_expense_6 Entry Code.

    Example: null
    code_expense_6_priorityinteger

    The priority (ordering) of the Expense Code 6 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    code_expense_7_defaultstring

    The default value for the Expense Code 7 field.

    This is the codes_expense_7 Entry Code.

    Example: null
    code_expense_7_priorityinteger

    The priority (ordering) of the Expense Code 7 field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    expense_defaultstring

    The default value for the "Expense Code" field.

    This is the codes_expenses Entry Code.

    Example: null
    expense_priorityinteger

    The priority (ordering) of the Expense Code field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    source_defaultstring

    The default value for the Expense Source field.

    This is the codes_expense_sources Entry Code.

    Example: null
    source_priorityinteger

    The priority (ordering) of the Expense Source field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
    currency_defaultstring

    The default value for the Expense Currency field.

    This is the codes_currencies Entry Code.

    Example: null
    currency_priorityinteger

    The priority (ordering) of the Currency field. Higher numbers appear to the left. 0 is disabled.

    Example: 0
  • ]
    • screen object

    Defines various user interface properties for the web UI screen that this collection supports. This is an internal object that is read-only on most object endpoints and is not guaranteed to be a stable interface. This mainly defines the search filters available in the UI. This object may not be present in all collections.

    :::warning Not available in every collection

    This key (object) may not be present in all collections that refer to this schema.

    :::

    iduuid

    The internal ID of the resource or object.

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

    Example: 64BBA147B9AC41D9978062300826C89F
    uriuri-reference

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

    Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F
    tablenamestring

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

    Example: users
    table_labelstring

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

    Example: codes_pay_types
    creatorstring

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

    Example: 64BBA147B9AC41D9978062300826C89F
    creator_fullnamestring

    The full name of the user who created the object.

    Example: John Doe
    creator_properties object

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

    expense_guistring

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

    time_guistring

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

    travel_guistring

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

    daysinlistinteger

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

    emailstring

    The email address of the user.

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

    first_namestring

    The first name of the user.

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

    id_userstring

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

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

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

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

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

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

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

    reserved2float

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

    reserved3float

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

    timerecs_outinteger

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

    time_gui_propertiesobject

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

    travel_gui_propertiesobject

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

    expense_gui_propertiesobject

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

    create_timestampfloat

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

    Example: 1696021987.01375
    create_timestamp_date_longstring

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

    Example: Wednesday, March 22, 2023
    create_timestamp_date_shortstring

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

    Example: 03/22/2023
    create_timestamp_datetime_longstring

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

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

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

    Example: 03/22/2023 12:18:46 CDT
    create_timestamp_isodate-time

    The creation timestamp in ISO 8601 format.

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

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

    Example: 64BBA147B9AC41D9978062300826C89F
    modifier_fullnamestring

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

    Example: John Doe
    modifier_properties object

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

    expense_guistring

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

    time_guistring

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

    travel_guistring

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

    daysinlistinteger

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

    emailstring

    The email address of the user.

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

    first_namestring

    The first name of the user.

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

    id_userstring

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

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

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

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

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

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

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

    reserved2float

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

    reserved3float

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

    timerecs_outinteger

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

    time_gui_propertiesobject

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

    travel_gui_propertiesobject

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

    expense_gui_propertiesobject

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

    modify_timestampfloat

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

    Example: 1696021987.01375
    modify_timestamp_date_longstring

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

    Example: Wednesday, March 22, 2023
    modify_timestamp_date_shortstring

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

    Example: 03/22/2023
    modify_timestamp_datetime_longstring

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

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

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

    Example: 03/22/2023 12:18:46 CDT
    modify_timestamp_isodate-time

    The last modification timestamp in ISO 8601 format.

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

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

    Example: install_root_dom
    allow_customizeboolean

    Indicates whether the user can customize the columns displayed in the screen.

    Example: true
    cf_filters object[]

    A list of custom field filters that are available for this screen.

  • Array [
    • id_attr_typestring

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

    Example: 2DDD372DC4D3422D9E73F6DE936C4265
    attr_typestring

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

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

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

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

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

    Description of custom field

    pnamestring

    Name of custom field

    Example: Pay Group
    id_attr_type_uristring

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

    Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9
    valuestring

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

    Example: XYZ Pay Group
  • ]
    • cf_filters_unused object[]

    A list of custom field filters that are available for this screen, but are not currently used.

  • Array [
    • id_attr_typestring

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

    Example: 2DDD372DC4D3422D9E73F6DE936C4265
    attr_typestring

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

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

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

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

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

    Description of custom field

    pnamestring

    Name of custom field

    Example: Pay Group
    id_attr_type_uristring

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

    Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9
    valuestring

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

    Example: XYZ Pay Group
  • ]
    • fields object[]

    The list of fields to show in this management screen's search results.

  • Array [
    • default_tooltipstring

    The default tooltip for the field shown when hovering over the field label.

    Example: The name of the Accrual.
    idstring

    The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).

    Example: 34
    id_attr_typestring

    If this field represents a Custom Field, this is the ID of the Custom Field Type.

    Example: null
    id_fieldstring

    The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.

    Example: id_user_properties.fullname
    id_field_globalstring

    The internal database ID for the configured field, if this is a global settings field.

    Example: 34
    id_screenstring

    The unique identifier for the screen that this field belongs to.

    Example: accruals
    is_booleanboolean

    Whether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.

    Example: false
    is_custom_fieldboolean

    Whether the field is a Custom Field.

    Example: false
    is_datetime_floatboolean

    Whether the field is a date-time field, which will be displayed as a formatted date-time value in the column.

    Example: false
    is_numericboolean

    Whether the field is a numeric field, which will be displayed as a formatted number in the column.

    Example: false
    is_percentboolean

    Whether the field is a percentage field, which will be displayed as a formatted percentage value in the column.

    Example: false
    is_truncatedboolean

    Whether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.

    Example: false
    is_urlboolean

    Whether the field is a URL field, which will be displayed as a clickable link in the column.

    Example: false
    keystring

    The key for the field, which is used to identify the field in the search results and in the API. Same as id_field.

    Example: id_user_properties.fullname
    labelstring

    The label to show for this field in the management screen search results.

    Example: Owner Name
    orderinginteger

    The order in which this field should be displayed in the search results.

    Example: 1
    properties object

    Additional extended properties of the field.

    property name*string
    searchableboolean

    Whether the field is searchable in the search panel area on the management screen.

    Example: true
    sortableboolean

    Whether the field is sortable in the search results.

    Example: true
    table_labelstring

    Label of the database table that stores field settings.

    Example: Field Config (global)
    tablenamestring

    The name of the database table that stores the field settings.

    Example: fields_config_global
    tooltipstring

    The tooltip to show for this field in the management screen search results.

    Example: The full name of the owner of this Accrual.
  • ]
    • global_allows_customizeboolean

    Indicates whether the screen's global settings allow for per-user customization of the columns displayed in the screen.

    Example: true
    id_screenstring

    The unique internal ID of this screen. (Same as id.) These are fixed values that are defined in the system.

    Example: accruals
    is_globalboolean

    Indicates whether this user is currently user global settings for this screen. If false, the user is using their own settings.

    Example: false
    other_search_filtersstring[]

    A list of other search filters that are available for this screen.

    Example: ["project","group"]
    other_search_filters_unusedstring[]

    A list of other search filters that are available for this screen, but are not currently used.

    Example: ["px_teams"]
    propertiesobject

    A list of additional properties for this screen. Currently unused.

    ExpenseEntryScreensCollectionResponse
    {
      "response_code": 200,
      "success": true,
      "uri": "https://example.apps.journyx.com/api/v1/users",
      "$count": 100,
      "$skip": 0,
      "$top": 10,
      "@nextLink": "https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10",
      "results": [
        {
          "id": "64BBA147B9AC41D9978062300826C89F",
          "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
          "tablename": "users",
          "table_label": "codes_pay_types",
          "creator": "64BBA147B9AC41D9978062300826C89F",
          "creator_fullname": "John Doe",
          "creator_properties": {
            "expense_gui": "string",
            "time_gui": "string",
            "travel_gui": "string",
            "daysinlist": 0,
            "email": "string",
            "first_name": "string",
            "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
            "last_name": "string",
            "memorized_sheet_choices": [
              {
                "value": "string",
                "text": "string"
              }
            ],
            "reserved1": "string",
            "reserved2": 0,
            "reserved3": 0,
            "timerecs_out": 0,
            "time_gui_properties": {},
            "travel_gui_properties": {},
            "expense_gui_properties": {}
          },
          "create_timestamp": 1696021987.01375,
          "create_timestamp_date_long": "Wednesday, March 22, 2023",
          "create_timestamp_date_short": "03/22/2023",
          "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
          "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
          "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
          "modifier": "64BBA147B9AC41D9978062300826C89F",
          "modifier_fullname": "John Doe",
          "modifier_properties": {
            "expense_gui": "string",
            "time_gui": "string",
            "travel_gui": "string",
            "daysinlist": 0,
            "email": "string",
            "first_name": "string",
            "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
            "last_name": "string",
            "memorized_sheet_choices": [
              {
                "value": "string",
                "text": "string"
              }
            ],
            "reserved1": "string",
            "reserved2": 0,
            "reserved3": 0,
            "timerecs_out": 0,
            "time_gui_properties": {},
            "travel_gui_properties": {},
            "expense_gui_properties": {}
          },
          "modify_timestamp": 1696021987.01375,
          "modify_timestamp_date_long": "Wednesday, March 22, 2023",
          "modify_timestamp_date_short": "03/22/2023",
          "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
          "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
          "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
          "group_names": [
            {
              "id": "5088C427E8B64EBEBE1C5B5961DB1902",
              "pname": "Sales"
            },
            {
              "id": "3553F715A6F54DAB95D0D25B08468195",
              "pname": "Accounting"
            }
          ],
          "id_domain": "install_root_dom",
          "id_gui": "81740F5FC7334279B91B6B8E1421F5BA",
          "allocated_must_match_punches": true,
          "anchor": "yes",
          "arrows": true,
          "attachment_rule": 0,
          "auto_add": 1,
          "backwards": 1,
          "blankrows": 2,
          "comment_default": null,
          "comment_max_chars": 255,
          "comment_priority": 12,
          "days_back": "u",
          "default_vue_screen": "day",
          "diary_notes": 1,
          "grid": 1,
          "group_default": null,
          "group_priority": 0,
          "hidden": false,
          "id_timesheet": "default_weekly",
          "javascript": true,
          "last_modified": "1695752609.754111",
          "max_attachments": 20,
          "minute_increment": 5,
          "pname": "Weekly Time Entry",
          "post_html": "<h3>Please submit your sheets weekly</h3>",
          "pre_html": "<h2>ExampleCo Timesheets</h2>",
          "project_default": "root",
          "project_priority": 12,
          "row_order": 0,
          "show_interim_submit": true,
          "show_mileage_entry": null,
          "show_project_desc": true,
          "sideways": 0,
          "startstop": 0,
          "submit_message": "Have you reviewed your time for the week?",
          "submit_warnings_message": "You have warnings on your sheet. Are you sure you want to submit?",
          "text2_default": null,
          "text2_max_chars": 255,
          "text2_priority": 0,
          "text3_default": null,
          "text3_max_chars": 255,
          "text3_priority": 0,
          "totals": "b",
          "use_24_hour": false,
          "use_deps_for_hidden": true,
          "use_suggestions": true,
          "code_expense_4_default": null,
          "code_expense_4_priority": 0,
          "code_expense_5_default": null,
          "code_expense_5_priority": 0,
          "code_expense_6_default": null,
          "code_expense_6_priority": 0,
          "code_expense_7_default": null,
          "code_expense_7_priority": 0,
          "expense_default": null,
          "expense_priority": 0,
          "source_default": null,
          "source_priority": 0,
          "currency_default": null,
          "currency_priority": 0
        }
      ],
      "screen": {
        "id": "64BBA147B9AC41D9978062300826C89F",
        "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
        "tablename": "users",
        "table_label": "codes_pay_types",
        "creator": "64BBA147B9AC41D9978062300826C89F",
        "creator_fullname": "John Doe",
        "creator_properties": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "daysinlist": 0,
          "email": "string",
          "first_name": "string",
          "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
          "last_name": "string",
          "memorized_sheet_choices": [
            {
              "value": "string",
              "text": "string"
            }
          ],
          "reserved1": "string",
          "reserved2": 0,
          "reserved3": 0,
          "timerecs_out": 0,
          "time_gui_properties": {},
          "travel_gui_properties": {},
          "expense_gui_properties": {}
        },
        "create_timestamp": 1696021987.01375,
        "create_timestamp_date_long": "Wednesday, March 22, 2023",
        "create_timestamp_date_short": "03/22/2023",
        "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
        "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
        "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
        "modifier": "64BBA147B9AC41D9978062300826C89F",
        "modifier_fullname": "John Doe",
        "modifier_properties": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "daysinlist": 0,
          "email": "string",
          "first_name": "string",
          "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
          "last_name": "string",
          "memorized_sheet_choices": [
            {
              "value": "string",
              "text": "string"
            }
          ],
          "reserved1": "string",
          "reserved2": 0,
          "reserved3": 0,
          "timerecs_out": 0,
          "time_gui_properties": {},
          "travel_gui_properties": {},
          "expense_gui_properties": {}
        },
        "modify_timestamp": 1696021987.01375,
        "modify_timestamp_date_long": "Wednesday, March 22, 2023",
        "modify_timestamp_date_short": "03/22/2023",
        "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
        "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
        "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
        "id_domain": "install_root_dom",
        "allow_customize": true,
        "cf_filters": [
          {
            "id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
            "attr_type": [
              "STRING_100",
              "ENUM_STRING_20",
              "M_ENUM_STRING_252",
              "ENUM_INTEGER",
              "NUMBER"
            ],
            "description": "string",
            "pname": "Pay Group",
            "id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
            "value": "XYZ Pay Group"
          }
        ],
        "cf_filters_unused": [
          {
            "id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
            "attr_type": [
              "STRING_100",
              "ENUM_STRING_20",
              "M_ENUM_STRING_252",
              "ENUM_INTEGER",
              "NUMBER"
            ],
            "description": "string",
            "pname": "Pay Group",
            "id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
            "value": "XYZ Pay Group"
          }
        ],
        "fields": [
          {
            "default_tooltip": "The name of the Accrual.",
            "id": "34",
            "id_attr_type": null,
            "id_field": "id_user_properties.fullname",
            "id_field_global": "34",
            "id_screen": "accruals",
            "is_boolean": false,
            "is_custom_field": false,
            "is_datetime_float": false,
            "is_numeric": false,
            "is_percent": false,
            "is_truncated": false,
            "is_url": false,
            "key": "id_user_properties.fullname",
            "label": "Owner Name",
            "ordering": 1,
            "properties": {},
            "searchable": true,
            "sortable": true,
            "table_label": "Field Config (global)",
            "tablename": "fields_config_global",
            "tooltip": "The full name of the owner of this Accrual."
          }
        ],
        "global_allows_customize": true,
        "id_screen": "accruals",
        "is_global": false,
        "other_search_filters": [
          "project",
          "group"
        ],
        "other_search_filters_unused": [
          "px_teams"
        ],
        "properties": {}
      }
    }