Skip to content

Rippling: Evaluate a leave program evaluation

Rippling restApi.createLeaveProgramEvaluations: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_leave_program_evaluations

Provider route: POST /leave-program-evaluations/. Alter supplies the connection’s credentials and routing.

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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Evaluate a leave program evaluation — request body — body

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

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

FieldTypePresenceDescription and constraints
$objectRoot
leave_planobjectRequired within parentCombined 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_adjustmentsarrayRequired within parentFlattened balance adjustment directives from payable program results.
leave_plan.balance_adjustments[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan balance adjustments item
leave_plan.claim_end_datestringOptionalRequested leave end date used for this plan, if provided.
leave_plan.claim_start_datestringRequired within parentRequested leave start date used for this plan.
leave_plan.coverage_segmentsarrayRequired within parentContiguous spans where the same program set overlaps.
leave_plan.coverage_segments[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan coverage segments item
leave_plan.earningsarrayRequired within parentFlattened payroll earning directives from payable program results.
leave_plan.earnings[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan earnings item
leave_plan.leave_requestobjectOptionalMerged bookable leave request directive, if any.
leave_plan.leave_request.end_datestringOptionalRecommended leave request end date, if known.
leave_plan.leave_request.leave_typestringRequired within parentLeave type to use if booking a leave request from the evaluation.
leave_plan.leave_request.start_datestringRequired within parentRecommended leave request start date.
leave_plan.leave_request.statusstringOptionalOptional leave request status to use when booking.
leave_plan.pay_periodsarrayRequired within parentEstimated per-paycheck amounts when claim_end_date and pay schedule are known.
leave_plan.pay_periods[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan pay periods item
leave_plan.program_contributionsarrayRequired within parentPer-program placement windows on the claim.
leave_plan.program_contributions[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan program contributions item
missing_evidencearrayRequired within parentStructured evidence gaps reported by evaluated eligibility rules.
missing_evidence[]ModelEach itemExpand Evaluate a leave program evaluation — response body — missing evidence item
program_resultsarrayRequired within parentPer-program rule outputs in evaluation order.
program_results[]ModelEach itemExpand 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

6 more schemas are linked from the tables above, on the schema pages.

Evaluate a leave program evaluation — response body — leave plan balance adjustments item
FieldTypePresenceDescription and constraints
$objectRoot
accrual_typestringOptionalAccrual type to use when applying the adjustment.
amountstringRequired within parentAdjustment amount serialized as a decimal string.
leave_typestringRequired within parentLeave type to adjust if applying the evaluation.
unitstringRequired within parentUnit for the adjustment amount, such as WEEKS, DAYS, or HOURS.
Evaluate a leave program evaluation — response body — leave plan coverage segments item
FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalSegment end date, if known.
program_codesarrayRequired within parentPrograms active over this segment.
program_codes[]stringEach item
start_datestringRequired within parentSegment start date.
Evaluate a leave program evaluation — response body — leave plan earnings item
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentEarning amount serialized as a decimal string.
currencystringOptionalISO 4217 currency code for the earning amount.
earning_typestringRequired within parentEarning type to use if booking a payroll earning from the evaluation.
weeksstringOptionalNumber of benefit weeks represented by this earning, serialized as a decimal string.
Evaluate a leave program evaluation — response body — program results item
FieldTypePresenceDescription and constraints
$objectRoot
componentsarrayOptionalLegacy explanatory components for this program.
components[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item components item
directivesModelOptionalExpand Evaluate a leave program evaluation — response body — program results item directives
eligibilitystringRequired within parentDerived eligibility status for this program.
Known values: eligible, ineligible, partially_eligible
entitlementobjectOptionalTime entitlement for this program, if any.
entitlement.amountstringRequired within parentEntitlement amount serialized as a decimal string.
entitlement.leave_typestringRequired within parentLeave type associated with the entitlement.
entitlement.unitstringRequired within parentUnit for the entitlement amount, such as WEEKS, DAYS, or HOURS.
gapsarrayRequired within parentUNKNOWN evidence keys to fix before eligibility can be fully resolved.
gaps[]stringEach item
is_payablebooleanRequired within parentWhether the result is eligible and not blocked by payment-blocking requirements.
job_protectionobjectOptionalJob-protection details for this program, if any.
job_protection.continues_group_healthbooleanOptionalWhether the program continues group health coverage.
job_protection.restorationstringRequired within parentJob-restoration right provided by the program.
pay_rateobjectOptionalEstimated wage-replacement rate for this program, if any.
pay_rate.phasesarrayRequired within parentWage-replacement phases for the program.
pay_rate.phases[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item pay rate phases item
pay_sourcestringOptionalWho pays the employee for this program's wage-replacement slice.
Known values: GOVERNMENT, CARRIER, EMPLOYER
pay_summarystringOptionalHuman-readable pay summary for this program.
program_codestringRequired within parentLeave program code evaluated by the rules engine.
program_requirementsarrayOptionalOutstanding artifacts or actions for this program.
program_requirements[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item program requirements item
program_validationsarrayRequired within parentEligibility and assumption validations run for this program.
program_validations[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item program validations item

Referenced models: Evaluate a leave program evaluation — response body — program results item pay rate phases item, Evaluate a leave program evaluation — response body — program results item program requirements item, Evaluate a leave program evaluation — response body — program results item program validations item, Evaluate a leave program evaluation — response body — program results item components item, Evaluate a leave program evaluation — response body — program results item directives

Evaluate a leave program evaluation — response body — missing evidence item
FieldTypePresenceDescription and constraints
$objectRoot
answer_typestringRequired within parentExpected answer type for this evidence key.
keystringRequired within parentStable evidence key that can be supplied in supplemental_evidence.
labelstringRequired within parentHuman-readable label for the missing evidence.
program_codesarrayRequired within parentLeave program codes that reported this missing evidence.
program_codes[]stringEach item
Evaluate a leave program evaluation — response body — leave plan pay periods item
FieldTypePresenceDescription and constraints
$objectRoot
carrier_totalobjectOptionalTotal estimated carrier-paid amount in this pay period.
carrier_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
carrier_total.currencystringRequired within parentISO 4217 currency code for the amount.
contributionsarrayRequired within parentEstimated program-level pay slices in this pay period.
contributions[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item
employer_totalobjectOptionalTotal estimated employer-paid amount in this pay period.
employer_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
employer_total.currencystringRequired within parentISO 4217 currency code for the amount.
government_totalobjectOptionalTotal estimated government-paid amount in this pay period.
government_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
government_total.currencystringRequired within parentISO 4217 currency code for the amount.
period_endstringRequired within parentEstimated pay period end date.
period_startstringRequired within parentEstimated pay period start date.
totalobjectOptionalTotal estimated amount in this pay period.
total.amountstringRequired within parentDecimal monetary amount serialized as a string.
total.currencystringRequired within parentISO 4217 currency code for the amount.

Referenced models: Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item

Evaluate a leave program evaluation — response body — leave plan program contributions item
FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalProgram placement end date, if known.
leave_typestringOptionalLeave type associated with this program placement.
leave_type_labelstringOptionalHuman-readable leave type label.
pay_statusstringRequired within parentWhether this program has an estimated pay rate.
Known values: NOT_APPLICABLE, ESTIMATED
program_codestringRequired within parentLeave program code active on this claim window.
start_datestringRequired within parentProgram placement start date.
Evaluate a leave program evaluation — response body — program results item pay rate phases item
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentPay amount for this phase serialized as a decimal string.
currencystringOptionalISO 4217 currency code for this pay phase.
duration_daysJSONOptional
duration_days (anyOf 1)integerAlternativeNumber of days this phase lasts. Null means the phase runs to the window end.
duration_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unitstringOptionalPay-rate unit for this phase, such as DAILY, WEEKLY, or BIWEEKLY.
Evaluate a leave program evaluation — response body — program results item program requirements item
FieldTypePresenceDescription and constraints
$objectRoot
blocks_paymentbooleanOptionalWhether this requirement blocks payment until resolved.
keystringRequired within parentMachine-readable requirement key.
summarystringRequired within parentHuman-readable requirement summary.

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

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.