Supported operations
| GET /planBalances |
| GET /planBalances/{id} |
Queryable q fields (30)
Only these fields can appear in a q filter expression on
/planBalances. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/planBalances?q=SysEffectiveDate='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| SysEffectiveDate | string | = != |
| assignmentId | integer | = != |
| assignmentName | string | = != |
| assignmentNumber | string | = != |
| balanceAsOfBalanceCalculationDate | number | = != |
| balanceCalculationDate | string | = != |
| ceilingAmount | number | = != |
| effectiveEndDate | string | = != |
| effectiveStartDate | string | = != |
| enrollPositiveBalanceFlag | boolean | = != |
| enrollmentEndDate | string | = != |
| enrollmentStartDate | string | = != |
| formattedBalance | string | = != |
| level | string | = != |
| personId | integer | = != |
| personPlanEnrollmentId | integer | = != |
| planDisplayStatusFlag | boolean | = != |
| planEnrollmentStatus | string | = != |
| planId | integer | = != |
| planName | string | = != |
| planPeriodEndDate | string | = != |
| planPeriodStartDate | string | = != |
| planStatus | string | = != |
| planStatusMeaning | string | = != |
| planType | string | = != |
| planTypeCode | string | = != |
| planUnitOfMeasure | string | = != |
| recipientAliasName | string | = != |
| transferRule | string | = != |
| unitOfMeasureMeaning | string | = != |
Child resources (5)
Each child is reachable at
/planBalances/{id}/child/<name>
and most can also be inlined with expand.
detailsplanBalanceDetailsplanBalanceSummaryunvestedDetailsyearEndDetails Response fields (37)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
SysEffectiveDateassignmentIdassignmentNameassignmentNumberbalanceAsOfBalanceCalculationDatebalanceCalculationDateceilingAmountdetailseffectiveEndDateeffectiveStartDateenrollPositiveBalanceFlagenrollmentEndDateenrollmentStartDateformattedBalanceformattedCeilingAmountlevelmultiYearCarryOverFlagpersonIdpersonPlanEnrollmentIdplanBalanceDetailsplanBalanceSummaryplanDisplayStatusFlagplanEnrollmentStatusplanIdplanNameplanPeriodEndDateplanPeriodStartDateplanStatusplanStatusMeaningplanTypeplanTypeCodeplanUnitOfMeasurerecipientAliasNametransferRuleunitOfMeasureMeaningunvestedDetailsyearEndDetails Build this query visually in OPAL
OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.
Related reference & reading
- /workerJourneys Get all worker journeys
- /recruitingJobApplications Get all job applications for recruiting
- /recruitingCERequisitionTemplateDetailsPreviews Get all requisition template details previews
- /recruitingUIICEOfferPreviews Get all details of the offer letter for the internal candidate
- /recruitingCEJobRequisitionsCoordinates Get all job requisitions
- Oracle HCM API guide
- Why the q parameter fails and how to fix it
- Finders: named queries in Oracle Fusion REST APIs
- All endpoint reference pages