Inventory On-Hand Balances
inventoryOnhandBalances Based on 26C
Look up Inventory On-Hand Balances, with cycle count details, inventory tracking attributes and lots. Read-only.
The record key inventoryOnhandBalancesUniqID 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)
- Record key
inventoryOnhandBalancesUniqID- Required on create
- no create on this resource
- At a glance
- 30 fields1 finders13 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/inventoryOnhandBalances?fields=Category,CategoryId,ConsignedQuantity,CreationDate,InventoryItemId&limit=25&onlyData=true
{
"items": [
{
"Category": "<string, max 250>",
"CategoryId": 0,
"ConsignedQuantity": 0,
"CreationDate": "2026-01-31T09:00:00+00:00",
"InventoryItemId": 0
}
],
"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 30
| Attribute | Type | Use |
|---|---|---|
Category | text · max 250 | Read-onlySearchable |
CategoryId | number | Read-onlySearchable |
ConsignedQuantity | number | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
InventoryItemId | number | Read-onlySearchable |
ItemDescription | text · max 240 | Read-onlySearchable |
ItemNumber | text · max 300 | Read-onlySearchable |
ItemPrimaryImageURL | text · max 4000 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
Locator | text · max 255 | Read-onlySearchable |
LocatorId | number | Read-onlySearchable |
MaterialStatus | text | Read-onlySearchable |
MaterialStatusId | number | Read-onlySearchable |
OrganizationCode | text · max 18 | Read-onlySearchable |
OrganizationId | number | Read-onlySearchable |
OwningParty | text · max 360 | Read-onlySearchable |
OwningPartyId | number | Read-onlySearchable |
OwningPartySite | text · max 240 | Read-onlySearchable |
OwningPartySiteId | number | Read-onlySearchable |
ParLocation | number | Read-onlySearchable |
PrimaryQuantity | number | Read-onlySearchable |
PrimaryUOMCode | text · max 3 | Read-onlySearchable |
PrimaryUnitOfMeasure | text | Read-onlySearchable |
Revision | text · max 18 | Read-onlySearchable |
StockingOnhandQuantity | number | Read-onlySearchable |
StockingUOMCode | text · max 3 | Read-onlySearchable |
StockingUnitOfMeasure | text · max 25 | Read-onlySearchable |
SubinventoryCode | text · max 10 | Read-onlySearchable |
SubinventoryGroup | text · max 100 | Read-onlySearchable |
SummaryLevel | text · max 255 | 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.
getZeroRows·bindIncludeZerobindInventoryItemIdbindItemNumberbindOrganizationCodebindOrganizationId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 13
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/inventoryOnhandBalances/{inventoryOnhandBalancesUniqID}/child/<name>. Add them to a GET with expand.
cycleCountDetailsGET Cycle Count Details · 1 fieldsLastCountedDateinventoryTrackingAttributesGET Inventory Tracking Attributes · 8 fieldsConsignedQuantityCountryOfOriginCountryOfOriginCodeInventoryProjectInventoryProjectIdInventoryTaskInventoryTaskIdPrimaryQuantitylotsGET Lots · 11 fieldsExpirationDateGradeCodeLotNumberMaterialStatusMaterialStatusIdOwningPartyOwningPartyIdOwningPartySiteOwningPartySiteIdOwningPartyTypePrimaryQuantityinventoryTrackingAttributesGET Inventory Tracking Attributes · 8 fieldsConsignedQuantityCountryOfOriginCountryOfOriginCodeInventoryProjectInventoryProjectIdInventoryTaskInventoryTaskIdPrimaryQuantitylotAttributeDFFsGET Flexfields for Lot Attributes · 5 fieldsInventoryItemIdLotNumberOrganizationId__FLEX_Context__FLEX_Context_DisplayValuelotSerialsGET Lot Serials · 13 fieldsCountryOfOriginCountryOfOriginCodeInventoryProjectInventoryProjectIdInventoryTaskInventoryTaskIdMaterialStatusMaterialStatusIdOwningPartyOwningPartyIdOwningPartySiteOwningPartySiteIdSerialNumberlotSerialAttributeDFFsGET Flexfields for Serial Number Attributes · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValuelotSerialStandardDFFsGET Flexfields for Serial Numbers · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValuelotStandardDFFsGET Flexfields for Lots · 5 fieldsInventoryItemIdLotNumberOrganizationId__FLEX_Context__FLEX_Context_DisplayValuereplenishmentDetailsGET Replenishment Details · 1 fieldsLastReplenishedDateserialsGET Serials · 14 fieldsCountryOfOriginCountryOfOriginCodeInventoryProjectInventoryProjectIdInventoryTaskInventoryTaskIdMaterialStatusMaterialStatusIdOwningPartyOwningPartyIdOwningPartySiteOwningPartySiteIdOwningPartyTypeSerialNumberserialAttributeDFFsGET Flexfields for Serial Number Attributes · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValueserialStandardDFFsGET Flexfields for Serial Numbers · 5 fieldsCurrentOrganizationIdInventoryItemIdSerialNumber__FLEX_Context__FLEX_Context_DisplayValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/inventoryOnhandBalancesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
getZeroRowsfor 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:Category, notcategory. 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.