Get all overhead rates

get

/fscmRestApi/resources/11.13.18.05/standardOverheadRates

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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 overhead rates according to the specified primary key criteria.
      Finder Variables:
      • StandardOverheadRateId; integer; Value that uniquely identifies the standard overhead rate.
    • PublishedOverheadByItemOrgAsOfDateFinder: Finds published overheads for a standard costed item in a given organization or plant according to the specified date.
      Finder Variables:
      • bindAsOfDate; string; Date when the overhead rate is effective. The default value is the current application date.
      • bindInventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
      • bindItemId; integer; Value that uniquely identifies the item.
    • findStandardOverheadRate: Finds standard overhead rates according to the specified parameters.
      Finder Variables:
      • bindCategoryCode; string; Abbreviation that identifies the item category.
      • bindCategoryId; string; Value that uniquely identifies the item category for which the overhead rates are displayed.
      • bindCategoryName; string; Name of the category to which the item belongs.
      • bindCostBookCode; string; Abbreviation that identifies the cost book for which the standard overhead rate details are displayed.
      • bindCostBookId; string; Value that uniquely identifies the cost book.
      • bindCostOrgCode; string; Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.
      • bindCostOrgId; string; Value that uniquely identifies the cost organization.
      • bindCostOrgName; string.
      • bindEffectiveDate; string; Date when the overhead is effective.
      • bindEffectiveEndDate; string; Date when the overhead is effective to.
      • bindEffectiveStartDate; string; Date when the overhead is effective from.
      • bindInventoryOrgCode; string; Abbreviation that identifies the organization to which the item belongs.
      • bindInventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
      • bindItemId; integer; Value that uniquely identifies the item.
      • bindItemNumber; string; Number that identifies the item.
      • bindOverheadRateType; string; Type of overhead rate. Values include PLANT and WORKCENTER.
      • bindResourceType; string; Type of resource. This value is user-defined. Values include LABOR and EQUIPMENT.
      • bindScenarioId; string; Value that uniquely identifies the cost scenario for which the overhead rate is set up.
      • bindScenarioNumber; string; Number that identifies the cost planning scenario. This value is user defined.
      • bindStatusCode; string; Abbreviation that identifies the status of the displayed overhead rate.
      • bindWorkCenterCode; string; Abbreviation that identifies the work center for the overhead rate under the work definition operation.
      • bindWorkCenterId; string; Value that uniquely identifies the work center for which the overhead rates are displayed.
  • 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:
    • AttachmentEntityName; string; Identifies the entity name of the attachment for the overhead rates.
    • CategoryCode; string; Abbreviation that identifies the item category.
    • CategoryId; integer; Value that uniquely identifies the item category for which the overhead rates are displayed.
    • CategoryName; string; Name of the item category.
    • CostBookCode; string; Abbreviation that identifies the cost book in which the standard overhead rate details are displayed.
    • CostBookDescription; string; Description of the cost book.
    • CostBookId; integer; Value that uniquely identifies the cost book.
    • CostOrgCode; string; Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.
    • CostOrgId; integer; Value that uniquely identifies the cost organization.
    • CostOrgName; string; Name of the cost organization for which the standard overhead rate is displayed.
    • CurrencyCode; string; Abbreviation that identifies the currency in which the overhead rate is set up.
    • CurrencyName; string; Name of the currency.
    • EffectiveEndDate; string; Date when standard overhead rate is no longer effective. A date of 31-12-4712 indicates that this overhead rate record is the current effective rate.
    • EffectiveStartDate; string; Date when the standard overhead rate is effective.
    • HeaderReferenceNumber; string; Unique reference number added by the user to link an overhead rate header with the detail record. This is only applicable when the overhead rate is created through Oracle Visual Builder Cloud Service template.
    • InventoryOrgCode; string; Abbreviation that identifies the organization to which the item belongs.
    • InventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
    • InventoryOrgName; string; Name of the organization to which the component item belongs.
    • ItemDescription; string; Description of the item for which standard overhead rate is displayed.
    • ItemId; integer; Value that uniquely identifies an item.
    • ItemNumber; string; Number that identifies the item.
    • OverheadRateType; string; Type of overhead rate. Values include PLANT and WORKCENTER. A list of accepted values is defined in the lookup type ORA_CST_OVERHEAD_RATE_TYPE.
    • OverheadRateTypeMeaning; string; Translatable name for overhead rate type code.
    • ResourceType; string; Type of resource. Values include LABOR and EQUIPMENT. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.
    • ResourceTypeMeaning; string; Translatable name for resource type codes.
    • ScenarioId; integer; Value that uniquely identifies the cost scenario for which the overhead rate is set up.
    • ScenarioNumber; string; Number that identifies the cost planning scenario. This value is defined by the user.
    • StandardOverheadRateId; integer; Value that uniquely identifies the standard overhead rate.
    • StatusCode; string; Abbreviation that identifies the status of the displayed overhead rate. Values include IN_PROCESS and PUBLISHED, EXCLUDED_FROM_PUBLISH. A list of accepted values is defined in the lookup type ORA_CST_STD_COST_STATUSES.
    • StatusCodeMeaning; string; Translatable name for the status code.
    • WorkCenterCode; string; Abbreviation that identifies the work center for the overhead rate under the work definition operation.
    • WorkCenterDescription; string; Description of the work center for the work definition operation.
    • WorkCenterId; integer; Value that uniquely identifies the work center for which the overhead rates are displayed.
    • WorkCenterName; string; Name of the work center for the work definition operation.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : standardOverheadRates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : standardOverheadRates-item-response
