Skip to main content

AccrualModifiableFields

These are fields in the Accrual ("Time Bank") object that can be modified or given as input when creating a new Accrual.

hard_thresholdfloat

The hard threshold for the Accrual. If the Accrual balance drops below this value, the user cannot create new Time Entries using this Accrual. A typical hard threshold is 0.0.

Example: 0
hours_leftfloat

The number of hours left in the Accrual - the hours balance.

Example: 40
id_userstring

The internal ID of the User associated with this Accrual. Once set, this value cannot be changed.

Example: 64BBA147B9AC41D9978062300826C89F
id_user_properties object

The properties associated with the user who owns this Accrual. Note that this key may not be present unless requested in the $keys parameter.

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.

    is_hiddenboolean

    If true, this Accrual is hidden from the user interface. A hidden accrual can still be enforced, but the user will not see a listing of the accrual in the user interface and will not see the available balance.

    Example: false
    pay_type_idsstring[]required

    The internal IDs of the Pay Types associated with this Accrual. These Pay Types are the types of time that can be used to pay for time off.

    pnamestringrequired

    The name of the Accrual. Typically this is the name of the main Pay Type associated with the Accrual, but it can be any name. This will be displayed to the end user.

    Example: Vacation
    use_hard_thresholdboolean

    If true, the hard threshold is enforced. If false, the hard threshold is ignored.

    Example: true
    use_warningboolean

    If true, the warning ("soft") threshold is enforced. If false, the warning threshold is ignored.

    Example: true
    warning_thresholdfloat

    The warning threshold for the Accrual. If the Accrual balance drops below this value, the user is notified or warned that they are approaching the hard limit. An example warning threshold is 16.0.

    Example: 16
    AccrualModifiableFields
    {
      "hard_threshold": 0,
      "hours_left": 40,
      "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": {}
      },
      "is_hidden": false,
      "pay_type_ids": [
        "string"
      ],
      "pname": "Vacation",
      "use_hard_threshold": true,
      "use_warning": true,
      "warning_threshold": 16
    }