Update one component
patch
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/charges/{chargesUniqID}/child/chargeComponents/{chargeComponentsUniqID}
Request
Path Parameters
-
OrderKey(required): string
Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
-
chargeComponentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Charge Components resource and used to uniquely identify an instance of Charge Components. The client should not generate the hash key value. Instead, the client should query on the Charge Components collection resource in order to navigate to a specific instance of Charge Components to get the hash key.
-
chargesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Charges resource and used to uniquely identify an instance of Charges. The client should not generate the hash key value. Instead, the client should query on the Charges collection resource in order to navigate to a specific instance of Charges to get the hash key.
-
linesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ChargeCurrency: string
Maximum Length:
1000
Name of the currency that the charge component uses. -
ChargeCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that the charge component uses. -
ChargeCurrencyDurationExtendedAmount: number
Extended amount for the duration in the charge currency.
-
ChargeCurrencyExtendedAmount: number
Extended amount in the charge currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quantity for configurations.
-
ChargeCurrencyUnitPrice: number
Price or adjustment for each unit displayed in the charge currency for the line unit of measure.
-
Explanation: string
Maximum Length:
1000
Explanation of the charge component. -
HeaderCurrency: string
Maximum Length:
1000
Name of the currency that the order header uses. -
HeaderCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that the order header uses. -
HeaderCurrencyDurationExtendedAmount: number
Extended amount for the duration, displayed in the currency that the order header uses.
-
HeaderCurrencyExtendedAmount: number
Extended amount, displayed in the currency that the order header uses.
-
HeaderCurrencyUnitPrice: number
Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
-
PriceElement: string
Maximum Length:
240
Name of the price element. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the price element, for example, LISTPRICE, NETPRICE, and so on. -
PriceElementUsage: string
Maximum Length:
240
Name that describes charge component usage. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that identifies the charge component usage. -
RollupFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the value is a rollup or aggregate value for the charge component price element code. If false, then the value is not a rollup aggregate value for the charge component price element code. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
SequenceNumber: integer
(int32)
Sequence number for the charge component.
-
SourceManualPriceAdjustmentId: string
Maximum Length:
50
Value that uniquely identifies the manual price adjustment. The source application assigns this value. -
TransactionalCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that pricing used to price the transaction.
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 : salesOrdersForOrderHubRequests-lines-charges-chargeComponents-item-response
Type:
Show Source
object
-
ChargeCurrency: string
Maximum Length:
1000
Name of the currency that the charge component uses. -
ChargeCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that the charge component uses. -
ChargeCurrencyDurationExtendedAmount: number
Extended amount for the duration in the charge currency.
-
ChargeCurrencyExtendedAmount: number
Extended amount in the charge currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quantity for configurations.
-
ChargeCurrencyUnitPrice: number
Price or adjustment for each unit displayed in the charge currency for the line unit of measure.
-
Explanation: string
Maximum Length:
1000
Explanation of the charge component. -
HeaderCurrency: string
Maximum Length:
1000
Name of the currency that the order header uses. -
HeaderCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that the order header uses. -
HeaderCurrencyDurationExtendedAmount: number
Extended amount for the duration, displayed in the currency that the order header uses.
-
HeaderCurrencyExtendedAmount: number
Extended amount, displayed in the currency that the order header uses.
-
HeaderCurrencyUnitPrice: number
Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceElement: string
Maximum Length:
240
Name of the price element. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the price element, for example, LISTPRICE, NETPRICE, and so on. -
PriceElementUsage: string
Maximum Length:
240
Name that describes charge component usage. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that identifies the charge component usage. -
RollupFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the value is a rollup or aggregate value for the charge component price element code. If false, then the value is not a rollup aggregate value for the charge component price element code. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
SequenceNumber: integer
(int32)
Sequence number for the charge component.
-
SourceChargeComponentId: string
Maximum Length:
50
Value that uniquely identifies the charge component. The source application assigns this value. -
SourceChargeId: string
Maximum Length:
120
Value that uniquely identifies the charge. The source application assigns this value. -
SourceManualPriceAdjustmentId: string
Maximum Length:
50
Value that uniquely identifies the manual price adjustment. The source application assigns this value. -
SourceParentChargeComponentId: string
Maximum Length:
50
Value that uniquely identifies the charge component for the contributing charge. This attribute is used only when the parent charge is a rollup charge. -
TransactionalCurrencyCode: string
Maximum Length:
1000
Abbreviation that identifies the currency that pricing used to price the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.