// fusionrest agent · hcm

Payroll Connect Payload Rules

payrollConnectPayloadRules Based on latest (2026.09)

Create, change, delete and look up Payroll Connect Payload Rules. Actions include export payload rule and import payload rule.

/hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRules
Operations
GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
Record key
RulePropertyId
Required on create
none marked
At a glance
17 fields1 finders0 children
I want to…List the latest 25Count recordsGet one recordCreate oneUpdate one

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Finder
Paging and options
limit
Endpoint and headers
GET /hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRules?fields=DeleteAllowedFlag,Display,ExtractDataElementId,ExtractDefinitionId,Include&limit=25&onlyData=true
Response shape (placeholders)
{
  "items": [
    {
      "DeleteAllowedFlag": false,
      "Display": "<string, max 150>",
      "ExtractDataElementId": 0,
      "ExtractDefinitionId": 0,
      "Include": "<string, max 150>"
    }
  ],
  "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 17

AttributeTypeUse
DeleteAllowedFlagyes/noRead-onlySearchable
Displaytext · max 150Optional on createUpdatableSearchable
ExtractDataElementIdnumberOptional on createSearchable
ExtractDefinitionIdnumberOptional on createSearchable
Includetext · max 150Optional on createUpdatableSearchable
IncludedBatchtext · max 20Optional on createUpdatableSearchable
IncludedRealtimetext · max 20Optional on createUpdatableSearchable
LegislationCodetext · max 30Optional on createSearchable
LegislativeDataGroupIdnumberOptional on createSearchable
Mandatorytext · max 20Optional on createUpdatableSearchable
ParentRulePropertyIdnumberOptional on createSearchable
PayloadRuleNametext · max 30Optional on createSearchable
ReportBlockIdnumberOptional on createSearchable
ReportRecordIdnumberOptional on createSearchable
RulePropertyIdnumberOptional on createSearchable
SetupPayloadIdnumberOptional on createUpdatableSearchable
SourceDefinitionTypetextRead-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 1

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.

Actions 2

Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.

Use in AI Agent Studio

More in For Builders.

Pitfalls