Plan Components
planComponents Based on latest (2026.09)
Create, change, delete and look up Plan Components, with plan component incentive formulas and plan component performance measures.
The record key planComponentsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
planComponentsUniqID- Required on create
CalculateIncentiveEndDateIncentiveTypeNameOrgIdStartDate- At a glance
- 22 fields0 finders5 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/planComponents?fields=CalculateIncentive,CalculationPhase,CreatedBy,CreationDate,Description&limit=25&onlyData=true
{
"items": [
{
"CalculateIncentive": "<string, max 30>",
"CalculationPhase": 1,
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"Description": "<string, max 1000>"
}
],
"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 22
| Attribute | Type | Use |
|---|---|---|
CalculateIncentive | text · max 30 | Required on createSearchable |
CalculationPhase | number · default 1 | Optional on createUpdatableSearchable |
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 |
EarningType | number · default -1000 | Optional on createSearchable |
EndDate | date | Required on createUpdatableSearchable |
IncentiveType | text · max 30 | Required 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 |
NumberOfDimensions | number | Read-onlySearchable |
OrgId | number | Required on createSearchable |
PaymentMadeThroughThirdPartyFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
PaymentPlanCategory | text · max 30 · default STANDARD | Optional on createUpdatableSearchable |
PlanComponentId | number | Optional on createSearchable |
SplitOption | text | Optional on createUpdatableSearchable |
StartDate | date | Required on createUpdatableSearchable |
ValidForCalculation | text · max 30 · default INCOMPLETE | Optional on createUpdatableSearchable |
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 5
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/<name>. Add them to a GET with expand.
planComponentIncentiveFormulasGET · PATCH Plan Component - Incentive Formulas · 18 fieldsCalculateEnddateParticipantFlagCreatedByCreationDateIncentiveFormulaExpressionDescriptionIncentiveFormulaExpressionIdIncentiveFormulaExpressionNameIncentiveFormulaIdIncludeIndirectCreditsLastUpdateDateLastUpdateLoginLastUpdatedByPayoutFrequencyPlanComponentIdPlanComponentIncentiveFormulaIdPlanComponentIncentiveFormulasDeleteFlagRenderedIncentiveFormulaExpressionResetIntervalTrueUpFlagplanComponentRateDimensionalInputsGET · PATCH Plan Component - Rate Dimensional Input Expressions · 15 fieldsCreatedByCreationDateIncentiveFormulaIdInputExpressionDescriptionInputExpressionIdInputExpressionNameLastUpdateDateLastUpdateLoginLastUpdatedByPlanComponentIdPlanComponentInputExpressionIdPlanComponentRateDimensionalInputsDeleteFlagRateDimNameRateDimSequenceSplitFlagplanComponentRateTablesGET · POST · PATCH · DELETE Plan Component - Rate Tables · 14 fieldsCreatedByCreationDateEndDateIncentiveFormulaIdLastUpdateDateLastUpdateLoginLastUpdatedByPlanComponentIdPlanComponentNamePlanComponentRateTableIdRateTableDescriptionRateTableIdRateTableNameStartDateplanComponentPerformanceMeasuresGET · POST · PATCH · DELETE Plan Component - Performance Measures · 19 fieldsCalculationSequenceCreatedByCreationDateEarningBasisEndDateLastUpdateDateLastUpdateLoginLastUpdatedByPerformanceIntervalPerformanceMeasureIdPerformanceMeasureNamePerformanceMeasureWeightPlanComponentIdPlanComponentNamePlanComponentPerformanceMeasureIdProcessTransactionsStartDateUnitOfMeasureValidForCalculationplanComponentsDFFGET · POST · PATCH Plan Component Descriptive Flex Fields · 4 fieldsOrgIdPlanComponentId__FLEX_Context__FLEX_Context_DisplayValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/planComponentsand 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:CalculateIncentive, notcalculateincentive. - 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.