Collection Promises
collectionPromises Based on 26C
Create and look up Collection Promises.
- Operations
- GET (list)GET (one)POST (create)
- Record key
PromiseDetailId- Required on create
- none marked
- At a glance
- 18 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/collectionPromises?fields=BillToCustomerAccount,BusinessUnit,CreatedBy,CreationDate,Currency&limit=25&onlyData=true
{
"items": [
{
"BillToCustomerAccount": "<string, max 30>",
"BusinessUnit": "<string, max 240>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"Currency": "<string, max 15>"
}
],
"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 |
|---|---|---|
BillToCustomerAccount | text · max 30 | Optional on create |
BusinessUnit | text · max 240 | Optional on create |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
Currency | text · max 15 | Optional on create |
InstallmentNumber | number | Optional on createSearchable |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
PaymentAccount | text · max 240 | Optional on create |
PaymentMethod | text · max 30 | Optional on create |
PromiseAmount | number | Optional on createSearchable |
PromiseBalanceAmount | text | Optional on create |
PromiseDate | date | Optional on createSearchable |
PromiseDetailId | number | Optional on createSearchable |
PromiseItemNumber | text · max 240 | Optional on create |
PromiseMadeBy | text · max 255 | Optional on create |
TransactionDate | date | Optional on create |
TransactionNumber | text · max 255 | Optional on createSearchable |
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.
promisesFinder·BindInstallmentNumberBindPromiseAmountBindPromiseDateBindTransactionNumberIncludeBrokenPromisesIncludeCancelledPromises
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}/child/<name>. Add them to a GET with expand.
collectionPromiseDFFGET · POST Collection Promises Descriptive Flexfields · 3 fieldsPromiseDetailId__FLEX_Context__FLEX_Context_DisplayValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/collectionPromisesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
promisesFinderfor 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:BillToCustomerAccount, notbilltocustomeraccount. - 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.