Skip to main content

Accrual

An Accrual or "time bank" is a collection of time that can be used to pay for time off. Accruals are typically used to track vacation time, sick time, and other types of paid time off.

Each accrual is tied to a user and one or more Pay Types. The accrual can have a name, a balance, and hard and soft limits. Balances can be managed manually, or can be generated through the Accrual Calculator product.

Time is deducted from the Accrual when a user creates a Time Entry for a Pay Type associated with the Accrual.

A hard limit is a minimum balance that cannot be exceeded. For example a hard limit of 0.00 hours would mean that the user cannot have a negative balance in the Accrual.

A soft limit is a balance at which the user is notified or warned that they are approaching the hard limit.

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
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

    Indicates whether the object is hidden.

    See also status

    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
    hiddenboolean

    Indicates whether the user is hidden.

    Read-only alias for is_hidden.

    statusstring

    The general visibility status of the object; either Hidden, Loggable and Reportable, or Reportable Only.

    This is a write-enabled field if you have the appropriate permissions. See also status_code which can be changed in the same way.

    Possible values: [Hidden, Loggable and Reportable, Reportable Only]

    Example: Loggable and Reportable
    status_codestring

    The internal code for the status of the object; either:

    • lr for Loggable and Reportable
    • ro for Reportable Only
    • h for Hidden

    Possible values: [lr, ro, h]

    Example: lr
    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
    id_timebankstring

    The internal ID of the Time Bank associated with this Accrual; same as the id field. This ID cannot be changed once created.

    Example: 1A40D7570AF94AFDB286D0697DEA5CF3
    limits_descriptionstring

    A generated short description of the limits for this Accrual that describes the hard and soft limits in human-readable terms.

    Example: Min 0.00
    limits_description_fullstring

    A generated description of the limits for this Accrual that describes the hard and soft limits in human-readable terms in long form.

    Example: Minimum balance of 0.00 hours is enforced.
    pay_type_namesstring[]

    The printable names (labels) 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.

    Example: ["Vacation","Sick"]
    pay_type_names_strstring

    A comma-separated string of the printable names (labels) of the Pay Types associated with this Accrual.

    Example: Vacation, Sick
    pay_type_urisstring[]

    The URIs 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.

    Example: ["/api/v1/entry_codes/codes_pay_types/Vacation","/api/v1/entry_codes/codes_pay_types/Sick"]
    warning_typestring

    An internal code that describes the format of the accrual record.

    Example: v2
    Accrual
    {
      "id_timebank": "1A40D7570AF94AFDB286D0697DEA5CF3",
      "limits_description": "Min 0.00",
      "limits_description_full": "Minimum balance of 0.00 hours is enforced.",
      "pay_type_names": [
        "Vacation",
        "Sick"
      ],
      "pay_type_names_str": "Vacation, Sick",
      "pay_type_uris": [
        "/api/v1/entry_codes/codes_pay_types/Vacation",
        "/api/v1/entry_codes/codes_pay_types/Sick"
      ],
      "warning_type": "v2",
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "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,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "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"
    }