// fusionrest agent · financials
Carried Interest Payout Balances
carriedInterestPayoutBalances Based on 26C
Look up Carried Interest Payout Balances. Read-only.
/fscmRestApi/resources/11.13.18.05/carriedInterestPayoutBalances
- Operations
- GET (list)GET (one)
- Record key
payoutBalanceId- Required on create
- no create on this resource
- At a glance
- 18 fields1 finders0 children
Try it
Response fields ·
Filters (q)
Only attributes Oracle marks as searchable are offered.
Finder
Paging and options
limit
GET /fscmRestApi/resources/11.13.18.05/carriedInterestPayoutBalances?fields=agreement,agreementDescription,balance,carriedBalance,consentingStakeholder&limit=25&onlyData=true
Response shape (placeholders)
{
"items": [
{
"agreement": "<string, max 30>",
"agreementDescription": "<string, max 240>",
"balance": 0,
"carriedBalance": 0,
"consentingStakeholder": "<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 26C REST specification.
Fields 18
| Attribute | Type | Use |
|---|---|---|
agreement | text · max 30 | Read-onlySearchable |
agreementDescription | text · max 240 | Read-onlySearchable |
balance | number | Read-onlySearchable |
carriedBalance | number | Read-onlySearchable |
consentingStakeholder | text · max 30 | Read-onlySearchable |
createdBy | text · max 64 | Read-onlySearchable |
creationDate | date-time | Read-onlySearchable |
currencyCode | text · max 15 | Read-onlySearchable |
jointVenture | text · max 30 | Read-onlySearchable |
jointVentureDescription | text · max 240 | Read-onlySearchable |
lastUpdateDate | date-time | Read-onlySearchable |
lastUpdatedBy | text · max 64 | Read-onlySearchable |
nonConsentingStakeholder | text · max 30 | Read-onlySearchable |
payoutBalanceId | number | Read-onlySearchable |
payoutDate | date | Read-onlySearchable |
penaltyBalance | number | Read-onlySearchable |
period | text · max 15 | Read-onlySearchable |
status | text · max 80 | Read-onlySearchable |
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.
payoutBalanceFinder·agreementconsentingStakeholderjointVenturenonConsentingStakeholderperiodsearchAllText
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/carriedInterestPayoutBalancesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
payoutBalanceFinderfor 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:agreement, notagreement. - 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.