Rippling: Evaluate a leave program evaluation

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: POST /leave-program-evaluations/. 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"]["createLeaveProgramEvaluations"]>[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.createLeaveProgramEvaluations(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.create_leave_program_evaluations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Evaluate a leave program evaluation — request body — body

Referenced models: Evaluate a leave program evaluation — request body — body

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
leave_plan	object	Required within parent	Combined leave plan derived from all non-ineligible program results. Join program_results by program_code for eligibility, pay rates, and gaps; program_contributions carry placement windows only.
leave_plan.balance_adjustments	array	Required within parent	Flattened balance adjustment directives from payable program results.
leave_plan.balance_adjustments[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — leave plan balance adjustments item
leave_plan.claim_end_date	string	Optional	Requested leave end date used for this plan, if provided.
leave_plan.claim_start_date	string	Required within parent	Requested leave start date used for this plan.
leave_plan.coverage_segments	array	Required within parent	Contiguous spans where the same program set overlaps.
leave_plan.coverage_segments[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — leave plan coverage segments item
leave_plan.earnings	array	Required within parent	Flattened payroll earning directives from payable program results.
leave_plan.earnings[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — leave plan earnings item
leave_plan.leave_request	object	Optional	Merged bookable leave request directive, if any.
leave_plan.leave_request.end_date	string	Optional	Recommended leave request end date, if known.
leave_plan.leave_request.leave_type	string	Required within parent	Leave type to use if booking a leave request from the evaluation.
leave_plan.leave_request.start_date	string	Required within parent	Recommended leave request start date.
leave_plan.leave_request.status	string	Optional	Optional leave request status to use when booking.
leave_plan.pay_periods	array	Required within parent	Estimated per-paycheck amounts when claim_end_date and pay schedule are known.
leave_plan.pay_periods[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — leave plan pay periods item
leave_plan.program_contributions	array	Required within parent	Per-program placement windows on the claim.
leave_plan.program_contributions[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — leave plan program contributions item
missing_evidence	array	Required within parent	Structured evidence gaps reported by evaluated eligibility rules.
missing_evidence[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — missing evidence item
program_results	array	Required within parent	Per-program rule outputs in evaluation order.
program_results[]	Model	Each item	Expand Evaluate a leave program evaluation — response body — program results item

Referenced models: Evaluate a leave program evaluation — response body — leave plan balance adjustments item, Evaluate a leave program evaluation — response body — leave plan coverage segments item, Evaluate a leave program evaluation — response body — leave plan earnings item, Evaluate a leave program evaluation — response body — program results item, Evaluate a leave program evaluation — response body — missing evidence item, Evaluate a leave program evaluation — response body — leave plan pay periods item, Evaluate a leave program evaluation — response body — leave plan program contributions item

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.create_leave_program_evaluations. Catalog operation: create-leave-program-evaluations. 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-program-evaluations.read-write"]

Provider entitlements: ["Internal_Testing"]

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

Official provider source