Jump to

• Request
• Response
• Examples

Get one cost

get

/fscmRestApi/resources/11.13.18.05/itemCosts/{itemCostsUniqID}

Request

Path Parameters

• itemCostsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Costs resource and used to uniquely identify an instance of Item Costs. The client should not generate the hash key value. Instead, the client should query on the Item Costs collection resource in order to navigate to a specific instance of Item Costs to get the hash key.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : itemCosts-item-response

Type: object

Show Source

• CostAsOfDate: string (date-time)
  Title: Cost As-of Date

  Read Only: true

  Item cost as of the date.
• CostBook: string
  Title: Cost Book

  Read Only: true

  Maximum Length: 30

  Cost book name. Use the Manage Cost Books page in the Setup and Maintenance work area to examine and update the value for this attribute.
• CostBookId: integer (int64)
  Title: Cost Book ID

  Read Only: true

  Value that uniquely identifies the cost book.
• CostChange: number
  Title: Cost Change

  Read Only: true

  Change in cost of the inventory item.
• costDetails: array Details
  Title: Details

  The perpetual average cost at cost-element level for an inventory item in a cost organization and cost book.
• CostMethod: string
  Title: Cost Method

  Read Only: true

  Maximum Length: 17

  Cost method of the inventory item. You can use the following values for this attribute: Actual Cost, Perpetual Average, or Standard Cost.
• CostMethodCode: string
  Title: Cost Method Code

  Read Only: true

  Maximum Length: 17

  Abbreviation that identifies the cost method.
• CostOrganizationCode: string
  Title: Cost Organization Code

  Read Only: true

  Maximum Length: 150

  Abbreviation that identifies the cost organization.
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID

  Read Only: true

  Value that uniquely identifies the cost organization.
• CostOrganizationName: string
  Title: Cost Organization Name

  Read Only: true

  Maximum Length: 240

  Cost organization name. Use the Manage Cost Organizations page in the Setup and Maintenance work area to examine and update the value for this attribute.
• CostProfile: string
  Title: Cost Profile

  Read Only: true

  Maximum Length: 30

  Cost profile of the inventory item. Use the Manage Item Cost Profiles page in the Setup and Maintenance work area to examine and update the value for this attribute.
• CostProfileId: integer (int64)
  Title: Cost Profile ID

  Read Only: true

  Value that uniquely identifies the cost profile.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the currency.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Read Only: true

  End date of the item cost.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Read Only: true

  Start date of the item cost.
• ItemCategory: string
  Title: Item Category

  Read Only: true

  Maximum Length: 250

  Category of the inventory item.
• ItemCategoryId: number
  Title: Item Category ID

  Read Only: true

  Value that uniquely identifies the category of the inventory item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Inventory item description.
• ItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Value that uniquely identifies the inventory item.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  Inventory item name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityOnhand: number
  Title: On-Hand Quantity

  Read Only: true

  On-hand quantity of the inventory item.
• ReceiptNumber: string
  Title: Receipt Number

  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt.
• TotalUnitCost: number
  Title: Total Unit Cost

  Read Only: true

  Total unit cost of the inventory item.
• TransactionId: integer
  Title: Transaction ID

  Read Only: true

  Value that uniquely identifies the transaction in costing.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the unit of measure.
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure.
• ValuationStructureCode: string
  Title: Valuation Structure Code

  Read Only: true

  Maximum Length: 30

  Valuation structure for the item cost. Use the Manage Valuation Structures page in the Setup and Maintenance work area to examine and update the value for this attribute.
• ValuationStructureId: integer (int64)
  Title: Valuation Structure ID

  Read Only: true

  Value that uniquely identifies the valuation structure.
• ValuationUnit: string
  Title: Valuation Unit

  Read Only: true

  Maximum Length: 1000

  Valuation unit for the item cost. Use the Manage Valuation Units page in the Setup and Maintenance work area to examine and update the value for this attribute.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Read Only: true

  Value that uniquely identifies the valuation unit.

