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

Get one inventory balance

get

/fscmRestApi/resources/11.13.18.05/inventoryOnhandBalances/{inventoryOnhandBalancesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Inventory On-Hand Balances resource and used to uniquely identify an instance of Inventory On-Hand Balances. The client should not generate the hash key value. Instead, the client should query on the Inventory On-Hand Balances collection resource in order to navigate to a specific instance of Inventory On-Hand Balances to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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
Links
cycleCountDetails
Parameters:
  • inventoryOnhandBalancesUniqID: $request.path.inventoryOnhandBalancesUniqID
The Cycle Count Details resource gets the last counted date.
inventoryTrackingAttributes
Parameters:
  • inventoryOnhandBalancesUniqID: $request.path.inventoryOnhandBalancesUniqID
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.
lots
Parameters:
  • inventoryOnhandBalancesUniqID: $request.path.inventoryOnhandBalancesUniqID
The Lots resource gets the lot numbers associated with an inventory balance record for a lot-controlled item.
replenishmentDetails
Parameters:
  • inventoryOnhandBalancesUniqID: $request.path.inventoryOnhandBalancesUniqID
The Replenished Details resource gets the last replenished date.
serials
Parameters:
  • inventoryOnhandBalancesUniqID: $request.path.inventoryOnhandBalancesUniqID
The Serials resource gets the serial numbers associated with an inventory balance record for a serial-controlled item.
Back to Top

Examples

This example describes how to get one inventory balance.

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/inventoryOnhandBalancesUniqID"

For example, the following command gets one inventory balance:

curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryOnhandBalances?q=SummaryLevel=Organization;InventoryItemId=663918;OrganizationId=207;Revision=A;SubinventoryGroup=null;SubinventoryCode=nul;LocatorId=null;OwningPartySiteId=null"

Example Response Body

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

{
    "items": [
        {
            "ItemNumber": "INV-110",
            "PrimaryUOMCode": "Ea",
            "OrganizationCode": "M1",
            "SummaryLevel": "Organization",
            "InventoryItemId": 663918,
            "OrganizationId": 207,
            "Revision": "A",
            "SubinventoryGroup": null,
            "SubinventoryCode": null,
            "LocatorId": null,
            "OwningPartySiteId": null,
            "PrimaryQuantity": 40,
            "ConsignedQuantity": 0,
            "CategoryId": null,
            "Category": null,
            "OwningPartySite": null,
            "OwningPartyId": null,
            "OwningParty": null,
            "Locator": null,
            "PrimaryUnitOfMeasure": "Each",
            "MaterialStatusId": null,
            "MaterialStatus": null}]}
Back to Top