Skip to main content

LeaveRequest

A leave request. Depending on the system configuration, this will not be converted to a Time Entry until it is approved and the user has loaded and saved their Time Entry screen.

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
record_datedaterequired

The date of the Leave Request in YYYYMMDD format.

Example: 20210101
time_amountfloatrequired

The amount of time requested off in hours.

Example: 8
id_code_pay_typestringrequired

The unique identifier of the Pay Type for the Leave Request.

Example: 64BBA147B9AC41D9978062300826C89F
id_projectstringrequired

The unique identifier of the Project for the Leave Request.

Example: 1A40D7570AF94AFDB286D0697DEA5CF3
id_code_taskstringrequired

The unique identifier of the Task for the Leave Request.

Example: 11B6C411BC414E9C9442C0606B4C4AD4
id_code_bill_typestringrequired

The unique identifier of the Bill Type for the Leave Request.

Example: 1F9E41337EA341219D9D1D023F1D8C24
id_code_time_4string

The unique identifier of the "Time Entry Code 4" field for the Leave Request. Note that this field may not be available in your specific Journyx configuration.

Example: B23991FEE6464610B0B8896F5FBB9777
id_code_time_5string

The unique identifier of the "Time Entry Code 5" field for the Leave Request. Note that this field may not be available in your specific Journyx configuration.

Example: B23991FEE6464610B0B8896F5FBB9777
id_code_time_6string

The unique identifier of the "Time Entry Code 6" field for the Leave Request. Note that this field may not be available in your specific Journyx configuration.

Example: B23991FEE6464610B0B8896F5FBB9777
id_code_time_7string

The unique identifier of the "Time Entry Code 7" field for the Leave Request. Note that this field may not be available in your specific Journyx configuration.

Example: B23991FEE6464610B0B8896F5FBB9777
id_groupstring

The unique identifier of the "Group" Entry Column field for the Leave Request. Note that this field may not be available in your specific Journyx configuration.

Example: B23991FEE6464610B0B8896F5FBB9777
commentstringrequired

A comment or description of the Leave Request.

Example: Vacation to Belize
enforce_accrualsboolean

If true, any Accruals (Time Bank) limitations will be enforced when the Leave Request is created or modified. If false, the enforcement will only happen when the Leave Request is converted to a Time Entry and submitted for approval.

Example: true
id_holiday_typestring

The unique identifier of the Holiday Type for the Leave Request.

Example: 1F9E41337EA341219D9D1D023F1D8C24
notestring

A note or additional information about the Leave Request that can be seen by the approver. This does not appear on the Time Entry.

Example: This is a note about why I'm requesting leave.
text2string

A second comment-style Entry Column text field that can be used for additional information about the Leave Request.

This field may not be available in your specific Journyx configuration.

Example: This is a second text field.
text3string

A third comment-style Entry Column text field that can be used for additional information about the Leave Request.

This field may not be available in your specific Journyx configuration.

Example: This is the third text field.
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
    commit_stateinteger

    Internal field; do not use.

    Example: 0
    decline_datedate-time

    The date the leave request was declined or approved in YYYYMMDD format. Note: despite the name, this field is used for both declined and approved requests.

    Example: 20241031
    extrabigstring

    This field is not in use.

    Example: null
    extraintinteger

    This field is not in use.

    Example: null
    extramidstring

    This field is not in use.

    Example: null
    extrasmsstring

    This field is not in use.

    Example: null
    id_rejectorstring

    The internal ID of the user who rejected or approved the leave request. Note: despite the name, this field is used for both declined and approved requests.

    Example: 64BBA147B9AC41D9978062300826C89F
    id_request_recstring

    The internal ID of the leave request record; the same as the id field. Cannot be changed.

    Example: 1A40D7570AF94AFDB286D0697DEA5CF3
    id_userstring

    The internal ID of the user who "owns" the leave request.

    This cannot be changed once the leave request is created.

    Example: 64BBA147B9AC41D9978062300826C89F
    id_user_properties object

    Additional properties of the user who owns the leave request.

    Note that this key may not be present unless requested in the $keys parameter.

    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.

    reasonstring

    The decline reason given by the approver, if any.

    Example: Declined because XYZ
    reject_flaginteger

    The flag indicating the current approval status of the Leave Request. The same information can be found in text form in the status field. Values are:

    • 0 == Pending
    • 1 == Declined
    • 2 == Approved

    Note: this field is read-only. You can Approve or Decline at another endpoint.

    Possible values: [0, 1, 2]

    Example: 0
    statusstring

    The status of the leave request. Values can be: Pending, Approved, Declined.

    Note: this field is read-only. You can Approve or Decline at another endpoint.

    submit_datedate-time

    The date the leave request was submitted in YYYYMMDD format.

    Example: 20241031
    LeaveRequest
    {
      "commit_state": 0,
      "decline_date": "20241031",
      "extrabig": null,
      "extraint": null,
      "extramid": null,
      "extrasms": null,
      "id_rejector": "64BBA147B9AC41D9978062300826C89F",
      "id_request_rec": "1A40D7570AF94AFDB286D0697DEA5CF3",
      "id_user": "64BBA147B9AC41D9978062300826C89F",
      "id_user_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": {}
      },
      "reason": "Declined because XYZ",
      "reject_flag": 0,
      "status": "string",
      "submit_date": "20241031",
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "record_date": "20210101",
      "time_amount": 8,
      "id_code_pay_type": "64BBA147B9AC41D9978062300826C89F",
      "id_project": "1A40D7570AF94AFDB286D0697DEA5CF3",
      "id_code_task": "11B6C411BC414E9C9442C0606B4C4AD4",
      "id_code_bill_type": "1F9E41337EA341219D9D1D023F1D8C24",
      "id_code_time_4": "B23991FEE6464610B0B8896F5FBB9777",
      "id_code_time_5": "B23991FEE6464610B0B8896F5FBB9777",
      "id_code_time_6": "B23991FEE6464610B0B8896F5FBB9777",
      "id_code_time_7": "B23991FEE6464610B0B8896F5FBB9777",
      "id_group": "B23991FEE6464610B0B8896F5FBB9777",
      "comment": "Vacation to Belize",
      "enforce_accruals": true,
      "id_holiday_type": "1F9E41337EA341219D9D1D023F1D8C24",
      "note": "This is a note about why I'm requesting leave.",
      "text2": "This is a second text field.",
      "text3": "This is the third text field.",
      "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"
    }