Skip to content

Rippling: Evaluate a leave program evaluation — response body — program results item

Evaluate a leave program evaluation: response body, field program_results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: 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

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.