TimeSheetAccrual

A time bank (accrual) showing available leave balance for a specific pay type. Only applicable to time entry sheets. The schema for accruals as shown in time sheets is slightly different than the separate accrual definition schema.

id_timebankstringrequired

Unique identifier for the time bank

Example: 6D88483CFE774250B29CC61266392DBA

pnamestringrequired

Display name of the time bank

Example: Vacation

hours_leftnumber<float>required

Remaining balance in hours

Example: 16

id_code_pay_typestring[]

Pay type codes associated with this accrual

Example: ["Vacation"]

pay_types object[]

Detailed information about associated pay types

Array [

id_code_pay_typestring

namestring

]

use_hard_thresholdboolean

Whether a hard minimum balance threshold is enforced

Example: true

hard_thresholdnumber<float>

Minimum balance that cannot be exceeded

Example: 0

hard_threshold_messagestring

Message displayed when hard threshold applies

Example: Minimum balance of 0.00 hours is enforced.

use_warningboolean

Whether a warning threshold is configured

Example: true

warning_thresholdnumber<float>

Balance level that triggers a warning

Example: 8

warning_threshold_messagestring

Message displayed when warning threshold is reached

Example: A warning is given when the balance is less than or equal to 8.00 hours.

warning_typestring

Type of warning configuration

Example: v2

errorsstring[]

Any errors related to this accrual

Example: []

warningsstring[]

Any warnings related to this accrual

Example: []

creatorstring

User who created this time bank

modifierstring

User who last modified this time bank

create_timestampnumber<double>

Unix timestamp of creation

modify_timestampnumber<double>

Unix timestamp of last modification

TimeSheetAccrual

{
  "id_timebank": "6D88483CFE774250B29CC61266392DBA",
  "pname": "Vacation",
  "hours_left": 16,
  "id_code_pay_type": [
    "Vacation"
  ],
  "pay_types": [
    {
      "id_code_pay_type": "string",
      "name": "string"
    }
  ],
  "use_hard_threshold": true,
  "hard_threshold": 0,
  "hard_threshold_message": "Minimum balance of 0.00 hours is enforced.",
  "use_warning": true,
  "warning_threshold": 8,
  "warning_threshold_message": "A warning is given when the balance is less than or equal to 8.00 hours.",
  "warning_type": "v2",
  "errors": [],
  "warnings": [],
  "creator": "string",
  "modifier": "string",
  "create_timestamp": 0,
  "modify_timestamp": 0
}