Payment Plans
incentiveCompensationPaymentPlans Based on latest (2026.09)
Create, change, delete and look up Payment Plans, with payment plan assignments and payment plan roles.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
PaymentPlanId- Required on create
FlatMinimumAmountPaymentPlanNameStartDate- At a glance
- 21 fields0 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans?fields=CreatedBy,CreationDate,DelayRecoveryFlag,Description,DrawEnd&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"DelayRecoveryFlag": false,
"Description": "<string, max 1000>",
"DrawEnd": "<string, max 30>"
}
],
"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 21
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DelayRecoveryFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
Description | text · max 1000 | Optional on createUpdatableSearchable |
DrawEnd | text · max 30 | Optional on createUpdatableSearchable |
EndDate | date | Optional on createUpdatableSearchable |
FlatMinimumAmount | number | Required on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MaximumAmount | number | Optional on createUpdatableSearchable |
MinimumRecoverFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
OrgId | number | Optional on createUpdatableSearchable |
PayExcessLaterFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
PayIntervalTypeId | number · default -1000 | Optional on createUpdatableSearchable |
PaymentPlanCategory | text · max 30 · default STANDARD | Optional on createUpdatableSearchable |
PaymentPlanId | number | Optional on createSearchable |
PaymentPlanName | text · max 160 | Required on createUpdatableSearchable |
RecoverExpressionId | number · default -1001 | Optional on createUpdatableSearchable |
RecoveryEndIntervalId | number | Optional on createUpdatableSearchable |
RecoveryStartIntervalId | number | Optional on createUpdatableSearchable |
StartDate | date | Required 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 2
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/<name>. Add them to a GET with expand.
PaymentPlanAssignmentsGET · POST · PATCH · DELETE Payment Plans Assignments · 19 fields · 2 findersAnalystIdAnalystNameAssignmentTypeCreatedByCreationDateEndDateFlatMinimumAmountLastUpdateDateLastUpdatedByMaximumAmountParticipantIdParticipantNameParticipantPaymentPlanIdPersonNumberRecoveryEndDateRecoveryStartDateRoleIdRoleNameStartDatePaymentPlanRolesGET · POST · PATCH · DELETE Payment Plans Roles · 11 fieldsCreatedByCreationDateDescriptionEndDateLastUpdateDateLastUpdatedByPaymentPlanIdRoleIdRoleNameRolePaymentPlanIdStartDate
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlansand 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:DelayRecoveryFlag, notdelayrecoveryflag. - 4 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.