Update one charge tier
patch
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/charges/{chargesUniqID}/child/chargeTiers/{chargeTiersUniqID}
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.
-
chargeTiersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Charge Tiers resource and used to uniquely identify an instance of Charge Tiers. The client should not generate the hash key value. Instead, the client should query on the Charge Tiers collection resource in order to navigate to a specific instance of Charge Tiers 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
-
AdjustmentAmount: number
Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.
-
ApplicationMethod: string
Maximum Length:
80
Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat. -
ApplicationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS. -
BlockSize: number
Number that represents the size of the block for charge calculation for a tier.
-
TierFrom: number
Number that indicates the starting value of the tier.
-
TierSequenceNumber: number
Sequence number for the charge tier.
-
TierTo: number
Number that indicates the ending value of the tier.
Response
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 : salesOrdersForOrderHubRequests-lines-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.
-
ApplicationMethod: string
Maximum Length:
80
Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat. -
ApplicationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS. -
BlockSize: number
Number that represents the size of the block for charge calculation for a tier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceOrderChargeTierId: string
Maximum Length:
50
Value that uniquely identifies the charge tier in the source application. -
TierFrom: number
Number that indicates the starting value of the tier.
-
TierSequenceNumber: number
Sequence number for the charge tier.
-
TierTo: number
Number that indicates the ending value of the tier.
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.