Payroll Relationships
payrollRelationships Based on latest (2026.09)
Change and look up Payroll Relationships, with payroll assignments and payroll relationship dates. No create.
The record key payrollRelationshipsUniqID 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)PATCH (update)2 actions
- Record key
payrollRelationshipsUniqID- Required on create
- no create on this resource
- At a glance
- 11 fields2 finders7 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/payrollRelationships?fields=Country,EffectiveEndDate,EffectiveStartDate,EndDate,OverridingPeriodId&limit=25&onlyData=true
{
"items": [
{
"Country": "<string, max 2>",
"EffectiveEndDate": "2026-01-31",
"EffectiveStartDate": "2026-01-31",
"EndDate": "2026-01-31",
"OverridingPeriodId": 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 11
| Attribute | Type | Use |
|---|---|---|
Country | text · max 2 | Read-onlySearchable |
EffectiveEndDate | date | Read-onlySearchable |
EffectiveStartDate | date | Searchable |
EndDate | date | Read-onlySearchable |
OverridingPeriodId | number | UpdatableSearchable |
PartyId | number | Read-onlySearchable |
PartyNumber | text · max 30 | Read-onlySearchable |
PayrollRelationshipId | number | Searchable |
PayrollRelationshipNumber | text · max 30 | Read-onlySearchable |
PersonNumber | text · max 30 | Read-onlySearchable |
StartDate | date | 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 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByAssignmentNumberPersonNumber·AssignmentNumberPersonNumberSysEffectiveDatefindByPayrollRelationshipId·PayrollRelationshipIdSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 7
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/<name>. Add them to a GET with expand.
PayRelationshipsDDFGET · PATCH Payroll Relationship Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).payrollAssignmentsGET · PATCH Payroll Assignments · 7 fieldsAssignmentIdAssignmentNumberEffectiveEndDateEffectiveStartDateOverridingPeriodIdRelationshipGroupIdTimeCardRequiredPayrollRelationshipGroupsDDFGET · PATCH Payroll Assignment Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).assignedPayrollsGET · POST · PATCH · DELETE Assigned Payrolls · 10 fieldsAssignedPayrollIdEffectiveEndDateEffectiveStartDateEndDateLsedOverridingPeriodIdPayrollIdPayrollNameStartDateTimeCardRequiredassignedPayrollDatesGET · PATCH Assigned Payroll Dates · 4 fieldsDateValueDefinitionNamePayDateIdShortNamepayrollAssignmentDatesGET · PATCH Payroll Assignment Dates · 4 fieldsDateValueDefinitionNamePayDateIdShortNamepayrollRelationshipDatesGET Payroll Relationship Dates · 4 fieldsDateValueDefinitionNamePayDateIdShortName
Actions 2
POST …/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/action/updateTRU·truIdPOST …/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/action/transferPayroll·timeCardRequiredovertimePeriodIdpayrollIdstartDate
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/payrollRelationshipsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByAssignmentNumberPersonNumberfor 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.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:EffectiveStartDate, noteffectivestartdate. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
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.