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.
Call through Alter
Section titled “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 osfrom alter_sdk import Appfrom 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()| 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
Section titled “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
Schemas
Section titled “Schemas”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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_type | string | Optional | Accrual type to use when applying the adjustment. |
amount | string | Required within parent | Adjustment amount serialized as a decimal string. |
leave_type | string | Required within parent | Leave type to adjust if applying the evaluation. |
unit | string | Required within parent | Unit for the adjustment amount, such as WEEKS, DAYS, or HOURS. |
Evaluate a leave program evaluation — response body — leave plan coverage segments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | Segment end date, if known. |
program_codes | array | Required within parent | Programs active over this segment. |
program_codes[] | string | Each item | |
start_date | string | Required within parent | Segment start date. |
Evaluate a leave program evaluation — response body — leave plan earnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Earning amount serialized as a decimal string. |
currency | string | Optional | ISO 4217 currency code for the earning amount. |
earning_type | string | Required within parent | Earning type to use if booking a payroll earning from the evaluation. |
weeks | string | Optional | Number of benefit weeks represented by this earning, serialized as a decimal string. |
Evaluate a leave program evaluation — response body — program results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
components | array | Optional | Legacy explanatory components for this program. |
components[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item components item |
directives | Model | Optional | Expand Evaluate a leave program evaluation — response body — program results item directives |
eligibility | string | Required within parent | Derived eligibility status for this program. Known values: eligible, ineligible, partially_eligible |
entitlement | object | Optional | Time entitlement for this program, if any. |
entitlement.amount | string | Required within parent | Entitlement amount serialized as a decimal string. |
entitlement.leave_type | string | Required within parent | Leave type associated with the entitlement. |
entitlement.unit | string | Required within parent | Unit for the entitlement amount, such as WEEKS, DAYS, or HOURS. |
gaps | array | Required within parent | UNKNOWN evidence keys to fix before eligibility can be fully resolved. |
gaps[] | string | Each item | |
is_payable | boolean | Required within parent | Whether the result is eligible and not blocked by payment-blocking requirements. |
job_protection | object | Optional | Job-protection details for this program, if any. |
job_protection.continues_group_health | boolean | Optional | Whether the program continues group health coverage. |
job_protection.restoration | string | Required within parent | Job-restoration right provided by the program. |
pay_rate | object | Optional | Estimated wage-replacement rate for this program, if any. |
pay_rate.phases | array | Required within parent | Wage-replacement phases for the program. |
pay_rate.phases[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item pay rate phases item |
pay_source | string | Optional | Who pays the employee for this program's wage-replacement slice. Known values: GOVERNMENT, CARRIER, EMPLOYER |
pay_summary | string | Optional | Human-readable pay summary for this program. |
program_code | string | Required within parent | Leave program code evaluated by the rules engine. |
program_requirements | array | Optional | Outstanding artifacts or actions for this program. |
program_requirements[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item program requirements item |
program_validations | array | Required within parent | Eligibility and assumption validations run for this program. |
program_validations[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer_type | string | Required within parent | Expected answer type for this evidence key. |
key | string | Required within parent | Stable evidence key that can be supplied in supplemental_evidence. |
label | string | Required within parent | Human-readable label for the missing evidence. |
program_codes | array | Required within parent | Leave program codes that reported this missing evidence. |
program_codes[] | string | Each item |
Evaluate a leave program evaluation — response body — leave plan pay periods item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
carrier_total | object | Optional | Total estimated carrier-paid amount in this pay period. |
carrier_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
carrier_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
contributions | array | Required within parent | Estimated program-level pay slices in this pay period. |
contributions[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item |
employer_total | object | Optional | Total estimated employer-paid amount in this pay period. |
employer_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
employer_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
government_total | object | Optional | Total estimated government-paid amount in this pay period. |
government_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
government_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
period_end | string | Required within parent | Estimated pay period end date. |
period_start | string | Required within parent | Estimated pay period start date. |
total | object | Optional | Total estimated amount in this pay period. |
total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
total.currency | string | Required within parent | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | Program placement end date, if known. |
leave_type | string | Optional | Leave type associated with this program placement. |
leave_type_label | string | Optional | Human-readable leave type label. |
pay_status | string | Required within parent | Whether this program has an estimated pay rate. Known values: NOT_APPLICABLE, ESTIMATED |
program_code | string | Required within parent | Leave program code active on this claim window. |
start_date | string | Required within parent | Program placement start date. |
Evaluate a leave program evaluation — response body — program results item pay rate phases item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Pay amount for this phase serialized as a decimal string. |
currency | string | Optional | ISO 4217 currency code for this pay phase. |
duration_days | JSON | Optional | |
duration_days (anyOf 1) | integer | Alternative | Number of days this phase lasts. Null means the phase runs to the window end. |
duration_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit | string | Optional | Pay-rate unit for this phase, such as DAILY, WEEKLY, or BIWEEKLY. |
Evaluate a leave program evaluation — response body — program results item program requirements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
blocks_payment | boolean | Optional | Whether this requirement blocks payment until resolved. |
key | string | Required within parent | Machine-readable requirement key. |
summary | string | Required within parent | Human-readable requirement summary. |
Policy, approvals and errors
Section titled “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"}