Skip to content

Rippling: Create a new leave accrual — request body — body

Create a new leave accrual: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a new leave accrual — request body — body

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
One of: 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.
expiration_datestringOptionalThe date when this accrual expires (if applicable)
grantor_idstringRequired within parentThe ID of the worker who granted this accrual. This is typically the Time Off admin.
leave_type_idstringRequired within parentThe company leave type ID associated with this accrual
monetary_amount_accruednumberOptionalThe monetary value of this accrual (for policies with monetary tracking)
num_daysnumberOptionalThe number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.
num_hoursnumberOptionalThe number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.
worker_idstringRequired within parentThe ID of the worker for whom the accrual is for

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.