Create transfer charge rule
post
/fscmRestApi/resources/11.13.18.05/transferChargeRules
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DestinationOrganizationCode: string
Title:
Destination Organization
Maximum Length:18
Code of the destination inventory organization. -
DestinationOrganizationId(required): integer
(int64)
Value that uniquely identifies the inventory organization.
-
DestinationOrganizationName(required): string
Maximum Length:
240
Name of the destination inventory organization participating in the movement of materials. -
EndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the rule is effective. -
LastUsedDate: string
(date-time)
Title:
Last Used Date
Date on which the transfer charge rule was last used. -
ruleDetails: array
Transfer Charge Rule Details
Title:
Transfer Charge Rule Details
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. -
RuleSetName: string
Title:
Transfer Charge Rule Set Name
Maximum Length:80
Identifies the rule set name for the transfer charge. -
SourceOrganizationCode: string
Title:
Source Organization
Maximum Length:18
Code of the source inventory organization. -
SourceOrganizationId(required): integer
(int64)
Value that uniquely identifies the inventory organization.
-
SourceOrganizationName(required): string
Maximum Length:
240
Name of the source inventory organization participating in the movement of materials. -
StartDate(required): string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the rule is effective. -
TransferChargeRuleSetId: integer
(int64)
Value that uniquely identifies the transfer charge rule set header for the transfer rule.
Nested Schema : Transfer Charge Rule Details
Type:
array
Title:
Transfer Charge Rule Details
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.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CostElement: string
Title:
Cost Element
Maximum Length:30
Cost element to use when creating an transfer charge rule detail. -
CostElementId: integer
(int64)
Value that uniquely identifies the cost element.
-
ExpensePoolCode: string
Title:
Expense Pool
Maximum Length:30
Expense 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:
30
Abbreviation that identifies the transfer charge value type. Values include PERCENT. -
TransferChargeValue: number
Title:
Rate
Value 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 By
Read Only:true
Maximum Length:64
Name of the user who created the transfer charge rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the transfer charge rule was created. -
DestinationOrganizationCode: string
Title:
Destination Organization
Maximum Length:18
Code of the destination inventory organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
DestinationOrganizationName: string
Maximum Length:
240
Name of the destination inventory organization participating in the movement of materials. -
EndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the rule is effective. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the transfer charge rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the transfer charge rule. -
LastUsedDate: string
(date-time)
Title:
Last Used Date
Date on which the transfer charge rule was last used. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ruleDetails: array
Transfer Charge Rule Details
Title:
Transfer Charge Rule Details
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. -
RuleSetName: string
Title:
Transfer Charge Rule Set Name
Maximum Length:80
Identifies the rule set name for the transfer charge. -
SourceOrganizationCode: string
Title:
Source Organization
Maximum Length:18
Code of the source inventory organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
SourceOrganizationName: string
Maximum Length:
240
Name of the source inventory organization participating in the movement of materials. -
StartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the rule is effective. -
TransferChargeRuleId: integer
(int64)
Read Only:
true
Value 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transfer Charge Rule Details
Type:
array
Title:
Transfer Charge Rule Details
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.
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 : transferChargeRules-ruleDetails-item-response
Type:
Show Source
object
-
CostElement: string
Title:
Cost Element
Maximum Length:30
Cost element to use when creating an transfer charge rule detail. -
CostElementId: integer
(int64)
Value that uniquely identifies the cost element.
-
CostElementType: string
Read Only:
true
Maximum Length:255
Value that identifies the cost element type of the cost element used in the transfer charge rule. -
CostElementTypeCode: string
Title:
Cost Element Type
Read Only:true
Maximum Length:30
Value that identifies the cost element type of the cost element used in the transfer charge rule. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the transfer charge rule detail. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the transfer charge rule detail was created. -
ExpensePoolCode: string
Title:
Expense Pool
Maximum Length:30
Expense 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 Date
Read Only:true
Date on which the transfer charge rule detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the transfer charge rule detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransferChargeRuleDetailId: integer
(int64)
Read Only:
true
Value 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 Type
Read Only:true
Maximum Length:80
Meaning that identifies the transfer charge value type. -
TransferChargeTypeCode: string
Maximum Length:
30
Abbreviation that identifies the transfer charge value type. Values include PERCENT. -
TransferChargeValue: number
Title:
Rate
Value for the transfer charge rule rollup.
Nested Schema : Links
Type:
array
Title:
Links
The 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 create transfer charge rules.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/transferChargeRules"
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.
{ "RuleSetName": "ACHIEVERS-Rule set 2", "SourceOrganizationCode": "V1", "DestinationOrganizationCode": "M1", "StartDate": "2023-01-01", "EndDate": "null", "ruleDetails": [ { "CostElement": "RS-OVERHEAD", "ExpensePoolCode": "CML Exp Pool", "TransferChargeTypeCode": "PERCENT", "TransferChargeValue": 4 } ] }
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": "M1", "DestinationOrganizationName": "Seattle Manufacturing", "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" } ] }