Grade Rates
gradeRates Based on latest (2026.09)
Look up Grade Rates, with rate values. Read-only.
The record key gradeRatesUniqID 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.
- Operations
- GET (list)GET (one)
- Record key
gradeRatesUniqID- Required on create
- no create on this resource
- At a glance
- 11 fields3 finders1 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/gradeRates?fields=ActionReasonCode,ActiveStatus,AnnualizationFactor,CurrencyCode,EffectiveEndDate&limit=25&onlyData=true
{
"items": [
{
"ActionReasonCode": "<string, max 255>",
"ActiveStatus": "<string, max 30>",
"AnnualizationFactor": 0,
"CurrencyCode": "<string, max 15>",
"EffectiveEndDate": "2026-01-31"
}
],
"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 11
| Attribute | Type | Use |
|---|---|---|
ActionReasonCode | text · max 255 | Searchable |
ActiveStatus | text · max 30 | Searchable |
AnnualizationFactor | number | Searchable |
CurrencyCode | text · max 15 | Searchable |
EffectiveEndDate | date | Searchable |
EffectiveStartDate | date | Searchable |
GradeRateName | text · max 240 | Searchable |
LegislativeDataGroupId | number | Searchable |
RateFrequency | text · max 30 | Searchable |
RateId | number | Searchable |
RateType | text · max 30 | Searchable |
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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByGrade·pGradeCodepGradeIdpGradeSetCodefindByLegislativeDataGroup·pLegislativeDataGrouppLegislativeDataGroupIdfindByRateId·RateIdSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/<name>. Add them to a GET with expand.
rateValuesGET Grade Rates Rate Values · 8 fields · 1 findersEffectiveEndDateEffectiveStartDateGradeIdMaximumAmountMidValueAmountMinimumAmountRateValueIdValueAmount
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/gradeRatesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByGradefor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ActionReasonCode, notactionreasoncode. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.