Compensation Plans
compensationPlans Based on latest (2026.09)
Create, change, delete and look up Compensation Plans, with compensation plan assignments, compensation plan components and compensation plan direct assignment requests.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE9 actions
- Record key
CompensationPlanId- Required on create
NameStartDate- At a glance
- 18 fields0 finders9 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/compensationPlans?fields=AllowCreditCategoryOverlapFlag,ApprovalStatus,CompensationPlanId,CreatedBy,CreationDate&limit=25&onlyData=true
{
"items": [
{
"AllowCreditCategoryOverlapFlag": false,
"ApprovalStatus": "NOT_APPROVED",
"CompensationPlanId": 0,
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00"
}
],
"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 18
| Attribute | Type | Use |
|---|---|---|
AllowCreditCategoryOverlapFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ApprovalStatus | text · max 30 · default NOT_APPROVED | Optional on createUpdatableSearchable |
CompensationPlanId | number | Optional on createSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
Description | text · max 1000 | Optional on createUpdatableSearchable |
DisplayName | text · max 80 | Optional on createUpdatableSearchable |
EndDate | date | Optional on createUpdatableSearchable |
InvalidReason | text | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Name | text · max 80 | Required on createUpdatableSearchable |
OrgId | number | Optional on createSearchable |
PlanDocumentTemplate | text · max 80 | Optional on createUpdatableSearchable |
StartDate | date | Required on createUpdatableSearchable |
TargetIncentive | number · default 0 | Optional on createUpdatableSearchable |
ValidForCalculation | text · max 30 · default INCOMPLETE | Read-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.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 9
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/<name>. Add them to a GET with expand.
CompensationPlanAssignmentsGET Assigned Participants · 21 fields · 2 findersAcceptanceStatusAnalystIdAnalystNameAssignmentTypeCompensationPlanIdCreatedByCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByParticipantIdParticipantNameParticipantPlanNumberParticipantTypePersonNumberRoleIdRoleNameSrpCompPlanIdStartDateViewPlanDocumentCompensationPlanComponentsGET · POST · PATCH · DELETE Compensation Plan - Plan Components · 18 fieldsCalculateIncentiveCalculationPhaseCalculationSequenceCompensationPlanComponentIdCompensationPlanIdCompensationPlanNameCreatedByCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByPlanComponentIdPlanComponentNamePlanComponentValidForCalculationStartDateTargetIncentiveAmountTargetIncentivePercentCompensationPlanDirectAssignmentRequestsGET · POST · DELETE Direct Assignment Requests · 19 fieldsCompensationPlanIdCreatedByCreationDateEndDateErrorReasonLastUpdateDateLastUpdateLoginLastUpdatedByParticipantIdParticipantNameParticipantPlanNumberPlanDirectAssignmentRequestIdProcessRequestIdProcessingStatusRequestCreateFlagRequestDeleteFlagRequestEditFlagSrpCompPlanIdStartDateCompensationPlanRolesGET · POST · PATCH · DELETE Compensation Plan - Roles · 12 fieldsCompensationPlanIdCreatedByCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByRoleDescriptionRoleIdRoleNameRolePlanIdStartDatecompensationPlansDFFGET · POST · PATCH Compensation Plan - Descriptive Flex Fields · 3 fieldsCompPlanId__FLEX_Context__FLEX_Context_DisplayValuesmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 9
POST …/{CompensationPlanId}/child/smartActions/action/executeActionForRows·payloadPOST …/{CompensationPlanId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{CompensationPlanId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{CompensationPlanId}/child/smartActions/action/getActionsForRows·payloadPOST …/{CompensationPlanId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{CompensationPlanId}/child/smartActions/action/getEntitiesPOST …/{CompensationPlanId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{CompensationPlanId}/child/smartActions/action/processMassAction·payloadPOST …/{CompensationPlanId}/child/smartActions/{compensationPlans_smartActions_Id}/action/executeAction
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
/fscmRestApi/resources/11.13.18.05/compensationPlansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:AllowCreditCategoryOverlapFlag, notallowcreditcategoryoverlapflag. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.