Type: object
Show Source
  • Default Value: CST_STD_OVERHEAD_RATES
    Identifies the entity name of the attachment for the overhead rates.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Maximum Length: 820
    Abbreviation that identifies the item category.
  • Title: Item Category
    Value that uniquely identifies the item category for which the overhead rates are displayed.
  • Title: Item Category
    Read Only: true
    Maximum Length: 2400
    Name of the item category.
  • Title: Cost Book
    Maximum Length: 30
    Abbreviation that identifies the cost book in which the standard overhead rate details are displayed.
  • Title: Cost Book Description
    Read Only: true
    Maximum Length: 240
    Description of the cost book.
  • Title: Cost Book
    Value that uniquely identifies the cost book.
  • Title: Cost Organization Code
    Read Only: true
    Maximum Length: 150
    Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.
  • Title: Cost Organization
    Value that uniquely identifies the cost organization.
  • Title: Cost Organization
    Maximum Length: 240
    Name of the cost organization for which the standard overhead rate is displayed.
  • Title: Currency Code
    Maximum Length: 15
    Abbreviation that identifies the currency in which the overhead rate is set up.
  • Title: Currency Name
    Read Only: true
    Maximum Length: 80
    Name of the currency.
  • Title: Effective End Date
    Date when standard overhead rate is no longer effective. A date of 31-12-4712 indicates that this overhead rate record is the current effective rate.
  • Title: Effective Start Date
    Date when the standard overhead rate is effective.
  • Maximum Length: 18
    Unique reference number added by the user to link an overhead rate header with the detail record. This is only applicable when the overhead rate is created through Oracle Visual Builder Cloud Service template.
  • Title: Inventory Organization Code
    Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization to which the item belongs.
  • Title: Plant
    Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
  • Title: Plant
    Maximum Length: 240
    Name of the organization to which the component item belongs.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item for which standard overhead rate is displayed.
  • Title: Item
    Value that uniquely identifies an item.
  • Title: Item
    Maximum Length: 1000
    Number that identifies the item.
  • Links
  • Title: Overhead Rate Type
    Maximum Length: 30
    Type of overhead rate. Values include PLANT and WORKCENTER. A list of accepted values is defined in the lookup type ORA_CST_OVERHEAD_RATE_TYPE.
  • Title: Overhead Rate Type
    Read Only: true
    Maximum Length: 80
    Translatable name for overhead rate type code.
  • Title: Resource Type
    Maximum Length: 30
    Type of resource. Values include LABOR and EQUIPMENT. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.
  • Title: Resource Type
    Read Only: true
    Maximum Length: 80
    Translatable name for resource type codes.
  • Title: Scenario
    Value that uniquely identifies the cost scenario for which the overhead rate is set up.
  • Title: Scenario
    Maximum Length: 30
    Number that identifies the cost planning scenario. This value is defined by the user.
  • Standard Cost Overhead Rate Details
    Title: Standard Cost Overhead Rate Details
    The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate.
  • Value that uniquely identifies the standard overhead rate.
  • Title: Status
    Maximum Length: 30
    Default Value: IN_PROCESS
    Abbreviation that identifies the status of the displayed overhead rate. Values include IN_PROCESS and PUBLISHED, EXCLUDED_FROM_PUBLISH. A list of accepted values is defined in the lookup type ORA_CST_STD_COST_STATUSES.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Translatable name for the status code.
  • Title: Work Center Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center for the overhead rate under the work definition operation.
  • Title: Work Center Description
    Read Only: true
    Maximum Length: 240
    Description of the work center for the work definition operation.
  • Title: Work Center
    Value that uniquely identifies the work center for which the overhead rates are displayed.
  • Title: Work Center
    Maximum Length: 120
    Name of the work center for the work definition operation.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Standard Cost Overhead Rate Details
