// fusionrest agent · hcm

Plan Balances

planBalances Based on latest (2026.09)

Look up Plan Balances, with details, plan balance details and plan balance summary. Read-only.

The record key planBalancesUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.

Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.

/hcmRestApi/resources/11.13.18.05/planBalances
Operations
GET (list)GET (one)
Record key
planBalancesUniqID
Required on create
no create on this resource
At a glance
32 fields4 finders5 children
Extra parameters
?effectiveDate=Effective-Of:
I want to…List the latest 25Count recordsGet one record

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Finder
Include children (expand)
Paging and options
limit
Endpoint and headers
GET /hcmRestApi/resources/11.13.18.05/planBalances?fields=SysEffectiveDate,assignmentId,assignmentName,assignmentNumber,balanceAsOfBalanceCalculationDate&limit=25&onlyData=true
Response shape (placeholders)
{
  "items": [
    {
      "SysEffectiveDate": "2026-01-31",
      "assignmentId": 0,
      "assignmentName": "<string, max 80>",
      "assignmentNumber": "<string, max 30>",
      "balanceAsOfBalanceCalculationDate": 0
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0
}

Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.

Fields 32

AttributeTypeUse
SysEffectiveDatedateSearchable
assignmentIdnumberRead-onlySearchable
assignmentNametext · max 80Read-onlySearchable
assignmentNumbertext · max 30Read-onlySearchable
balanceAsOfBalanceCalculationDatenumberSearchable
balanceCalculationDatedateSearchable
ceilingAmountnumberSearchable
effectiveEndDatedateRead-onlySearchable
effectiveStartDatedateRead-onlySearchable
enrollPositiveBalanceFlagyes/no · max 30Read-onlySearchable
enrollmentEndDatedateSearchable
enrollmentStartDatedateSearchable
formattedBalancetext · max 255Read-onlySearchable
formattedCeilingAmounttext · max 255Read-only
leveltext · max 150Read-onlySearchable
multiYearCarryOverFlagyes/noRead-only
personIdnumberSearchable
personPlanEnrollmentIdnumberSearchable
planDisplayStatusFlagyes/noSearchable
planEnrollmentStatustextRead-onlySearchable
planIdnumberSearchable
planNametext · max 240Read-onlySearchable
planPeriodEndDatedateRead-onlySearchable
planPeriodStartDatedateRead-onlySearchable
planStatustext · max 30Read-onlySearchable
planStatusMeaningtextSearchable
planTypetext · max 80Read-onlySearchable
planTypeCodetext · max 30Read-onlySearchable
planUnitOfMeasuretext · max 30Read-onlySearchable
recipientAliasNametext · max 240Read-onlySearchable
transferRuletext · max 30Read-onlySearchable
unitOfMeasureMeaningtext · max 80Read-onlySearchable

Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.

Finders 4

Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.

Check a payload

Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.

Children 5

Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/<name>. Add them to a GET with expand.

Use in AI Agent Studio

More in For Builders.

Pitfalls