Update one tier header
patch
/fscmRestApi/resources/11.13.18.05/pricingTiers/{TierHeaderId}
Request
Path Parameters
-
TierHeaderId(required): integer(int64)
Value that uniquely identifies the tier header.
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
-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
Name of the tier aggregation method. Valid values include On line and On document. A list of accepted values is defined in the lookup type ORA_QP_AGGREGATION_METHODS.
-
AggregationMethodCode: string
Title:
Aggregation Method
Maximum Length:30
Default Value:ORA_ON_DOCUMENT
Abbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Default Value:PER_UNIT
Abbreviation that identifies the method of tier application. -
AppliesTo: string
Name of the tier applicability. Valid values include Highest tier and All tiers. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES.
-
AppliesToCode: string
Title:
Apply To
Maximum Length:30
Default Value:HIGHEST_TIER
Abbreviation that identifies the tier applicability. -
headerDFF: array
Flexfields for Pricing Tiers
Title:
Flexfields for Pricing Tiers
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header. -
lines: array
Tier Lines
Title:
Tier Lines
The Tier Lines resource manages the tier line details for pricing charges and discounts. -
PartialBlockAction: string
Name of the tier partial block action. Valid values include Partial blocks and Satisfied blocks. A list of accepted values is defined in the lookup type ORA_QP_PARTIAL_BLOCK_ACTIONS.
-
PartialBlockActionCode: string
Title:
Partial Block Action
Maximum Length:30
Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier Basis
Value that uniquely identifies the tier basis. -
TierBasisType: string
Type of the tier basis. Valid values include Extended amount and Item quantity. A list of accepted values is defined in the lookup type ORA_QP_TIER_BASIS_TYPES.
-
TierBasisTypeCode: string
Title:
Tier Basis Type
Maximum Length:30
Abbreviation that identifies the type of the tier basis.
Nested Schema : Flexfields for Pricing Tiers
Type:
array
Title:
Flexfields for Pricing Tiers
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header.
Show Source
Nested Schema : Tier Lines
Type:
array
Title:
Tier Lines
The Tier Lines resource manages the tier line details for pricing charges and discounts.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : pricingTiers-lines-item-patch-request
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment Amount
Value of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Abbreviation that identifies the method of tier application. -
IncrementValue: integer
Title:
Increment Value
Increment value number. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values to a tier line. -
Maximum: number
Title:
Maximum
Maximum value for the tier line. -
Minimum: number
Title:
Minimum
Minimum value for the tier line. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
Nested Schema : Flexfields for Tier Lines
Type:
array
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values to a tier line.
Show Source
Nested Schema : pricingTiers-lines-linesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
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 : pricingTiers-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
Name of the tier aggregation method. Valid values include On line and On document. A list of accepted values is defined in the lookup type ORA_QP_AGGREGATION_METHODS.
-
AggregationMethodCode: string
Title:
Aggregation Method
Maximum Length:30
Default Value:ORA_ON_DOCUMENT
Abbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Default Value:PER_UNIT
Abbreviation that identifies the method of tier application. -
AppliesTo: string
Name of the tier applicability. Valid values include Highest tier and All tiers. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES.
-
AppliesToCode: string
Title:
Apply To
Maximum Length:30
Default Value:HIGHEST_TIER
Abbreviation that identifies the tier applicability. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EnforceAdjustmentCalculation: string
Title:
Enforce adjustment calculation on each tier
Read Only:true
Maximum Length:30
Default Value:N
Contains one of the following values. Y: enforce adjustment calculation. N: do not enforce calculation. The default value is N. -
headerDFF: array
Flexfields for Pricing Tiers
Title:
Flexfields for Pricing Tiers
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header. -
LastUpdateDate: string
(date-time)
Read Only:
true
Most recent date and time when the application updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
lines: array
Tier Lines
Title:
Tier Lines
The Tier Lines resource manages the tier line details for pricing charges and discounts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityType: string
Type of the parent entity. Valid values include Pricing charge and Pricing term. A list of accepted values is defined in the lookup type ORA_QP_PARENT_ENTITY_TYPES.
-
ParentEntityTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of the parent entity. -
PartialBlockAction: string
Name of the tier partial block action. Valid values include Partial blocks and Satisfied blocks. A list of accepted values is defined in the lookup type ORA_QP_PARTIAL_BLOCK_ACTIONS.
-
PartialBlockActionCode: string
Title:
Partial Block Action
Maximum Length:30
Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier Basis
Value that uniquely identifies the tier basis. -
TierBasisType: string
Type of the tier basis. Valid values include Extended amount and Item quantity. A list of accepted values is defined in the lookup type ORA_QP_TIER_BASIS_TYPES.
-
TierBasisTypeCode: string
Title:
Tier Basis Type
Maximum Length:30
Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Flexfields for Pricing Tiers
Type:
array
Title:
Flexfields for Pricing Tiers
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header.
Show Source
Nested Schema : Tier Lines
Type:
array
Title:
Tier Lines
The Tier Lines resource manages the tier line details for pricing charges and discounts.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingTiers-headerDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
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.
Nested Schema : pricingTiers-lines-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment Amount
Value of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Abbreviation that identifies the method of tier application. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
IncrementValue: integer
Title:
Increment Value
Increment value number. -
LastUpdateDate: string
(date-time)
Read Only:
true
Most recent date and time when the application updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values to a tier line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Maximum: number
Title:
Maximum
Maximum value for the tier line. -
Minimum: number
Title:
Minimum
Minimum value for the tier line. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber: integer
(int32)
Line number of the tier.
Nested Schema : Flexfields for Tier Lines
Type:
array
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values to a tier line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingTiers-lines-linesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- headerDFF
-
Parameters:
- TierHeaderId:
$request.path.TierHeaderId
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header. - TierHeaderId:
- lines
-
Parameters:
- TierHeaderId:
$request.path.TierHeaderId
The Tier Lines resource manages the tier line details for pricing charges and discounts. - TierHeaderId:
Examples
This example describes how to update one tier header.
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/pricingTiers/TierHeaderId"
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.
{ "AppliesTo" : "Highest tier", "AggregationMethod" : "On line" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "TierHeaderId" : 300100132320156, "ParentEntityId" : 300100132320153, "ParentEntityType" : "Price list charge", "ParentEntityTypeCode" : "PRICE_LIST_CHARGE", "TierBasisType" : "Item quantity", "TierBasisTypeCode" : "ORA_ITEM_QUANTITY", "TierBasis" : null, "TierBasisId" : null, "AppliesTo" : "Highest tier", "AppliesToCode" : "HIGHEST_TIER", "ApplicationMethod" : "As block", "ApplicationMethodCode" : "AS_BLOCK", "PartialBlockAction" : "Include partial block", "PartialBlockActionCode" : "PARTIAL_BLOCK", "AggregationMethod" : "On line", "AggregationMethodCode" : "ORA_ON_LINE", "AdjustmentType" : null, "AdjustmentTypeCode" : null, "AdjustmentBasis" : null, "AdjustmentBasisId" : null, "EnforceAdjustmentCalculation" : "N", "CreationDate" : "2018-05-11T10:50:55+00:00", "CreatedBy" : "PRICING_MGR_OPERATIONS", "LastUpdateDate" : "2018-05-21T06:56:37+00:00", "LastUpdatedBy" : "PRICING_MGR_OPERATIONS" }