Update one transfer charge rule
patch
/fscmRestApi/resources/11.13.18.05/transferChargeRules/{TransferChargeRuleId}
Request
Path Parameters
-
TransferChargeRuleId(required): integer(int64)
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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
DestinationOrganizationCode: string
Title:
Destination OrganizationMaximum Length:18Code of the destination inventory organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
DestinationOrganizationName: string
Maximum Length:
240Name of the destination inventory organization participating in the movement of materials. -
EndDate: string
(date)
Title:
Effective End DateDate at the end of the date range within which the rule is effective. -
LastUsedDate: string
(date-time)
Title:
Last Used DateDate on which the transfer charge rule was last used. -
ruleDetails: array
Transfer Charge Rule Details
Title:
Transfer Charge Rule DetailsThe Transfer Charge Rule Details resource allows users to create rule details applicable during interorganization movement of materials to roll up the costs by supply chain cost rollup process. -
SourceOrganizationCode: string
Title:
Source OrganizationMaximum Length:18Code of the source inventory organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
SourceOrganizationName: string
Maximum Length:
240Name of the source inventory organization participating in the movement of materials. -
StartDate: string
(date)
Title:
Effective Start DateDate at the beginning of the date range within which the rule is effective.
Nested Schema : Transfer Charge Rule Details
Type:
arrayTitle:
Transfer Charge Rule DetailsThe Transfer Charge Rule Details resource allows users to create rule details applicable during interorganization movement of materials to roll up the costs by supply chain cost rollup process.
Show Source
Nested Schema : schema
Type:
Show Source
object-
CostElement: string
Title:
Cost ElementMaximum Length:30Cost element to use when creating an transfer charge rule detail. -
CostElementId: integer
(int64)
Value that uniquely identifies the cost element.
-
ExpensePoolCode: string
Title:
Expense PoolMaximum Length:30Expense pool to be used in the transfer charge rule detail. -
ExpensePoolId: integer
(int64)
Value that uniquely identifies the expense pool.
-
TransferChargeRuleId: integer
(int64)
Value that uniquely identifies the transfer charge rule header for the transfer rule detail.
-
TransferChargeTypeCode: string
Maximum Length:
30Abbreviation that identifies the transfer charge value type. Values include PERCENT. -
TransferChargeValue: number
Title:
RateValue for the transfer charge rule rollup.
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.
Root Schema : transferChargeRules-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Name of the user who created the transfer charge rule. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the transfer charge rule was created. -
DestinationOrganizationCode: string
Title:
Destination OrganizationMaximum Length:18Code of the destination inventory organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
DestinationOrganizationName: string
Maximum Length:
240Name of the destination inventory organization participating in the movement of materials. -
EndDate: string
(date)
Title:
Effective End DateDate at the end of the date range within which the rule is effective. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the transfer charge rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Name of the user who last updated the transfer charge rule. -
LastUsedDate: string
(date-time)
Title:
Last Used DateDate on which the transfer charge rule was last used. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ruleDetails: array
Transfer Charge Rule Details
Title:
Transfer Charge Rule DetailsThe Transfer Charge Rule Details resource allows users to create rule details applicable during interorganization movement of materials to roll up the costs by supply chain cost rollup process. -
RuleSetName: string
Title:
Transfer Charge Rule Set NameMaximum Length:80Identifies the rule set name for the transfer charge. -
SourceOrganizationCode: string
Title:
Source OrganizationMaximum Length:18Code of the source inventory organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
SourceOrganizationName: string
Maximum Length:
240Name of the source inventory organization participating in the movement of materials. -
StartDate: string
(date)
Title:
Effective Start DateDate at the beginning of the date range within which the rule is effective. -
TransferChargeRuleId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transfer charge rule. The application generates this value. -
TransferChargeRuleSetId: integer
(int64)
Value that uniquely identifies the transfer charge rule set header for the transfer rule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transfer Charge Rule Details
Type:
arrayTitle:
Transfer Charge Rule DetailsThe Transfer Charge Rule Details resource allows users to create rule details applicable during interorganization movement of materials to roll up the costs by supply chain cost rollup process.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : transferChargeRules-ruleDetails-item-response
Type:
Show Source
object-
CostElement: string
Title:
Cost ElementMaximum Length:30Cost element to use when creating an transfer charge rule detail. -
CostElementId: integer
(int64)
Value that uniquely identifies the cost element.
-
CostElementType: string
Read Only:
trueMaximum Length:255Value that identifies the cost element type of the cost element used in the transfer charge rule. -
CostElementTypeCode: string
Title:
Cost Element TypeRead Only:trueMaximum Length:30Value that identifies the cost element type of the cost element used in the transfer charge rule. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Name of the user who created the transfer charge rule detail. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the transfer charge rule detail was created. -
ExpensePoolCode: string
Title:
Expense PoolMaximum Length:30Expense pool to be used in the transfer charge rule detail. -
ExpensePoolId: integer
(int64)
Value that uniquely identifies the expense pool.
-
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the transfer charge rule detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Name of the user who last updated the transfer charge rule detail. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransferChargeRuleDetailId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transfer charge rule detail. The application generates this value. -
TransferChargeRuleId: integer
(int64)
Value that uniquely identifies the transfer charge rule header for the transfer rule detail.
-
TransferChargeType: string
Title:
Charge TypeRead Only:trueMaximum Length:80Meaning that identifies the transfer charge value type. -
TransferChargeTypeCode: string
Maximum Length:
30Abbreviation that identifies the transfer charge value type. Values include PERCENT. -
TransferChargeValue: number
Title:
RateValue for the transfer charge rule rollup.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ruleDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/transferChargeRules/{TransferChargeRuleId}/child/ruleDetailsParameters:
- TransferChargeRuleId:
$request.path.TransferChargeRuleId
The Transfer Charge Rule Details resource allows users to create rule details applicable during interorganization movement of materials to roll up the costs by supply chain cost rollup process. - TransferChargeRuleId:
Examples
This example describes how to update one transfer charge 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/transferChargeRules/TransferChargeRuleId"
For
example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/transferChargeRules/300100573549594"
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.
{
"DestinationOrganizationCode": "CSTINVORG"
}
Example Response Body
The following example includes the contents of the response
body in JSON format:
{
"TransferChargeRuleId": 300100573549594,
"TransferChargeRuleSetId": 300100573542592,
"RuleSetName": "ACHIEVERS-Rule set 2",
"SourceOrganizationId": 204,
"SourceOrganizationCode": "V1",
"SourceOrganizationName": "Vision Operations",
"DestinationOrganizationId": 207,
"DestinationOrganizationCode": "CSTINVORG",
"DestinationOrganizationName": "Costing Inventory Org",
"StartDate": "2023-01-01",
"EndDate": "null",
"LastUsedDate": null,
"CreatedBy": "COST_ACCT_ALL_COST_ORGS",
"CreationDate": "2023-03-21T03:30:58.765+00:00",
"LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
"LastUpdateDate": "2023-03-21T03:30:58.766+00:00",
"links": [
{
"rel": "self",
"href": "http://servername/fscmRestApi/resources/version/transferChargeRules/300100573549594",
"name": "transferChargeRules",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://servername/fscmRestApi/resources/version/transferChargeRules/300100573549594",
"name": "transferChargeRules",
"kind": "item"
},
{
"rel": "child",
"href": "http://servername/fscmRestApi/resources/version/transferChargeRules/300100573549594/child/ruleDetails",
"name": "ruleDetails",
"kind": "collection"
}
]
}