Rippling: Retrieve a specific leave accrual

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_leave_accruals

Provider route: GET /leave-accruals/{id}/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";

async function execute(input: Parameters<RipplingIntegration["restApi"]["getLeaveAccruals"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.restApi.getLeaveAccruals(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rest_api.get_leave_accruals(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
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: Retrieve a report run — response body — meta redacted fields item, Create a new leave accrual — response body — grantor, Create a new leave accrual — response body — worker

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_leave_accruals. Catalog operation: get-leave-accruals. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["leave-accruals.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source