Joint Venture Carried Interest Agreements
carriedInterestAgreements Based on 26C
Create, change, delete and look up Joint Venture Carried Interest Agreements, with stakeholder groups.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
agreementId- Required on create
- none marked
- At a glance
- 14 fields1 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/carriedInterestAgreements?fields=agreement,agreementDescription,agreementId,calculatePenaltiesFlag,createdBy&limit=25&onlyData=true
{
"items": [
{
"agreement": "<string, max 30>",
"agreementDescription": "<string, max 240>",
"agreementId": 0,
"calculatePenaltiesFlag": false,
"createdBy": "<string, max 64>"
}
],
"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 26C REST specification.
Fields 14
| Attribute | Type | Use |
|---|---|---|
agreement | text · max 30 | Optional on createSearchable |
agreementDescription | text · max 240 | Optional on createUpdatableSearchable |
agreementId | number | Read-onlySearchable |
calculatePenaltiesFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
createdBy | text · max 64 | Read-onlySearchable |
creationDate | date-time | Read-onlySearchable |
determinePayoutFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
endDate | date | Optional on createUpdatableSearchable |
jointVenture | text · max 80 | Optional on createUpdatableSearchable |
jointVentureDescription | text · max 80 | Optional on createUpdatableSearchable |
lastUpdateDate | date-time | Read-onlySearchable |
lastUpdatedBy | text · max 64 | Read-onlySearchable |
startDate | date | Optional on createUpdatableSearchable |
status | text · max 80 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). 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.
agreementFinder·agreementagreementDescriptionendDatejointVenturesearchAllTextstartDatestatus
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: /fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/<name>. Add them to a GET with expand.
agreementDFFGET · POST · PATCH Carried Interest Agreement Descriptive Flexfields · 3 fieldsAgreementId__FLEX_Context__FLEX_Context_DisplayValuestakeholderGroupsGET · POST · PATCH · DELETE Stakeholder Groups · 12 fields · 1 finderschangeReasonchangeReasonDetailscreatedBycreationDatedistributionsExistFlagendDatelastUpdateDatelastUpdatedBystakeholderGroupstakeholderGroupDescriptionstakeholderGroupIdstartDateownershipDefinitionsGET · DELETE Ownership Definitions · 29 fields · 1 findersactiveFlagagreementcarriedInterestSourceOwnershipFlagchangeReasonchangeReasonAdditionalTextcreatedBycreationDatedefaultOwnershipDefinitionFlagdistributionExisteffectiveEndDateeffectiveStartDateexternalStakeholderExistsFlaginternalStakeholderExistsFlagjointVentureDescriptionjointVentureNamelastUpdateDatelastUpdatedByownershipChangeFlagownershipChangeTypeownershipDefinitionDescriptionownershipDefinitionIdownershipDefinitionShortNameownershipDefinitionStatusownershipVersionsourceOwnershipDefinitionsourceOwnershipDefinitionDescriptionstakeholderGroupstakeholderGroupDescriptiontotalPercentageownershipPercentagesGET Ownership Percentages · 13 fields · 1 finderscreatedBycreationDatedistributionOnlyFlaginternalStakeholderFlaginvoicingPartnerIdlastUpdateDatelastUpdatedByownershipDefinitionNameownershipPercentageIdpercentageOfInterestroundingPartnerFlagstakeholderDescriptionstakeholderNamestakeholderGroupDFFGET · POST · PATCH Stakeholder Group Descriptive Flexfields · 3 fieldsStakeholderGroupId__FLEX_Context__FLEX_Context_DisplayValuestakeholderPercentagesGET · POST · PATCH · DELETE Stakeholder Percentages · 13 fields · 1 finderscarriedInterestAccountcarriedInterestPercentageconsentingStakeholderconsentingStakeholderDescriptioncreateJournalsFlagcreatedBycreationDatelastUpdateDatelastUpdatedBynonConsentingStakeholdernonConsentingStakeholderDescriptionstakeholderPercentageIdstructureInstanceNumberstakeholderPercentageDFFGET · POST · PATCH Stakeholder Percentage Descriptive Flexfields · 3 fieldsGroupLineId__FLEX_Context__FLEX_Context_DisplayValue
Actions 1
POST …/{agreementId}/child/stakeholderGroups/{stakeholderGroupId}/action/createOwnershipDefinition·assignDefaultOwnershipDefinitionnamesourceOwnershipDefinitiondescription
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/carriedInterestAgreementsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
agreementFinderfor 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:agreement, notagreement. - 5 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.