Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
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_datestringRequired within parentThe date when this accrual becomes effective
accrual_typestringOptionalThe 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
commentstringOptionalThe comment for this accrual. This is required if the leave policy requires a comment on accruals.
created_atstringRequired within parentRecord creation date
expiration_datestringOptionalThe date when this accrual expires (if applicable)
grantorModelOptionalExpand Create a new leave accrual — response body — grantor
grantor_idstringRequired within parentThe ID of the worker who granted this accrual. This is typically the Time Off admin.
idstringRequired within parentIdentifier field
leave_type_idstringRequired within parentThe company leave type ID associated with this accrual
monetary_amount_accruedJSONOptional
monetary_amount_accrued (anyOf 1)numberAlternativeThe monetary value of this accrual (for policies with monetary tracking)
monetary_amount_accrued (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_daysJSONOptional
num_days (anyOf 1)numberAlternativeThe number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.
num_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_hoursJSONOptional
num_hours (anyOf 1)numberAlternativeThe number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.
num_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Create a new leave accrual — response body — worker
worker_idstringRequired within parentThe 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.