Type: array
Title: Standard Cost Overhead Rate Details
The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate.
Show Source
Nested Schema : standardOverheadRates-Attachments-item-response
Type: object
Show Source
Nested Schema : standardOverheadRates-standardOverheadRateDetails-item-response
Type: object
Show Source
  • Title: Absorption Type
    Maximum Length: 30
    Default Value: PERCENTAGE
    Type of absorption of the displayed overhead rate. Valid values include FIXED_AMOUNT and PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CST_ABSORPTION_TYPE.
  • Title: Absorption Type
    Read Only: true
    Maximum Length: 80
    Meaning of the absorption type. This value is user defined.
  • Title: Cost Element Code
    Maximum Length: 30
    Abbreviation that identifies the cost element for which the overhead rate details are displayed.
  • Title: Cost Element Description
    Read Only: true
    Maximum Length: 240
    Description of the cost element.
  • Title: Cost Element
    Value that uniquely identifies the cost element.
  • Title: Cost Element Type
    Read Only: true
    Maximum Length: 30
    Default Value: OVERHEAD
    Type of cost element.
  • Title: Cost Element Type
    Read Only: true
    Maximum Length: 80
    Meaning of the cost element type. This value is user-defined.
  • Title: Expense Pool
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the expense pool. This value is user defined.
  • Title: Expense Pool
    Value that uniquely identifies the expense pool of the overhead rate detail.
  • Title: Expense Pool
    Maximum Length: 80
    Name of the expense pool.
  • Links
  • Value that uniquely identifies the standard overhead rate detail.
  • Title: Rate
    Value that indicates the unit rate for the cost component in the overhead rate. The value for this attribute is null when absorption type is FIXED.
  • Title: Value
    Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.
Back to Top

Examples

This example describes how to get all overhead rates.

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

Example Response Body

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

{
	  "items": [
	    {
		      "StandardOverheadRateId": 300100181560243,
		      "ScenarioId": 300100172970824,
		      "ScenarioNumber": "CSTAUTO1-Std-Base",
		      "CostOrgId": 300100172982769,
		      "CostOrgCode": "Auto1-CO",
		      "CostOrgName": "Auto1-CO",
		      "CostBookId": 300100172970785,
		      "CostBookCode": "Auto1-Std",
		      "CostBookDescription": "CST Automation 1 Standard Cost Book",
		      "InventoryOrgId": 300100172909868,
		      "InventoryOrgCode": "CSTAUTO1",
		      "InventoryOrgName": "CSTAUTO1",
		      "OverheadRateType": "PLANT",
		      "OverheadRateTypeMeaning": "Plant overhead",
		      "EffectiveStartDate": "1900-01-01",
		      "EffectiveEndDate": "4712-12-31",
		      "StatusCode": "PUBLISHED",
		      "StatusCodeMeaning": "Published",
		      "ItemId": 300100059526522,
		      "ItemNumber": "ZC-1",
		      "ItemDescription": "ZC-1",
		      "CategoryId": null,
		      "CategoryCode": null,
		      "CategoryName": null,
		      "WorkCenterId": null,
		      "WorkCenterCode": null,
		      "WorkCenterName": null,
		      "WorkCenterDescription": null,
		      "CurrencyCode": "USD",
		      "CurrencyName": "US Dollar",
		      "ResourceType": null,
		      "ResourceTypeMeaning": null,
		      "links": [
		        {
			          "rel": "self",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "canonical",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "child",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243/child/standardOverheadRateDetails",
			          "name": "standardOverheadRateDetails",
			          "kind": "collection"
			        }
		      ]
		    },
	    {
		      "StandardOverheadRateId": 300100181560241,
		      "ScenarioId": 300100172970824,
		      "ScenarioNumber": "CSTAUTO1-Std-Base",
		      "CostOrgId": 300100172982769,
		      "CostOrgCode": "Auto1-CO",
		      "CostOrgName": "Auto1-CO",
		      "CostBookId": 300100172970785,
		      "CostBookCode": "Auto1-Std",
		      "CostBookDescription": "CST Automation 1 Standard Cost Book",
		      "InventoryOrgId": 300100172909868,
		      "InventoryOrgCode": "CSTAUTO1",
		      "InventoryOrgName": "CSTAUTO1",
		      "OverheadRateType": "PLANT",
		      "OverheadRateTypeMeaning": "Plant overhead",
		      "EffectiveStartDate": "1900-01-01",
		      "EffectiveEndDate": "4712-12-31",
		      "StatusCode": "PUBLISHED",
		      "StatusCodeMeaning": "Published",
		      "ItemId": 300100059526520,
		      "ItemNumber": "ZDQ-Enj",
		      "ItemDescription": "ZDQ-Enj",
		      "CategoryId": null,
		      "CategoryCode": null,
		      "CategoryName": null,
		      "WorkCenterId": null,
		      "WorkCenterCode": null,
		      "WorkCenterName": null,
		      "WorkCenterDescription": null,
		      "CurrencyCode": "USD",
		      "CurrencyName": "US Dollar",
		      "ResourceType": null,
		      "ResourceTypeMeaning": null,
		      "links": [
		        {
			          "rel": "self",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560241",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "canonical",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560241",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "child",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560241/child/standardOverheadRateDetails",
			          "name": "standardOverheadRateDetails",
			          "kind": "collection"
			        }
		      ]
		    },],
	  "count": 19,
	  "hasMore": false,
	  "limit": 25,
	  "offset": 0,
	  "links": [
	    {
		      "rel": "self",
		      "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates",
		      "name": "standardOverheadRates",
		      "kind": "collection"
		    }
	  ]
}
Back to Top