1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Cost Accounting Overhead Rules

Update one rule

patch

/fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules/{RuleId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • Title: Absorption Type
    Maximum Length: 3
    Abbreviation that identifies the absorption type.
  • 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.
  • Title: Category ID
    Value that uniquely identifies the item category.
  • 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.
  • 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.
  • Title: Cost Basis
    Maximum Length: 18
    Abbreviation that identifies the cost basis.
  • 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.
  • Title: Cost Element ID
    Value that uniquely identifies the cost element.
  • Title: Element Group ID
    Value that uniquely identifies the element group.
  • 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.
  • Title: Expense Pool ID
    Value that uniquely identifies the expense pool.
  • 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.
  • Title: Inventory Organization ID
    Value that uniquely identifies the inventory organization.
  • Title: Item
    Maximum Length: 300
    Name of the item where the overhead rule applies.
  • Title: Item ID
    Value that uniquely identifies the item.
  • 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.
  • Maximum Length: 1
    Default Value: N
    Status code of the rule revision that indicates whether it's used by the cost processor for overhead absorption.
  • 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.
  • Title: Transaction Flow
    Maximum Length: 18
    Abbreviation that identifies the transaction flow.
  • 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.
  • Title: Transaction Group ID
    Value that uniquely identifies the transaction group.
  • 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.
  • Title: Transaction Type ID
    Value that uniquely identifies the type of transaction.
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 : costAccountingOverheadRules-OverheadRuleDetails-item-patch-request
Type: object
Show Source
  • Title: End Date
    Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.
  • Title: From Period
    Cost book period from when the overhead rate is applicable.
  • Maximum Length: 80
    Indicates the status code for the period in which the overhead rate is defined for PAC cost books.
  • Title: Rate
    Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.
  • 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.
  • Title: To Period
    Cost book period till when the overhead rate is applicable.
  • Indicates the status code for the period up to which the overhead rate is defined for PAC cost books.
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 : costAccountingOverheadRules-item-response
Type: object
Show Source
  • 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.
  • Title: Absorption Type
    Maximum Length: 3
    Abbreviation that identifies the absorption type.
  • 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.
  • Title: Category ID
    Value that uniquely identifies the item category.
  • 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.
  • 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.
  • Title: Cost Basis
    Maximum Length: 18
    Abbreviation that identifies the cost basis.
  • Title: Cost Book
    Maximum Length: 30
    Cost book where the overhead rule applies.
  • Title: Cost Book ID
    Value that uniquely identifies the cost book.
  • 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.
  • Title: Cost Element ID
    Value that uniquely identifies the cost element.
  • Title: Cost Organization ID
    Value that uniquely identifies the cost organization.
  • Title: Cost Organization
    Maximum Length: 240
    Name of the cost organization where the overhead rule applies.
  • Title: Element Group ID
    Value that uniquely identifies the element group.
  • 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.
  • Title: Expense Pool ID
    Value that uniquely identifies the expense pool.
  • 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.
  • Title: Inventory Organization ID
    Value that uniquely identifies the inventory organization.
  • Read Only: true
    Maximum Length: 240
    Name of the inventory organization.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the cost processor is running for the given cost organization and cost book.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the rule attributes can be updated.
  • Title: Item
    Maximum Length: 300
    Name of the item where the overhead rule applies.
  • Title: Item ID
    Value that uniquely identifies the item.
  • Read Only: true
    Indicates the last updated date of the overhead rule.
  • Read Only: true
    End date of the latest rule revision.
  • Read Only: true
    Rate of the latest rule revision.
  • Read Only: true
    Start date of the latest rule revision.
  • Links
  • 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.
  • Read Only: true
    Maximum Length: 1
    Indicates if the cost book to which the overhead rule applies is a periodic average cost book.
  • Maximum Length: 1
    Default Value: N
    Status code of the rule revision that indicates whether it's used by the cost processor for overhead absorption.
  • 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.
  • Title: Rule ID
    Read Only: true
    Value that uniquely identifies the overhead rule. The system creates this value.
  • Title: Rule Name
    Maximum Length: 30
    Name of the rule that the user specifies. The rule name must be unique.
  • Read Only: true
    Maximum Length: 255
    Status of the rule. The values are active and expired.
  • 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.
  • Title: Transaction Flow
    Maximum Length: 18
    Abbreviation that identifies the transaction flow.
  • 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.
  • Title: Transaction Group ID
    Value that uniquely identifies the transaction group.
  • 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.
  • Title: Transaction Type ID
    Value that uniquely identifies the type of transaction.
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 : costAccountingOverheadRules-OverheadRuleDetails-item-response
Type: object
Show Source
  • Read Only: true
    Cost book to which the overhead rule applies.
  • Read Only: true
    Name of the cost organization to which the overhead rule applies.
  • Title: End Date
    Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.
  • Title: From Period
    Cost book period from when the overhead rate is applicable.
  • Read Only: true
    Indicates the status of the period from when the overhead rate is defined.
  • Maximum Length: 80
    Indicates the status code for the period in which the overhead rate is defined for PAC cost books.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the rate detail attributes can be updated for non PAC book overhead rules.
  • Links
  • 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.
  • Title: Rate
    Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.
  • Title: Revision Number
    Read Only: true
    Revision number of the rule detail. The system generates this value.
  • Title: Rule Detail ID
    Read Only: true
    Value that uniquely identifies the overhead rule detail. The system creates this value.
  • Title: Rule ID
    Read Only: true
    Value that uniquely identifies the overhead rule against which this rule detail is created.
  • Read Only: true
    Name of the rule that the user specifies. The rule name must be unique.
  • 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.
  • Title: To Period
    Cost book period till when the overhead rate is applicable.
  • Indicates the status code for the period up to which the overhead rate is defined for PAC cost books.
Links
OverheadRuleDetails
Parameters:
  • 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.
Back to Top

Examples

This example describes how to update a cost accounting overhead rule.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/costAccountingOverheadRule/RuleId "

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
 "AbsorptionType" : "Expense"
}

Example Response Body

The following example includes the contents 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" : "Expense",
  "AbsorptionTypeCode" : "2",
  "OverheadRuleDetails" : [ {
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253920,
    "RevisionNumber" : 1,
    "StartDate" : "2017-01-01",
    "EndDate" : "4712-12-31",
    "Rate" : 10
 }
   ]
}
Back to Top