Get one pricing strategy
get
/fscmRestApi/resources/11.13.18.05/pricingStrategies/{PricingStrategyId}
Request
Path Parameters
-
PricingStrategyId(required): integer(int64)
Value that uniquely identifies the pricing strategy.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : pricingStrategies-item-response
Type:
Show Source
object
-
AllowCurrencyOverride: string
Title:
Allow currency override
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then allow overriding the currency. If N, then don't allow overriding the currency. The default value is N. -
allowedOverrideCurrencies: array
Allowed Override Currencies
Title:
Allowed Override Currencies
The Allowed Override Currencies resource associates the currencies that are allowed to override the default currency of the pricing strategy. -
AllowPriceListOverride: string
Title:
Allow price list override
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then allow overriding the price list. If N, then don't allow overriding the price list. The default value is N. -
associatedDiscountLists: array
Associated Discount Lists
Title:
Associated Discount Lists
The Associated Discount Lists resource associates discount lists with pricing strategies. -
associatedSegmentPriceLists: array
Associated Segment Price Lists
Title:
Associated Segment Price Lists
The Associated Segment Price Lists resource associates segment price lists with pricing strategies. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Title:
Business Unit
Value that uniquely identifies the business unit. -
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 user created the record. -
DefaultCurrency: string
Default currency of the pricing strategy.
-
DefaultCurrencyCode: string
Title:
Default Currency
Maximum Length:30
Abbreviation that identifies the default currency of the pricing strategy. -
DFF: array
Flexfields for Pricing Strategy Headers
Title:
Flexfields for Pricing Strategy Headers
The Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy. -
GLConversionType: string
Type of general ledger conversion for the pricing strategy.
-
GLConversionTypeCode: string
Title:
Default GL Conversion Type
Maximum Length:30
Abbreviation that identifies the general ledger conversion type for the pricing strategy. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Objective: string
Objective for the pricing strategy.
-
ObjectiveCode: string
Title:
Objective
Maximum Length:30
Abbreviation that identifies the objective for the pricing strategy. -
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy.
-
Status: string
Status that indicates whether this pricing strategy is approved or not. Valid values include Approved or In Progress.
-
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:IN_PROGRESS
Abbreviation that identifies the approval status of the price list. -
StrategyDescription: string
Title:
Description
Maximum Length:1000
Description of the pricing strategy. -
StrategyEndDate: string
(date-time)
Title:
End Date
Date when the pricing strategy becomes inactive. -
StrategyName: string
Title:
Name
Maximum Length:80
Name of the pricing strategy. -
StrategyStartDate: string
(date-time)
Title:
Start Date
Date when the pricing strategy becomes active.
Nested Schema : Allowed Override Currencies
Type:
array
Title:
Allowed Override Currencies
The Allowed Override Currencies resource associates the currencies that are allowed to override the default currency of the pricing strategy.
Show Source
Nested Schema : Associated Discount Lists
Type:
array
Title:
Associated Discount Lists
The Associated Discount Lists resource associates discount lists with pricing strategies.
Show Source
Nested Schema : Associated Segment Price Lists
Type:
array
Title:
Associated Segment Price Lists
The Associated Segment Price Lists resource associates segment price lists with pricing strategies.
Show Source
Nested Schema : Flexfields for Pricing Strategy Headers
Type:
array
Title:
Flexfields for Pricing Strategy Headers
The Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-allowedOverrideCurrencies-item-response
Type:
Show Source
object
-
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 user created the record. -
Currency: string
Maximum Length:
255
Currency allowed to override the default currency in the pricing strategy. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
Abbreviation that identifies the currency allowed to override the default currency in the pricing strategy. -
EndDate: string
(date-time)
Title:
End Date
Date when the currency allowed to override the default currency becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCurrencyId: integer
(int64)
Value that uniquely identifies the allowed override currency.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy.
-
StartDate: string
(date-time)
Title:
Start Date
Date when the currency allowed to override the default currency becomes active.
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 : pricingStrategies-associatedDiscountLists-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date-time)
Title:
End Date
Date when the association of the discount list to the pricing strategy becomes inactive. -
AssociationPrecedence: integer
Precedence of the association of the discount list to the pricing strategy.
-
AssociationStartDate: string
(date-time)
Title:
Start Date
Date when the association of the discount list to the pricing strategy becomes active. -
BusinessUnit: string
Read Only:
true
Name of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit. -
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 user created the record. -
Currency: string
Read Only:
true
Currency that the price list uses. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency of the discount list. -
Description: string
Read Only:
true
Maximum Length:1000
Description of the discount list. -
DFF: array
Flexfields for Associated Discount Lists
Title:
Flexfields for Associated Discount Lists
The Flexfields for Associated Discount Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail. -
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list.
-
DiscountListName: string
Name of the discount list.
-
discountLists: array
Discount Lists
Title:
Discount Lists
The Discount Lists resource manages discounts of products and services. -
EndDate: string
(date-time)
Read Only:
true
Date when the discount list becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail.
-
PricingStrategyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pricing strategy. -
StartDate: string
(date-time)
Read Only:
true
Date when the discount list becomes active. -
Status: string
Read Only:
true
Status that indicates whether this discount list is approved. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Abbreviation that identifies the approval status of the discount list.
Nested Schema : Flexfields for Associated Discount Lists
Type:
array
Title:
Flexfields for Associated Discount Lists
The Flexfields for Associated Discount Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Discount Lists
Type:
array
Title:
Discount Lists
The Discount Lists resource manages discounts of products and services.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail 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 : pricingStrategies-associatedDiscountLists-discountLists-item-response
Type:
Show Source
object
-
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list.
-
DiscountListName: string
Maximum Length:
80
Name of the discount list. -
EndDate: string
(date-time)
Date when the discount list becomes inactive.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDate: string
(date-time)
Date when the discount list becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date-time)
Title:
End Date
Date when the association of the price list to the pricing strategy becomes inactive. -
AssociationPrecedence: integer
Precedence of the association of the price list to the pricing strategy.
-
AssociationStartDate: string
(date-time)
Title:
Start Date
Date when the association of the price list to the pricing strategy becomes active. -
BusinessUnit: string
Read Only:
true
Name of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit. -
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 user created the record. -
Currency: string
Read Only:
true
Currency that the price list uses. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency of the price list. -
Description: string
Read Only:
true
Maximum Length:1000
Description of the price list. -
DFF: array
Flexfields for Associated Segment Price Lists
Title:
Flexfields for Associated Segment Price Lists
The Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail. -
EndDate: string
(date-time)
Title:
End Date
Read Only:true
Date when the price list becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Name of the price list.
-
priceLists: array
Price Lists
Title:
Price Lists
The Price Lists resource manages price lists of products and services. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail.
-
PricingStrategyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pricing strategy. -
StartDate: string
(date-time)
Title:
Start Date
Read Only:true
Date when the price list becomes active. -
Status: string
Read Only:
true
Status that indicates whether this price list is approved. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Abbreviation that identifies the approval status of the price list.
Nested Schema : Flexfields for Associated Segment Price Lists
Type:
array
Title:
Flexfields for Associated Segment Price Lists
The Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Price Lists
Type:
array
Title:
Price Lists
The Price Lists resource manages price lists of products and services.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail 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 : pricingStrategies-associatedSegmentPriceLists-priceLists-item-response
Type:
Show Source
object
-
EndDate: string
(date-time)
Title:
End Date
Date when the price list becomes inactive. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Title:
Name
Maximum Length:80
Name of the price list. -
StartDate: string
(date-time)
Title:
Start Date
Date when the price list becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- PricingStrategyId:
$request.path.PricingStrategyId
The Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy. - PricingStrategyId:
- allowedOverrideCurrencies
-
Parameters:
- PricingStrategyId:
$request.path.PricingStrategyId
The Allowed Override Currencies resource associates the currencies that are allowed to override the default currency of the pricing strategy. - PricingStrategyId:
- associatedDiscountLists
-
Parameters:
- PricingStrategyId:
$request.path.PricingStrategyId
The Associated Discount Lists resource associates discount lists with pricing strategies. - PricingStrategyId:
- associatedSegmentPriceLists
-
Parameters:
- PricingStrategyId:
$request.path.PricingStrategyId
The Associated Segment Price Lists resource associates segment price lists with pricing strategies. - PricingStrategyId: