1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Inventory On-Hand Balances

Get all inventory balances

get

/fscmRestApi/resources/11.13.18.05/inventoryOnhandBalances

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds inventory balance.
      Finder Variables:
      • InventoryItemId; integer; Value that uniquely identifies the inventory item.
      • LocatorId; integer; Value that uniquely identifies the locator.
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • OwningPartySiteId; integer; Value that uniquely identifies the site of the owning party.
      • Revision; string; Description of the revision.
      • SubinventoryCode; string; Abbreviation that identifies the subinventory in the organization. Value references a physical area or a logical grouping of items, such as, a storeroom or receiving dock.
      • SubinventoryGroup; string; Name of the subinventory group.
      • SummaryLevel; string; Summary level for the inventory balance. Values include None, Organization, Subinventory, or Locator.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Category; string; Name of category to which an item is assigned.
    • CategoryId; integer; Value that uniquely identifies the category an item is assigned to when a new item is created.
    • ConsignedQuantity; number; Consigned quantity of item in the primary unit of measure.
    • CreationDate; string; Creation date of the record.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemDescription; string; Value that identifies the description of the item associated with a subinventory.
    • ItemNumber; string; Number that identifies the inventory item.
    • ItemPrimaryImageURL; string; Value that provides a reference to the image of the item for which the count sequence is generated.
    • LastUpdateDate; string; Last update date of the record.
    • Locator; string; Physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
    • LocatorId; integer; Value that uniquely identifies the locator.
    • MaterialStatus; string; Status of the material.
    • MaterialStatusId; integer; Value that uniquely identifies the material status.
    • OrganizationCode; string; Abbreviation that identifies the organization.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OwningParty; string; Name of owning party.
    • OwningPartyId; integer; Value that uniquely identifies the owning party.
    • OwningPartySite; string; Name of the site of the owning party.
    • OwningPartySiteId; integer; Value that uniquely identifies the site of the owning party.
    • ParLocation; integer; Value that indicates if the on-hand quantity is associated with a subinventory that's enabled for a par location inventory.
    • PrimaryQuantity; number; Quantity of item in the primary unit of measure.
    • PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure.
    • PrimaryUnitOfMeasure; string; Primary unit of measure of the item.
    • Revision; string; Description of the revision.
    • StockingOnhandQuantity; number; Value that indicates the on-hand quantity for an item in the stocking unit of measure of the subinventory.
    • StockingUOMCode; string; Value that indicates the unit of measure code in which the items are stocked in a subinventory.
    • StockingUnitOfMeasure; string; Value that indicates the unit of measure in which the items are stocked in a subinventory.
    • SubinventoryCode; string; Abbreviation that identifies the subinventory in the organization. Value references a physical area or a logical grouping of items, such as, a storeroom or receiving dock.
    • SubinventoryGroup; string; Name of the subinventory group.
    • SummaryLevel; string; Summary level for the inventory balance. Values include None, Organization, Subinventory, or Locator.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : inventoryOnhandBalances
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryOnhandBalances-item-response
Type: object
Show Source
Nested Schema : Cycle Count Details
Type: array
Title: Cycle Count Details
The Cycle Count Details resource gets the last counted date.
Show Source
Nested Schema : Inventory Tracking Attributes
Type: array
Title: Inventory Tracking Attributes
The Inventory Tracking Attributes resource gets the details of the primary on-hand quantity, consigned quantity for specific inventory project, inventory task, and country of origin. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource gets the lot numbers associated with an inventory balance record for a lot-controlled item.
Show Source
Nested Schema : Replenishment Details
Type: array
Title: Replenishment Details
The Replenished Details resource gets the last replenished date.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource gets the serial numbers associated with an inventory balance record for a serial-controlled item.
Show Source
Nested Schema : inventoryOnhandBalances-cycleCountDetails-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-inventoryTrackingAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Consigned quantity of item in the primary unit of measure. This attribute is associated with a feature that requires opt in.
  • Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Name of the inventory project. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
  • Name of the inventory task. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in.
  • Links
  • Read Only: true
    Quantity of item in the primary unit of measure. This attribute is associated with a feature that requires opt in.
Nested Schema : inventoryOnhandBalances-lots-item-response
Type: object
Show Source
Nested Schema : Inventory Tracking Attributes for Lots
Type: array
Title: Inventory Tracking Attributes for Lots
The Inventory Tracking Attributes for Lots resource gets the details of the primary on-hand quantity, consigned quantity for specific inventory project, inventory task, and country of origin. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the descriptive flexfields that modify lot attributes. This resource is used only when the item is under lot control.
Show Source
Nested Schema : Lot Serials
Type: array
Title: Lot Serials
The Lot Serials resource gets the serial numbers associated with an inventory balance record for a lot-serial controlled item.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages the descriptive flexfields that modify lots. This resource is used only when the item is under lot control.
Show Source
Nested Schema : inventoryOnhandBalances-lots-inventoryTrackingAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Consigned quantity of item in the primary unit of measure. This attribute is associated with a feature that requires opt in.
  • Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Name of the inventory project. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
  • Name of the inventory task. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in.
  • Links
  • Read Only: true
    Quantity of item in the primary unit of measure. This attribute is associated with a feature that requires opt in.
Nested Schema : inventoryOnhandBalances-lots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Serial Attributes
Type: array
Title: Flexfields for Lot Serial Attributes
The Flexfields for Lot Serial Attributes resource manages the descriptive flexfields that modify lot serial attributes. This resource is used only when the item is under both lot and serial control.
Show Source
Nested Schema : Flexfields for Lot Serials
Type: array
Title: Flexfields for Lot Serials
The Flexfields for Lot Serials resource manages the descriptive flexfields that modify lot serials. This resource is used only when the item is under both lot and serial control.
Show Source
Nested Schema : inventoryOnhandBalances-lots-lotSerials-lotSerialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-lots-lotSerials-lotSerialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-lots-lotStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-replenishmentDetails-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-serials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the descriptive flexfields that modify serial attributes. This resource is used only when the item is under serial control.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the descriptive flexfields that modify serials. This resource is used only when the item is under serial control.
Show Source
Nested Schema : inventoryOnhandBalances-serials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryOnhandBalances-serials-serialStandardDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all inventory balances.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryOnhandBalances"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "ItemNumber": "AS54888",
            "PrimaryUOMCode": "Ea",
            "OrganizationCode": "M1",
            "SummaryLevel": "Subinventory",
            "InventoryItemId": 149,
            "OrganizationId": 207,
            "Revision": null,
            "SubinventoryGroup": null,
            "SubinventoryCode": "AA22225423",
            "LocatorId": null,
            "OwningPartySiteId": null,
            "PrimaryQuantity": 20,
            "ConsignedQuantity": 0,
            "CategoryId": null,
            "Category": null,
            "OwningPartySite": null,
            "OwningPartyId": null,
            "OwningParty": null,
            "Locator": null,
            "PrimaryUnitOfMeasure": "Each",
            "MaterialStatusId": 1,
            "MaterialStatus": "Active"},...]}
Back to Top