1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Periodic Average Item Costs

Get a periodic average item cost

get

/fscmRestApi/resources/11.13.18.05/periodicAverageItemCosts/{PeriodicCostId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : periodicAverageItemCosts-item-response
Type: object
Show Source
  • Title: Cost Book
    Read Only: true
    Maximum Length: 30
    Name of the cost book for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task.
  • Title: Cost Book ID
    Read Only: true
    Value that uniquely identifies the cost book.
  • Title: Cost Element
    Read Only: true
    Maximum Length: 80
    Cost element to use when creating an adjustment detail.
  • Title: Cost Element ID
    Read Only: true
    Value that uniquely identifies the cost element.
  • Title: Cost Organization ID
    Read Only: true
    Value that uniquely identifies the cost organization.
  • Title: Cost Organization Name
    Read Only: true
    Maximum Length: 240
    Name of the cost organization for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task.
  • Title: Currency Code
    Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the currency.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Name of the inventory item for the adjustment.
  • Title: Item ID
    Read Only: true
    Value that uniquely identifies the item.
  • Links
  • Read Only: true
    On Hand Quantity
  • Title: Periodic Average Cost
    Read Only: true
    Periodic average item cost of the item by cost element.
  • Title: Periodic Average Cost Identifier
    Read Only: true
    Value that uniquely identifies the periodic item cost. The application generates this value.
  • Title: Period Name
    Read Only: true
    Maximum Length: 15
    Period of the costing transaction for the adjustment. Adjustments can only be created in costing periods when the period status is open or pending close.
  • Title: Period Status
    Read Only: true
    Maximum Length: 80
    Status of the Period. Values are Closed, Permanently closed, Never opened, Open, and Close pending.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure.
  • Title: Valuation Unit
    Read Only: true
    Maximum Length: 1000
    Valuation unit code for the cost adjustment transaction.
  • Title: Valuation Unit ID
    Read Only: true
    Value that uniquely identifies the valuation unit.
Back to Top

Examples

This example describes how to get the cost of an inventory item specific to a cost organization, cost book, and period.

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/periodicAverageItemCosts?finder=findperiodicAverageItemCosts;bindCostOrgId=CostOrgId,bindCostBookId=CostBookId,bindItem=ItemId,bindValuationUnit=VUId,bindPeriod=PeriodName"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/periodicAverageItemCosts?finder=findperiodicAverageItemCosts;bindCostOrgId=100000012270096,bindCostBookId=300100557916616,bindItem=ItemT,bindValuationUnit=ORG4-V1,bindPeriod=Sep-21"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "PeriodicCostId": 9001,
            "CostOrganizationId": 100000012270096,
            "CostOrganizationName": "ZCST-Vision Ops",
            "CostBookId": 300100557916616,
            "CostBook": "Avg-pac",
            "ItemId": 300100558417360,
            "Item": "ItemT",
            "ValuationUnitId": 300100559732651,
            "ValuationUnit": "ORG4-V1",
            "PeriodName": "Sep-21",
            "PeriodStatus": "Open",
            "CostElementId": 100000010001028,
            "CostElement": "ZCST-MATERIAL",
            "PeriodCost": 12,
            "OnhandQuantity": null,
            "CurrencyCode": "USD",
            "UOMName": "Each",
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageItemCosts/9001",
                    "name": "periodicAverageItemCosts",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageItemCosts/9001",
                    "name": "periodicAverageItemCosts",
                    "kind": "item"
                }
            ]
        },
        {
            "PeriodicCostId": 9004,
            "CostOrganizationId": 100000012270096,
            "CostOrganizationName": "ZCST-Vision Ops",
            "CostBookId": 300100557916616,
            "CostBook": "Avg-pac",
            "ItemId": 300100558417360,
            "Item": "ItemT",
            "ValuationUnitId": 300100559732651,
            "ValuationUnit": "ORG4-V1",
            "PeriodName": "Sep-21",
            "PeriodStatus": "Open",
            "CostElementId": 300100071793419,
            "CostElement": "CML Material",
            "PeriodCost": 2,
            "OnhandQuantity": null,
            "CurrencyCode": "USD",
            "UOMName": "Each",
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageItemCosts/9004",
                    "name": "periodicAverageItemCosts",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageItemCosts/9004",
                    "name": "periodicAverageItemCosts",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/periodicAverageItemCosts",
            "name": "periodicAverageItemCosts",
            "kind": "collection"
        }
    ]
}
Back to Top