Get one rule
get
/fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules/{RuleId}
Request
Path Parameters
-
RuleId(required): integer(int64)
Value that uniquely identifies the overhead rule. The system creates this value.
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : costAccountingOverheadRules-item-response
Type:
Show Source
object
-
AbsorptionType: string
Title:
Absorption Type
Maximum Length:255
Name of the absorption type that dictates the accounting behavior of the overhead rule. A list of accepted transaction group codes is defined in the lookup type CST_ABSORPTION_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Costing Lookups task. -
AbsorptionTypeCode: string
Title:
Absorption Type
Maximum Length:3
Abbreviation that identifies the absorption type. -
BasedOn: string
Title:
Based On
Maximum Length:30
Value that specifies the cost element group according to which the base cost is derived when the cost basis is a percentage value. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Element Group task. -
CategoryId: integer
(int64)
Title:
Category ID
Value that uniquely identifies the item category. -
CategoryName: string
Title:
Category Name
Maximum Length:2400
Name of the item category where the overhead rule applies. The category must be part of the costing catalog. -
CostBasis: string
Title:
Cost Basis
Maximum Length:255
Basis used to calculate the overhead amount. A list of accepted transaction group codes is defined in the lookup type CST_COST_DRIVER. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Costing Lookups task. -
CostBasisCode: string
Title:
Cost Basis
Maximum Length:18
Abbreviation that identifies the cost basis. -
CostBook: string
Title:
Cost Book
Maximum Length:30
Cost book where the overhead rule applies. -
CostBookId: integer
(int64)
Title:
Cost Book ID
Value that uniquely identifies the cost book. -
CostElement: string
Title:
Cost Element
Maximum Length:30
Cost element to use when charging overhead. The cost element must be part of the common set or the cost organization set. -
CostElementId: integer
(int64)
Title:
Cost Element ID
Value that uniquely identifies the cost element. -
CostOrganizationId: integer
(int64)
Title:
Cost Organization ID
Value that uniquely identifies the cost organization. -
CostOrganizationName: string
Title:
Cost Organization
Maximum Length:240
Name of the cost organization where the overhead rule applies. -
ElementGroupId: integer
(int64)
Title:
Element Group ID
Value that uniquely identifies the element group. -
ExpensePool: string
Title:
Expense Pool
Maximum Length:30
Expense pool to use when charging overhead. The expense pool must be part of the common set or the cost organization set. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool ID
Value that uniquely identifies the expense pool. -
InventoryOrganizationCode: string
Title:
Inventory Organization
Maximum Length:18
Abbreviation that identifies the inventory organization where the overhead rule applies. The specified inventory organization must be linked to the cost organization that is specified when creating this overhead rule. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization ID
Value that uniquely identifies the inventory organization. -
Item: string
Title:
Item
Maximum Length:300
Name of the item where the overhead rule applies. -
ItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverheadRuleDetails: array
Overhead Rule Details for Cost Accounting
Title:
Overhead Rule Details for Cost Accounting
The Overhead Rule Details for Cost Accounting resource allows you to create different overhead rates that apply during different time periods so that you can manage rates that change over time. -
PeriodicAverageFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the cost book to which the overhead rule applies is a periodic average cost book. -
ProcessedFlagMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the rule that indicates if it's used by the cost processor for absorption of the overheads. -
RuleId: integer
(int64)
Title:
Rule ID
Read Only:true
Value that uniquely identifies the overhead rule. The system creates this value. -
RuleName: string
Title:
Rule Name
Maximum Length:30
Name of the rule that the user specifies. The rule name must be unique. -
TransactionFlow: string
Title:
Transaction Flow
Maximum Length:255
Name of the transaction flow where the overhead rule applies. A list of accepted transaction group codes is defined in the lookup type CST_QUANTITY_FLOW. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Costing Lookups task. -
TransactionFlowCode: string
Title:
Transaction Flow
Maximum Length:18
Abbreviation that identifies the transaction flow. -
TransactionGroup: string
Title:
Transaction Group
Maximum Length:255
Name of the transaction group that identifies the transaction types set where the overhead rule applies. A list of accepted transaction group codes is defined in the lookup type CST_TRANSACTION_GROUPS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Costing Lookups task. -
TransactionGroupId: integer
(int64)
Title:
Transaction Group ID
Value that uniquely identifies the transaction group. -
TransactionType: string
Title:
Transaction Type
Maximum Length:255
Name of the transaction type where the overhead rule applies. A list of accepted transaction type codes is defined in the view CST_ALL_TXN_TYPES_V. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type ID
Value that uniquely identifies the type of transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Overhead Rule Details for Cost Accounting
Type:
array
Title:
Overhead Rule Details for Cost Accounting
The Overhead Rule Details for Cost Accounting resource allows you to create different overhead rates that apply during different time periods so that you can manage rates that change over time.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : costAccountingOverheadRules-OverheadRuleDetails-item-response
Type:
Show Source
object
-
CostBook: string
Read Only:
true
Cost book to which the overhead rule applies. -
CostOrganizationName: string
Read Only:
true
Name of the cost organization to which the overhead rule applies. -
EndDate: string
(date)
Title:
End Date
Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable. -
FromPeriod: string
Title:
From Period
Cost book period from when the overhead rate is applicable. -
FromPeriodStatus: string
Read Only:
true
Indicates the status of the period from when the overhead rate is defined. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessedFlagMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the rule revision that indicates if it's used by the cost processor for absorption of the overheads. -
Rate: number
Title:
Rate
Rate to use for calculation of overhead. It is either a number or a percentage depending on the cost basis defined for this overhead rule. -
RevisionNumber: integer
Title:
Revision Number
Read Only:true
Revision number of the rule detail. The system generates this value. -
RuleDetailId: integer
(int64)
Title:
Rule Detail ID
Read Only:true
Value that uniquely identifies the overhead rule detail. The system creates this value. -
RuleId: integer
(int64)
Title:
Rule ID
Read Only:true
Value that uniquely identifies the overhead rule against which this rule detail is created. -
RuleName: string
Read Only:
true
Name of the rule that the user specifies. The rule name must be unique. -
StartDate: string
(date)
Title:
Start Date
Date when this revision of the overhead rule becomes active. The transactions on or after this date use the overhead rate when applicable. -
ToPeriod: string
Title:
To Period
Cost book period till when the overhead rate is applicable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- OverheadRuleDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules/{RuleId}/child/OverheadRuleDetailsParameters:
- RuleId:
$request.path.RuleId
The Overhead Rule Details for Cost Accounting resource allows you to create different overhead rates that apply during different time periods so that you can manage rates that change over time. - RuleId:
Examples
This example describes how to get one cost accounting overhead rule.
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/costAccountingOverheadRules/RuleId"
For example, the following command gets cost accounting overhead rule where the rule identifier is 300100111253919:
curl -u username:password "https://servername/fscmRestApi/resources/version/costAccountingOverheadRules/300100111253919"
Example Response Body
The following shows an example of the response body in JSON format.
{ "RuleId" : 300100111253919, "RuleName" : "Rule1", "CostOrganizationName" : "Seattle", "CostOrganizationId" : 999993000015516, "CostBook" : "Primary", "CostBookId" : 300100003455478, "ExpensePool" : "Electrical Expense", "ExpensePoolId" : 300100089911214, "CostElement" : "Electricity", "CostElementId" : 300100089911236, "TransactionGroup" : "Purchase order transactions", "TransactionGroupId" : 5, "TransactionType" : "Purchase Order Receipt", "TransactionTypeId" : 18, "TransactionFlow" : "Receipt", "TransactionFlowCode" : "RECEIPT", "InventoryOrganizationCode" : null, "InventoryOrganizationId" : null, "CategoryName" : null, "CategoryId" : null, "Item" : null, "ItemId" : null, "CostBasis" : "Unit", "CostBasisCode" : "UNIT", "BasedOn" : null, "ElementGroupId" : null, "AbsorptionType" : "Include in inventory", "AbsorptionTypeCode" : "1" }