{
    "type":"object",
    "properties":{
        "ValuationStructureCode":{
            "title":"Valuation Structure Code",
            "maxLength":30,
            "type":"string",
            "description":"Valuation structure for the item cost. Use the Manage Valuation Structures page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostMethodCode":{
            "title":"Cost Method Code",
            "maxLength":17,
            "type":"string",
            "description":"Abbreviation that identifies the cost method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostAsOfDate":{
            "title":"Cost As-of Date",
            "type":"string",
            "description":"Item cost as of the date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total unit cost of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Inventory item description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Cost organization name. Use the Manage Cost Organizations page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategory":{
            "title":"Item Category",
            "maxLength":250,
            "type":"string",
            "description":"Category of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Inventory item name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "costDetails":{
            "title":"Details",
            "type":"array",
            "description":"The perpetual average cost at cost-element level for an inventory item in a cost organization and cost book.",
            "items":{
                "$ref":"#/components/schemas/itemCosts-costDetails-item-response"
            }
        },
        "ValuationStructureId":{
            "title":"Valuation Structure ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation structure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategoryId":{
            "title":"Item Category ID",
            "type":"number",
            "description":"Value that uniquely identifies the category of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnit":{
            "title":"Valuation Unit",
            "maxLength":1000,
            "type":"string",
            "description":"Valuation unit for the item cost. Use the Manage Valuation Units page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the item cost.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostChange":{
            "title":"Cost Change",
            "type":"number",
            "description":"Change in cost of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostMethod":{
            "title":"Cost Method",
            "maxLength":17,
            "type":"string",
            "description":"Cost method of the inventory item. You can use the following values for this attribute: Actual Cost, Perpetual Average, or Standard Cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfileId":{
            "title":"Cost Profile ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction in costing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":30,
            "type":"string",
            "description":"Cost book name. Use the Manage Cost Books page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrganizationCode":{
            "title":"Cost Organization Code",
            "maxLength":150,
            "type":"string",
            "description":"Abbreviation that identifies the cost organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfile":{
            "title":"Cost Profile",
            "maxLength":30,
            "type":"string",
            "description":"Cost profile of the inventory item. Use the Manage Item Cost Profiles page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the item cost.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityOnhand":{
            "title":"On-Hand Quantity",
            "type":"number",
            "description":"On-hand quantity of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

The perpetual average cost at cost-element level for an inventory item in a cost organization and cost book.

Show Source

• Array of: object itemCosts-costDetails-item-response

{
    "title":"Details",
    "type":"array",
    "description":"The perpetual average cost at cost-element level for an inventory item in a cost organization and cost book.",
    "items":{
        "$ref":"#/components/schemas/itemCosts-costDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : itemCosts-costDetails-item-response

Type: object

Show Source

• CostElement: string
  Title: Cost Element

  Read Only: true

  Maximum Length: 30

  Cost element mapped to the item. Use the Manage Cost Elements page in the Setup and Maintenance work area to examine and update the value for this attribute.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Read Only: true

  Value that uniquely identifies the cost element.
• CostElementType: string
  Title: Cost Element Type

  Read Only: true

  Maximum Length: 30

  Type of the cost element.
• CostPercent: number
  Title: Cost Breakdown

  Read Only: true

  Breakdown percentage of the total cost of the inventory item according to the cost element.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the currency.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UnitCostAverage: number
  Title: Unit Cost

  Read Only: true

  Unit cost for the cost element.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostPercent":{
            "title":"Cost Breakdown",
            "type":"number",
            "description":"Breakdown percentage of the total cost of the inventory item according to the cost element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element mapped to the item. Use the Manage Cost Elements page in the Setup and Maintenance work area to examine and update the value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementType":{
            "title":"Cost Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the cost element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitCostAverage":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost for the cost element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

costDetails

Operation: /fscmRestApi/resources/11.13.18.05/itemCosts/{itemCostsUniqID}/child/costDetails

Parameters:

• itemCostsUniqID: $request.path.itemCostsUniqID

The perpetual average cost at cost-element level for an inventory item in a cost organization and cost book.

Back to Top

Examples

This example describes how to get one cost.

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/itemCosts/itemCostsUniqID"

Example Response Body

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

{
   "CostOrganizationId": 300100059775764,
   "CostOrganizationName": "ZC1-CO",
   "CostOrganizationCode": "ZC1-CO",
   "CostBookId": 300100052350619,
   "CostBook": "ZDQ-Avg",
   "CostProfile": "ZDQ-Avg",
   "CostProfileId": 300100052350627,
   "ItemCategory": "Uncategorized",
   "ItemCategoryId": 1396,
   "ItemId": 300100059526506,
   "ItemNumber": "ZDQ-Oh-Item",
   "ItemDescription": "ZDQ-Oh-Item",
   "CostMethodCode": "PERPETUAL_AVERAGE",
   "ValuationStructureId": 100000011846089,
   "ValuationStructureCode": "ZCST-Inv-Org-Asset",
   "ValuationUnitId": 300100061664663,
   "ValuationUnit": "ZC1\\-CO-ZCST1",
   "ReceiptNumber": null,
   "TransactionId": 417468,
   "CurrencyCode": "USD",
   "UOMName": "Each",
   "UOMCode": "Ea",
   "TotalUnitCost": 10,
   "CostChange": 0,
   "CostAsOfDate": "2015-03-23T23:13:17+00:00",
   "EffectiveStartDate": null,
   "EffectiveEndDate": null,
   "QuantityOnhand": 2000000,
   "CostMethod": "Perpetual average",
  ...
}

Back to Top