Rippling: List leave accruals — response body — results item
List leave accruals: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List leave accruals — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave accrual resource representing time off credits granted to employees. Leave accruals track the allocation of paid time off (vacation, sick days, etc.) to employees based on company policies, manual grants, or other accrual sources. |
accrual_date | string | Required within parent | The date when this accrual becomes effective |
accrual_type | string | Optional | The type of accrual Known values: AUTO, CARRYOVER_PENALTY, RESET_PENALTY, RESET_NEGATIVE_PENALTY, BALANCE_PENALTY, LEAVE_GRANT, BALANCE_CORRECTION_ADJUSTMENT, PAID_OUT, SUB_BALANCE_EXPIRATION, TANDA_ACCRUAL_BONUS, TILT_ADJUSTMENT, WORKFLOW_ACTION, EXPIRATION_DEDUCTION, EXPIRATION_PAYOUT, MANUAL_BALANCE_PAYOUT, CARRYOVER_PENALTY_PAYOUT, RESET_PENALTY_PAYOUT, HOLIDAY_ADJUSTMENT, HOURS_WORKED_TANDA, TENURE_MILESTONE, FR_COP_FRACTIONNEMENT |
comment | string | Optional | The comment for this accrual. This is required if the leave policy requires a comment on accruals. |
created_at | string | Required within parent | Record creation date |
expiration_date | string | Optional | The date when this accrual expires (if applicable) |
grantor | Model | Optional | Expand Create a new leave accrual — response body — grantor |
grantor_id | string | Required within parent | The ID of the worker who granted this accrual. This is typically the Time Off admin. |
id | string | Required within parent | Identifier field |
leave_type_id | string | Required within parent | The company leave type ID associated with this accrual |
monetary_amount_accrued | JSON | Optional | |
monetary_amount_accrued (anyOf 1) | number | Alternative | The monetary value of this accrual (for policies with monetary tracking) |
monetary_amount_accrued (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_days | JSON | Optional | |
num_days (anyOf 1) | number | Alternative | The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days. |
num_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_hours | JSON | Optional | |
num_hours (anyOf 1) | number | Alternative | The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours. |
num_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Create a new leave accrual — response body — worker |
worker_id | string | Required within parent | The ID of the worker for whom the accrual is for |
Referenced models: Create a new leave accrual — response body — grantor, Create a new leave accrual — response body — worker