Get one discount list
get
/fscmRestApi/resources/11.13.18.05/discountLists/{DiscountListId}
Request
Path Parameters
-
DiscountListId(required): integer(int64)
Value that uniquely identifies the discount list.
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 : discountLists-item-response
Type:
Show Source
object
-
accessSets: array
Discount List Access Sets
Title:
Discount List Access Sets
The Discount List Access Sets resource associates access sets to a discount list. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
ChargeSubtype: string
Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
-
ChargeSubtypeCode: string
Maximum Length:
30
Abbreviation that identifies the charge subtype in the discount list. -
ChargeType: string
Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
-
ChargeTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of charge in the discount list. -
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. -
Currency: string
Currency that the price list uses.
-
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency of the discount list. -
DiscountListDescription: string
Maximum Length:
1000
Description of the discount list. -
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 price list becomes inactive.
-
headerDFF: array
Flexfields for Discount List Header
Title:
Flexfields for Discount List Header
The Flexfields for Discount List Header resource associates descriptive flexfield segments and its values to a discount list. -
items: array
Discount List Items
Title:
Discount List Items
The Discount List Items resource manages items of discount lists. -
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. -
LineType: string
Type of the line applied to the price list items in the discount list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.
-
LineTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of line applied to the items in the discount list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
3
Abbreviation that identifies the price periodicity in the discount list. -
PriceType: string
Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
-
PriceTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of price in the discount list. -
StartDate: string
(date-time)
Date when the price list becomes active.
-
Status: string
Status that indicates whether this discount list is approved. Valid values include Approved or In Progress. A list of accepted values is defined in the lookup type ORA_QP_APPROVAL_STATUSES.
-
StatusCode: string
Maximum Length:
30
Default Value:IN_PROGRESS
Abbreviation that identifies the approval status of the discount list.
Nested Schema : Discount List Access Sets
Type:
array
Title:
Discount List Access Sets
The Discount List Access Sets resource associates access sets to a discount list.
Show Source
Nested Schema : Flexfields for Discount List Header
Type:
array
Title:
Flexfields for Discount List Header
The Flexfields for Discount List Header resource associates descriptive flexfield segments and its values to a discount list.
Show Source
Nested Schema : Discount List Items
Type:
array
Title:
Discount List Items
The Discount List Items resource manages items of discount lists.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : discountLists-accessSets-item-response
Type:
Show Source
object
-
AccessSetCode: string
Abbreviation that identifies the access set.
-
AccessSetDescription: string
Description of the access set.
-
AccessSetId: integer
(int64)
Value that uniquely identifies the access set.
-
AccessSetName: string
Name of the access set.
-
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. -
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list to which this access set belongs.
-
DiscountListSetId: integer
(int64)
Value that uniquely identifies the discount list access set record.
-
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.
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 : discountLists-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
-
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list to which the descriptive flexfields belong.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : discountLists-items-item-response
Type:
Show Source
object
-
attributeRules: array
Discount List Attribute Rules
Title:
Discount List Attribute Rules
The Discount List Attribute Rules resource manages attribute rules for discount list items. -
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. -
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list.
-
DiscountListItemId: integer
(int64)
Value that uniquely identifies the discount list item.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemLevel: string
Value of the level at which the discounts will be defined. Valid values include Item, All Items, and Product Category. A list of accepted values is defined in the lookup type ORA_QP_ITEM_LEVELS.
-
ItemLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
itemsDFF: array
Flexfields for Discount List Items
Title:
Flexfields for Discount List Items
The Flexfields for Discount List Items resource associates descriptive flexfield segments and its values to a discount list item. -
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. -
LineType: string
Type of the line applied to the price list items in the discount list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.
-
LineTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of line applied to the items in the discount list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for pricing. -
ServiceDuration: number
Value of the service duration of the item in the discount list.
-
ServiceDurationPeriod: string
Value of the service duration period of the item in the discount list.
-
ServiceDurationPeriodCode: string
Maximum Length:
10
Abbreviation that identifies the service duration period of the item in the discount list. -
simpleRules: array
Discount List Simple Rules
Title:
Discount List Simple Rules
The Discount List Simple Rules resource manages simple rules for discount list items. -
tieredRules: array
Discount List Tiered Rules
Title:
Discount List Tiered Rules
The Discount List Tiered Rules resource manages tiered rules for discount list items.
Nested Schema : Discount List Attribute Rules
Type:
array
Title:
Discount List Attribute Rules
The Discount List Attribute Rules resource manages attribute rules for discount list items.
Show Source
Nested Schema : Flexfields for Discount List Items
Type:
array
Title:
Flexfields for Discount List Items
The Flexfields for Discount List Items resource associates descriptive flexfield segments and its values to a discount list item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discount List Simple Rules
Type:
array
Title:
Discount List Simple Rules
The Discount List Simple Rules resource manages simple rules for discount list items.
Show Source
Nested Schema : Discount List Tiered Rules
Type:
array
Title:
Discount List Tiered Rules
The Discount List Tiered Rules resource manages tiered rules for discount list items.
Show Source
Nested Schema : discountLists-items-attributeRules-item-response
Type:
Show Source
object
-
ApplyToRollup: string
Maximum Length:
30
Value that identifies the rollup. -
ChargeSubtype: string
Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
-
ChargeSubtypeCode: string
Title:
Charge Subtype
Maximum Length:30
Abbreviation that identifies the charge subtype in the discount list. -
ChargeType: string
Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
-
ChargeTypeCode: string
Title:
Charge Type
Maximum Length:30
Abbreviation that identifies the type of charge in the discount list. -
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. -
DiscountListId: integer
Read Only:
true
Value that uniquely identifies the discount list. -
DiscountListItemId: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the discount list item. -
EndDate: string
(date-time)
Title:
End Date
Date when the rule 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. -
MatrixId: integer
(int64)
Value that uniquely identifies the matrix header.
-
Name: string
Title:
Name
Maximum Length:80
Name of the rule for the discount list item. -
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Title:
Price Periodicity
Maximum Length:3
Abbreviation that identifies the price periodicity in the discount list. -
PriceType: string
Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
-
PriceTypeCode: string
Title:
Price Type
Maximum Length:30
Abbreviation that identifies the type of price in the discount list. -
PricingCurrency: string
Read Only:
true
Currency that the discount list uses. -
PricingCurrencyCode: string
Title:
Pricing Currency
Maximum Length:15
Abbreviation that identifies the currency of the discount list. -
pricingMatrixes: array
Pricing Matrixes
Title:
Pricing Matrixes
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts, and other entities. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term.
-
rulesDFF: array
Flexfields for Discount List Rules
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule. -
StartDate: string
(date-time)
Title:
Start Date
Date when the rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pricing Matrixes
Type:
array
Title:
Pricing Matrixes
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts, and other entities.
Show Source
Nested Schema : Flexfields for Discount List Rules
Type:
array
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule.
Show Source
Nested Schema : discountLists-items-attributeRules-pricingMatrixes-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 record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions to a matrix header. -
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. -
MatrixId: integer
(int64)
Title:
Rule Table Id
Value that uniquely identifies the pricing matrix header. -
MatrixName: string
Title:
Name
Maximum Length:64
Name of the pricing matrix header. -
rules: array
Matrix Rules
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Nested Schema : Matrix Dimensions
Type:
array
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions to a matrix header.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
array
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : discountLists-items-attributeRules-pricingMatrixes-dimensions-item-response
Type:
Show Source
object
-
CompareToAttribute: string
Title:
Compare to Attribute
Read Only:true
Maximum Length:80
Represents the pricing entity attribute to which the dimension is mapped against. -
ComparisonOperatorCode: string
Title:
Comparison
Read Only:true
Maximum Length:30
Default Value:E
Represents the comparison operator. Valid values include =, <,>, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.,> -
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. -
DataType: string
Title:
Data Type
Read Only:true
Maximum Length:30
Default Value:STRING
Type of the dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DefaultIsFixedValue: string
Title:
Default Is Fixed Value
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the default value for the dimension is fixed. If N, then the default value for the dimension is not fixed. The default value is N. -
DefaultValueDate: string
(date)
Title:
Default Value
Read Only:true
Default value for a dimension with a date data type. -
DefaultValueNumber: number
Title:
Default Value
Read Only:true
Default value for a dimension with a number data type. -
DefaultValueString: string
Title:
Default Value
Read Only:true
Maximum Length:100
Default value for a dimension with a string data type. -
DefaultValueTimestamp: string
(date-time)
Title:
Default Value
Read Only:true
Default value for a dimension with a time stamp data type. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
DimensionType: string
Title:
ColumnType
Read Only:true
Maximum Length:50
Type of the dimension. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Sequence in which the dimensions get displayed. -
DomainType: string
Title:
Domain Type
Read Only:true
Maximum Length:30
Default Value:NONE
Type of the domain. Valid values include lookup, view object query, custom, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
IsNullable: string
Title:
Allow Null
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null. If N, then the dimension cannot be null. The default value is Y. -
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. -
MatrixDimensionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the dimension for a pricing matrix. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
NullasWildCard: string
Title:
Null Is Wildcard
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension cannot be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
Required
Read Only:true
Maximum Length:240
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension is not required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is Displayed
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N. -
SourceCodeName: string
Title:
Source Code Name
Read Only:true
Maximum Length:100
Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : discountLists-items-attributeRules-pricingMatrixes-rules-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 record was created. -
Dimension1: string
Name of the first dimension in the matrix.
-
Dimension10: string
Name of the tenth dimension in the matrix.
-
Dimension10KeyValue: string
Value that uniquely identifies the tenth dimension value in the matrix.
-
Dimension10Value: string
Value of the tenth dimension in the matrix.
-
Dimension11: string
Name of the eleventh dimension in the matrix.
-
Dimension11KeyValue: string
Value that uniquely identifies the eleventh dimension value in the matrix.
-
Dimension11Value: string
Value of the eleventh dimension in the matrix.
-
Dimension12: string
Name of the twelfth dimension in the matrix.
-
Dimension12KeyValue: string
Value that uniquely identifies the twelfth dimension value in the matrix.
-
Dimension12Value: string
Value of the twelfth dimension in the matrix.
-
Dimension13: string
Name of the thirteenth dimension in the matrix.
-
Dimension13KeyValue: string
Value that uniquely identifies the thirteenth dimension value in the matrix.
-
Dimension13Value: string
Value of the thirteenth dimension in the matrix.
-
Dimension14: string
Name of the fourteenth dimension in the matrix.
-
Dimension14KeyValue: string
Value that uniquely identifies the fourteenth dimension value in the matrix.
-
Dimension14Value: string
Value of the fourteenth dimension in the matrix.
-
Dimension15: string
Name of the fifteenth dimension in the matrix.
-
Dimension15KeyValue: string
Value that uniquely identifies the fifteenth dimension value in the matrix.
-
Dimension15Value: string
Value of the fifteenth dimension in the matrix.
-
Dimension16: string
Name of the sixteenth dimension in the matrix.
-
Dimension16KeyValue: string
Value that uniquely identifies the sixteenth dimension value in the matrix.
-
Dimension16Value: string
Value of the sixteenth dimension in the matrix.
-
Dimension17: string
Name of the seventeenth dimension in the matrix.
-
Dimension17KeyValue: string
Value that uniquely identifies the seventeenth dimension value in the matrix.
-
Dimension17Value: string
Value of the seventeenth dimension in the matrix.
-
Dimension18: string
Name of the eighteenth dimension in the matrix.
-
Dimension18KeyValue: string
Value that uniquely identifies the eighteenth dimension value in the matrix.
-
Dimension18Value: string
Value of the eighteenth dimension in the matrix.
-
Dimension19: string
Name of the nineteenth dimension in the matrix.
-
Dimension19KeyValue: string
Value that uniquely identifies the nineteenth dimension value in the matrix.
-
Dimension19Value: string
Value of the nineteenth dimension in the matrix.
-
Dimension1KeyValue: string
Value that uniquely identifies the first dimension value in the matrix.
-
Dimension1Value: string
Value of the first dimension in the matrix.
-
Dimension2: string
Name of the second dimension in the matrix.
-
Dimension20: string
Name of the twentieth dimension in the matrix.
-
Dimension20KeyValue: string
Value that uniquely identifies the twentieth dimension value in the matrix.
-
Dimension20Value: string
Value of the twentieth dimension in the matrix.
-
Dimension21: string
Name of the twenty-first dimension in the matrix.
-
Dimension21KeyValue: string
Value that uniquely identifies the twenty-first dimension value in the matrix.
-
Dimension21Value: string
Value of the twenty-first dimension in the matrix.
-
Dimension22: string
Name of the twenty-second dimension in the matrix.
-
Dimension22KeyValue: string
Value that uniquely identifies the twenty-second dimension value in the matrix.
-
Dimension22Value: string
Value of the twenty-second dimension in the matrix.
-
Dimension23: string
Name of the twenty-third dimension in the matrix.
-
Dimension23KeyValue: string
Value that uniquely identifies the twenty-third dimension value in the matrix.
-
Dimension23Value: string
Value of the twenty-third dimension in the matrix.
-
Dimension24: string
Name of the twenty-fourth dimension in the matrix.
-
Dimension24KeyValue: string
Value that uniquely identifies the twenty-fourth dimension value in the matrix.
-
Dimension24Value: string
Value of the twenty-fourth dimension in the matrix.
-
Dimension25: string
Name of the twenty-fifth dimension in the matrix.
-
Dimension25KeyValue: string
Value that uniquely identifies the twenty-fifth dimension value in the matrix.
-
Dimension25Value: string
Value of the twenty-fifth dimension in the matrix.
-
Dimension2KeyValue: string
Value that uniquely identifies the second dimension value in the matrix.
-
Dimension2Value: string
Value of the second dimension in the matrix.
-
Dimension3: string
Name of the third dimension in the matrix.
-
Dimension3KeyValue: string
Value that uniquely identifies the third dimension value in the matrix.
-
Dimension3Value: string
Value of the third dimension in the matrix.
-
Dimension4: string
Name of the fourth dimension in the matrix.
-
Dimension4KeyValue: string
Value that uniquely identifies the fourth dimension value in the matrix.
-
Dimension4Value: string
Value of the fourth dimension in the matrix.
-
Dimension5: string
Name of the fifth dimension in the matrix.
-
Dimension5KeyValue: string
Value that uniquely identifies the fifth dimension value in the matrix.
-
Dimension5Value: string
Value of the fifth dimension in the matrix.
-
Dimension6: string
Name of the sixth dimension in the matrix.
-
Dimension6KeyValue: string
Value that uniquely identifies the sixth dimension value in the matrix.
-
Dimension6Value: string
Value of the sixth dimension in the matrix.
-
Dimension7: string
Name of the seventh dimension in the matrix.
-
Dimension7KeyValue: string
Value that uniquely identifies the seventh dimension value in the matrix.
-
Dimension7Value: string
Value of the seventh dimension in the matrix.
-
Dimension8: string
Name of the eighth dimension in the matrix.
-
Dimension8KeyValue: string
Value that uniquely identifies the eighth dimension value in the matrix.
-
Dimension8Value: string
Value of the eighth dimension in the matrix.
-
Dimension9: string
Name of the ninth dimension in the matrix.
-
Dimension9KeyValue: string
Value that uniquely identifies the ninth dimension value in the matrix.
-
Dimension9Value: string
Value of the ninth dimension in the matrix.
-
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. -
MatrixId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End Date
Date when the discount matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the discount matrix rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : discountLists-items-attributeRules-rulesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for pricing terms. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term 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 : discountLists-items-itemsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for discount list items. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DiscountListItemId: integer
(int64)
Value that uniquely identifies the discount list item to which the descriptive flexfields belong.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : discountLists-items-simpleRules-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment Amount
Value of the adjustment amount. -
AdjustmentBasis: string
Name of the basis for adjustment.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the basis for adjustment. -
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
Default Value:DISCOUNT_AMOUNT
Abbreviation that identifies the type of adjustment. -
ApplyToRollup: string
Maximum Length:
30
Value that identifies the rollup. -
ChargeSubtype: string
Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
-
ChargeSubtypeCode: string
Title:
Charge Subtype
Maximum Length:30
Abbreviation that identifies the charge subtype in the discount list. -
ChargeType: string
Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
-
ChargeTypeCode: string
Title:
Charge Type
Maximum Length:30
Abbreviation that identifies the type of charge in the discount list. -
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. -
DiscountListId: integer
Read Only:
true
Value that uniquely identifies the discount list. -
DiscountListItemId: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the discount list item. -
EndDate: string
(date-time)
Title:
End Date
Date when the rule 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. -
Name: string
Title:
Name
Maximum Length:80
Name of the rule for the discount list item. -
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Title:
Price Periodicity
Maximum Length:3
Abbreviation that identifies the price periodicity in the discount list. -
PriceType: string
Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
-
PriceTypeCode: string
Title:
Price Type
Maximum Length:30
Abbreviation that identifies the type of price in the discount list. -
PricingCurrency: string
Read Only:
true
Currency that the discount list uses. -
PricingCurrencyCode: string
Title:
Pricing Currency
Maximum Length:15
Abbreviation that identifies the currency of the discount list. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term.
-
rulesDFF: array
Flexfields for Discount List Rules
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule. -
StartDate: string
(date-time)
Title:
Start Date
Date when the rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Discount List Rules
Type:
array
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule.
Show Source
Nested Schema : discountLists-items-simpleRules-rulesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for pricing terms. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term 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 : discountLists-items-tieredRules-item-response
Type:
Show Source
object
-
ApplyToRollup: string
Maximum Length:
30
Value that identifies the rollup. -
ChargeSubtype: string
Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
-
ChargeSubtypeCode: string
Title:
Charge Subtype
Maximum Length:30
Abbreviation that identifies the charge subtype in the discount list. -
ChargeType: string
Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
-
ChargeTypeCode: string
Title:
Charge Type
Maximum Length:30
Abbreviation that identifies the type of charge in the discount list. -
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. -
DiscountListId: integer
Read Only:
true
Value that uniquely identifies the discount list. -
DiscountListItemId: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the discount list item. -
EndDate: string
(date-time)
Title:
End Date
Date when the rule 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. -
Name: string
Title:
Name
Maximum Length:80
Name of the rule for the discount list item. -
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Title:
Price Periodicity
Maximum Length:3
Abbreviation that identifies the price periodicity in the discount list. -
PriceType: string
Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
-
PriceTypeCode: string
Title:
Price Type
Maximum Length:30
Abbreviation that identifies the type of price in the discount list. -
PricingCurrency: string
Read Only:
true
Currency that the discount list uses. -
PricingCurrencyCode: string
Title:
Pricing Currency
Maximum Length:15
Abbreviation that identifies the currency of the discount list. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term.
-
pricingTiers: array
Tier Headers
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts. -
rulesDFF: array
Flexfields for Discount List Rules
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule. -
StartDate: string
(date-time)
Title:
Start Date
Date when the rule becomes active. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tier Headers
Type:
array
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts.
Show Source
Nested Schema : Flexfields for Discount List Rules
Type:
array
Title:
Flexfields for Discount List Rules
The Flexfields for Discount List Rules resource associates descriptive flexfield segments and its values to a discount list rule.
Show Source
Nested Schema : discountLists-items-tieredRules-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 or N. If Y, then enforce adjustment calculation. If N, then do not enforce calculation. The default value is N. -
headerDFF: array
Flexfields for Discount List Header
Title:
Flexfields for Discount List Header
The Flexfields for Discount List Header resource associates descriptive flexfield segments and its values to a discount list. -
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. -
lines: array
Tier Lines
Title:
Tier Lines
The Tier Lines resource manages 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 Discount List Header
Type:
array
Title:
Flexfields for Discount List Header
The Flexfields for Discount List Header resource associates descriptive flexfield segments and its values to a discount list.
Show Source
Nested Schema : Tier Lines
Type:
array
Title:
Tier Lines
The Tier Lines resource manages 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 : discountLists-items-tieredRules-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 : discountLists-items-tieredRules-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
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. -
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 : discountLists-items-tieredRules-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
Nested Schema : discountLists-items-tieredRules-rulesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for pricing terms. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingTermId: integer
(int64)
Value that uniquely identifies the pricing term to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- accessSets
-
Parameters:
- DiscountListId:
$request.path.DiscountListId
The Discount List Access Sets resource associates access sets to a discount list. - DiscountListId:
- headerDFF
-
Parameters:
- DiscountListId:
$request.path.DiscountListId
The Flexfields for Discount List Header resource associates descriptive flexfield segments and its values to a discount list. - DiscountListId:
- items
-
Parameters:
- DiscountListId:
$request.path.DiscountListId
The Discount List Items resource manages items of discount lists. - DiscountListId:
Examples
This example describes how to get one discount list.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/discountLists/DiscountListId"
For example, the following command gets one discount list:
curl -u username:password "https://servername/fscmRestApi/resources/version/discountLists/300100170438948"
Example Response Body
The following shows an example of the response body in JSON format.
{ "DiscountListName": "Corporate Discount List", "DiscountListId": 300100170438948, "DiscountListDescription": "Corporate Discount List", "PriceType": null, "PriceTypeCode": null, "PricePeriodicity": null, "PricePeriodicityCode": null, "ChargeType": null, "ChargeTypeCode": null, "ChargeSubtype": null, "ChargeSubtypeCode": null, "LineType": null, "LineTypeCode": null, "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "Currency": "US Dollar", "CurrencyCode": "USD", "Status": "In progress", "StatusCode": "IN_PROGRESS", "StartDate": "2009-05-08T03:30:00+00:00", "EndDate": null, "CreationDate": "2018-11-20T08:02:50+00:00", "CreatedBy": "PRICING_MGR_OPERATIONS", "LastUpdateDate": "2018-11-20T08:02:50.885+00:00", "LastUpdatedBy": "PRICING_MGR_OPERATIONS" }