Create price lists
post
/fscmRestApi/resources/11.13.18.05/priceLists
Request
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
accessSets: array
Price List Access Sets
Title:
Price List Access SetsThe Price List Access Sets resource associates access sets with a price list. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId(required): integer
(int64)
Value that uniquely identifies the business unit.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Title:
Calculation MethodMaximum Length:30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the price lists for the approval flow. -
Currency: string
Currency that the price list uses.
-
CurrencyCode(required): string
Maximum Length:
3Abbreviation that identifies the currency of the price list. -
EndDate: string
(date-time)
Title:
End DateDate when the price list becomes inactive. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the price list's approval status when the approval flow is enabled. This will be null if the Opt-In feature is set to No. -
headerDFF: array
headerDFF
-
items: array
Price List Items
Title:
Price List ItemsThe Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items. -
LineType: string
Type of the line applied to the price list items in the price 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:
30Default Value:ORA_BUYAbbreviation that identifies the type of line applied to the price list items in the price list. -
PriceListDescription: string
Title:
DescriptionMaximum Length:1000Description of the price list. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName(required): string
Title:
NameMaximum Length:80Name of the price list. -
PriceListType: string
Type of the price list. Valid values include Segment, Floor, Ceiling, or GSA. A list of accepted values is defined in the lookup type ORA_QP_PRICE_LIST_TYPES.
-
PriceListTypeCode: string
Maximum Length:
30Default Value:SEGMENTAbbreviation that identifies the type of price list. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate(required): string
(date-time)
Title:
Start DateDate when the price list becomes active. -
Status: string
Status that indicates whether this price 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:
30Default Value:IN_PROGRESSAbbreviation that identifies the approval status of the price list.
Nested Schema : Price List Access Sets
Type:
arrayTitle:
Price List Access SetsThe Price List Access Sets resource associates access sets with a price list.
Show Source
Nested Schema : Price List Items
Type:
arrayTitle:
Price List ItemsThe Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items.
Show Source
Nested Schema : priceLists-accessSets-item-post-request
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.
-
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the access set in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the access set's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which this access set belongs.
-
PriceListSetId: integer
(int64)
Value that uniquely identifies the price list access set record.
Nested Schema : priceLists-headerDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListId: integer
(int64)
Nested Schema : priceLists-items-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the items for the approval flow. -
charges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
componentItems: array
Price List Component Items
Title:
Price List Component ItemsThe Price List Component Items resource manages the component items in a price list. -
coveredItems: array
Price List Covered Items
Title:
Price List Covered ItemsThe Price List Covered Items resource manages the covered items in a price list. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the item's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory.
-
Item: string
Name of the item in the inventory.
-
ItemLevel: string
Value of the level at which the charges 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:
30Default Value:ITEMAbbreviation that identifies the level at which charges will be defined. -
itemsDFF: array
itemsDFF
-
LineType: string
Type of the line applied to the price list items in the price 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(required): string
Maximum Length:
30Abbreviation that identifies the type of line applied to the items in the price list. -
PriceListId(required): integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode(required): string
Maximum Length:
30Abbreviation that identifies the unit of measure for pricing. -
PrimaryPricingUOM: string
Maximum Length:
30Default Value:NValue that identifies the primary pricing unit of measure of the item in the price list. -
ratePlans: array
Rate Plans
Title:
Rate PlansThe Rate Plans resource manages the rate plans. This resource isn't currently used. -
ServiceDuration: number
Title:
Service DurationValue of the service duration of the item in the price list. -
ServiceDurationPeriod: string
Value of the service duration period of the item in the price list.
-
ServiceDurationPeriodCode: string
Title:
Service Duration PeriodMaximum Length:30Abbreviation that identifies the service duration period of the item in the price list.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Price List Component Items
Type:
arrayTitle:
Price List Component ItemsThe Price List Component Items resource manages the component items in a price list.
Show Source
Nested Schema : Price List Covered Items
Type:
arrayTitle:
Price List Covered ItemsThe Price List Covered Items resource manages the covered items in a price list.
Show Source
Nested Schema : Rate Plans
Type:
arrayTitle:
Rate PlansThe Rate Plans resource manages the rate plans. This resource isn't currently used.
Show Source
Nested Schema : priceLists-items-charges-item-post-request
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode(required): string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber(required): integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
MatrixId: integer
(int64)
Value that uniquely identifies the attribute pricing matrix associated to the item charge.
-
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
pricingMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
pricingTiers: array
Tier Headers
Title:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation. -
StartDate(required): string
(date-time)
Date when the charge becomes active.
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type:
arrayTitle:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListChargeId: integer
(int64)
Nested Schema : priceLists-items-charges-pricingMatrixes-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
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.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : priceLists-items-charges-pricingTiers-item-post-request
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation 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 MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation 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 MethodMaximum Length:30Default Value:PER_UNITAbbreviation 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 ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier header for the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier header in the approval flow. -
headerDFF: array
headerDFF
-
lines: array
Tier Lines
Title:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments. -
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:
30Abbreviation 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 ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue 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(required): string
Title:
Tier Basis TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-headerDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
TieredPricingHeaderId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object-
AdjustmentAmount(required): number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Abbreviation that identifies the method of adjustment.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier line for the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier line in the approval flow. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
linesDFF: array
linesDFF
-
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum(required): number
Title:
MinimumMinimum value for the tier line. -
TierHeaderId(required): integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber(required): integer
(int32)
Line number of the tier.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
TieredPricingLineId: integer
(int64)
Nested Schema : priceLists-items-componentItems-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the component items for the approval flow. -
componentCharges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
ComponentIdPath(required): string
(byte)
Hierarchy of the component item unique values from the configuration model.
-
ComponentItem: string
Name of the component item.
-
ComponentItemDescription: string
Description of the component item.
-
ComponentItemId(required): integer
(int64)
Value that uniquely identifies the component item.
-
ComponentPath: string
Hierarchy of the component item from the configuration model.
-
ComponentPathId: string
Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.
-
COMPPath(required): string
(byte)
Hierarchy of the values of the component item from the configuration model.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
LineType: string
Type of line applied to the price list component items in the price 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:
30Default Value:ORA_BUYAbbreviation that identifies the type of line applied to the price list component items in the price list. -
PriceListComponentItemId: integer
(int64)
Value that uniquely identifies the price list component item.
-
PriceListId(required): integer
(int64)
Value that uniquely identifies the price list to which the component items belong.
-
PriceListItemId(required): integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode(required): string
Maximum Length:
3Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-item-post-request
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode(required): string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber(required): integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate(required): string
(date-time)
Date when the charge becomes active.
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListChargeId: integer
(int64)
Nested Schema : priceLists-items-coveredItems-item-post-request
Type:
Show Source
object-
ActionType: string
Type of action for the coverage item record. Valid values include Add, and so on. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES.
-
ActionTypeCode: string
Title:
Action TypeMaximum Length:30Default Value:ORA_ADDAbbreviation that identifies the type of action for the coverage item record. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the covered items for the approval flow. -
CoverageUOM: string
Unit of measure for coverage.
-
CoverageUOMCode(required): string
Title:
Coverage UOMMaximum Length:30Abbreviation that identifies the unit of measure for coverage. -
coveredCharges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the pricing covered items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
PriceListCoveredItemId: integer
(int64)
Value that uniquely identifies the price list covered item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId(required): integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode(required): string
Title:
Pricing UOMMaximum Length:30Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-post-request
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationAmount: number
Title:
Calculation AmountValue of the calculation amount. -
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode(required): string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber(required): integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CoverageBasis: string
Pricing basis for the covered item.
-
CoverageBasisId: integer
(int64)
Title:
Return BasisValue that uniquely identifies the pricing basis for the covered item. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate(required): string
(date-time)
Date when the charge becomes active.
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListChargeId: integer
(int64)
Nested Schema : priceLists-items-itemsDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListItemId: integer
(int64)
Nested Schema : priceLists-items-ratePlans-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the rate plans for the approval flow. -
Currency: string
Name of the currency for the rate plan.
-
CurrencyCode: string
Maximum Length:
15Abbreviation that uniquely identifies the currency for the rate plan. -
EndDate: string
(date-time)
Date when the rate plan becomes inactive.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the rate plans when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
ratePlanCharges: array
Rate Plan Charges
Title:
Rate Plan ChargesA rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges. -
RatePlanDescription: string
Title:
DescriptionMaximum Length:1000Description of the rate plan. -
RatePlanId: integer
(int64)
Value that uniquely identifies the rate plan.
-
RatePlanName(required): string
Title:
NameMaximum Length:80Name of the rate plan. -
StartDate: string
(date-time)
Date when the rate plan becomes active.
Nested Schema : Rate Plan Charges
Type:
arrayTitle:
Rate Plan ChargesA rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-item-post-request
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
AllowPeriodicBilling: string
Maximum Length:
1Periodic billing for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. The default value is N. -
AllowPeriodicRevenueRecognition: string
Maximum Length:
1Periodic revenue recognition for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
basePriceMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
BasePriceMatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, and Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode(required): string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, and Markup percent. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the rate plan charge for the approval flow. -
ChargeLineNumber(required): integer
(int32)
Title:
Line NumberNumber that identifies the line of the rate plan charge. -
ChargePeriod: string
Name of the charge period.
-
ChargePeriodCode: string
Maximum Length:
3Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscriptions Management add the usages for a usage charge. Use a time unit of measure when you set the value. Pricing uses the UOM class that you set in the RCS_DEFAULT_UOM_CLASS_CODE_FOR_SVC_DURATION profile option to validate the charge period that you set. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
EndDate: string
(date-time)
Date when the rate plan charge becomes inactive.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the rate plan charge in the approval flow. -
MatrixId: integer
(int64)
Value that uniquely identifies the matrix.
-
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the parent entity for the charge of the rate plan.
-
ParentEntityTypeCode(required): string
Maximum Length:
30Abbreviation that identifies the parent entity for the charge of the rate plan. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
pricingMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
pricingTiers: array
Tier Headers
Title:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation. -
QuantityAttribute: string
Maximum Length:
300Value of the attribute used for capturing the extensible capabilities of the quantity for a usage charge. -
QuantityUOMAttribute: string
Maximum Length:
300Value of the attribute used for capturing the extensible capabilities of the quantity unit of measure for a usage charge. -
RatePlanChargeId: integer
(int64)
Value that uniquely identifies the rate plan charge.
-
StartDate(required): string
(date-time)
Date when the rate plan charge becomes active.
-
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
UsageUOM: string
Name of the unit of measure for the usage charge.
-
UsageUOMCode: string
Maximum Length:
12Abbreviation that uniquely identifies the unit of measure for the usage charge.
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type:
arrayTitle:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-rules-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
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.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-chargesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
PriceListChargeId: integer
(int64)
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-rules-item-post-request
Type:
Show Source
object-
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
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.
-
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-item-post-request
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation 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 MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation 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 MethodMaximum Length:30Default Value:PER_UNITAbbreviation 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 ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier header for the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier header in the approval flow. -
headerDFF: array
headerDFF
-
lines: array
Tier Lines
Title:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments. -
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:
30Abbreviation 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 ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue 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(required): string
Title:
Tier Basis TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
TieredPricingHeaderId: integer
(int64)
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-post-request
Type:
Show Source
object-
AdjustmentAmount(required): number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Abbreviation that identifies the method of adjustment.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier line for the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier line in the approval flow. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
linesDFF: array
linesDFF
-
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum(required): number
Title:
MinimumMinimum value for the tier line. -
TierHeaderId(required): integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber(required): integer
(int32)
Line number of the tier.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
TieredPricingLineId: integer
(int64)
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : priceLists-item-response
Type:
Show Source
object-
accessSets: array
Price List Access Sets
Title:
Price List Access SetsThe Price List Access Sets resource associates access sets with a price list. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Title:
Calculation MethodMaximum Length:30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the price lists in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the price lists for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
Currency: string
Currency that the price list uses.
-
CurrencyCode: string
Maximum Length:
3Abbreviation that identifies the currency of the price list. -
EndDate: string
(date-time)
Title:
End DateDate when the price list becomes inactive. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the price list when the approval flow is enabled. This will be null if the Opt-In for the feature is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the price list's approval status when the approval flow is enabled. This will be null if the Opt-In feature is set to No. -
headerDFF: array
headerDFF
-
items: array
Price List Items
Title:
Price List ItemsThe Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LineType: string
Type of the line applied to the price list items in the price 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:
30Default Value:ORA_BUYAbbreviation that identifies the type of line applied to the price list items in the price list. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListDescription: string
Title:
DescriptionMaximum Length:1000Description of the price list. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Title:
NameMaximum Length:80Name of the price list. -
PriceListType: string
Type of the price list. Valid values include Segment, Floor, Ceiling, or GSA. A list of accepted values is defined in the lookup type ORA_QP_PRICE_LIST_TYPES.
-
PriceListTypeCode: string
Maximum Length:
30Default Value:SEGMENTAbbreviation that identifies the type of price list. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate: string
(date-time)
Title:
Start DateDate when the price list becomes active. -
Status: string
Status that indicates whether this price 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:
30Default Value:IN_PROGRESSAbbreviation that identifies the approval status of the price list.
Nested Schema : Price List Access Sets
Type:
arrayTitle:
Price List Access SetsThe Price List Access Sets resource associates access sets with a price list.
Show Source
Nested Schema : Price List Items
Type:
arrayTitle:
Price List ItemsThe Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-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.
-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the access set in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the access set in the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Access set's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the access set's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which this access set belongs.
-
PriceListSetId: integer
(int64)
Value that uniquely identifies the price list access set record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : priceLists-headerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the items in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the items for the approval flow. -
charges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
componentItems: array
Price List Component Items
Title:
Price List Component ItemsThe Price List Component Items resource manages the component items in a price list. -
coveredItems: array
Price List Covered Items
Title:
Price List Covered ItemsThe Price List Covered Items resource manages the covered items in a price list. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Item's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the item's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Read Only:
trueDescription of the item in the inventory. -
ItemLevel: string
Value of the level at which the charges 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:
30Default Value:ITEMAbbreviation that identifies the level at which charges will be defined. -
itemsDFF: array
itemsDFF
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LineType: string
Type of the line applied to the price list items in the price 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:
30Abbreviation that identifies the type of line applied to the items in the price list. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Maximum Length:
30Abbreviation that identifies the unit of measure for pricing. -
PrimaryPricingUOM: string
Maximum Length:
30Default Value:NValue that identifies the primary pricing unit of measure of the item in the price list. -
ratePlans: array
Rate Plans
Title:
Rate PlansThe Rate Plans resource manages the rate plans. This resource isn't currently used. -
ServiceDuration: number
Title:
Service DurationValue of the service duration of the item in the price list. -
ServiceDurationPeriod: string
Value of the service duration period of the item in the price list.
-
ServiceDurationPeriodCode: string
Title:
Service Duration PeriodMaximum Length:30Abbreviation that identifies the service duration period of the item in the price list.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Price List Component Items
Type:
arrayTitle:
Price List Component ItemsThe Price List Component Items resource manages the component items in a price list.
Show Source
Nested Schema : Price List Covered Items
Type:
arrayTitle:
Price List Covered ItemsThe Price List Covered Items resource manages the covered items in a price list.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Rate Plans
Type:
arrayTitle:
Rate PlansThe Rate Plans resource manages the rate plans. This resource isn't currently used.
Show Source
Nested Schema : priceLists-items-charges-item-response
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the charges in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber: integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Charge's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Value that uniquely identifies the attribute pricing matrix associated to the item charge.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
pricingMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
pricingTiers: array
Tier Headers
Title:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation. -
StartDate: string
(date-time)
Date when the charge becomes active.
-
TierHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the tiered pricing header associated to the item charge.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type:
arrayTitle:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : priceLists-items-charges-chargesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the pricing matrixes in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the pricing matrixes when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Value that uniquely identifies the matrix. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the dimensions in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
CompareToAttribute: string
Title:
Compare to AttributeRead Only:trueMaximum Length:80Compare to attribute for a dimension. -
ComparisonOperatorCode: string
Title:
ComparisonRead Only:trueMaximum Length:30Default Value:EComparison operator for a dimension. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
DataType: string
Title:
Data TypeRead Only:trueMaximum Length:30Default Value:STRINGData type for a dimension. -
DefaultIsFixedValue: string
Title:
Default Is Fixed ValueRead Only:trueMaximum Length:1Default Value:NDefault to a fixed value for a dimension. -
DefaultValueDate: string
(date)
Title:
Default ValueRead Only:trueDefault date for a dimension. -
DefaultValueNumber: number
Title:
Default ValueRead Only:trueDefault number for a dimension. -
DefaultValueString: string
Title:
Default ValueRead Only:trueMaximum Length:100Default string for a dimension. -
DefaultValueTimestamp: string
(date-time)
Title:
Default ValueRead Only:trueDefault time stamp for a dimension. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
DimensionType: string
Title:
ColumnTypeRead Only:trueMaximum Length:50Type for the dimension. -
DisplaySequence: integer
(int32)
Title:
Display SequenceRead Only:trueDisplay sequence for a dimension. -
DomainType: string
Title:
Domain TypeRead Only:trueMaximum Length:30Default Value:NONEDomain type for a dimension. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the dimensions when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
IsNullable: string
Title:
Allow NullRead Only:trueMaximum Length:1Default Value:NIndicates whether the dimension can be a null value. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixDimensionId: integer
(int64)
Read Only:
trueValue 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 WildcardRead Only:trueMaximum Length:1Default Value:NContains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension can't be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
RequiredRead Only:trueMaximum Length:240Default Value:NContains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension isn't required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is DisplayedRead Only:trueMaximum Length:1Default Value:NIndicates 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 NameRead Only:trueMaximum Length:100Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the matrix rules in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate 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.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the matrix rules when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation 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 MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation 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 MethodMaximum Length:30Default Value:PER_UNITAbbreviation 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 ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the tier header in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier header for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EnforceAdjustmentCalculation: string
Title:
Enforce adjustment calculation on each tierRead Only:trueMaximum Length:30Default Value:NContains one of the following values: Y or N. If Y, then enforce adjustment calculation. If N, then don't enforce calculation. The default value is N. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Status value of the tier header in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier header in the approval flow. -
headerDFF: array
headerDFF
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
lines: array
Tier Lines
Title:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments. -
links: array
Links
Title:
LinksThe 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:
30Abbreviation 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 ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-headerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingHeaderId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-item-response
Type:
Show Source
object-
AdjustmentAmount: number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Abbreviation that identifies the method of adjustment.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the tier line in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier line for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Status value of the tier line in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier line in the approval flow. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
linesDFF: array
linesDFF
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum: number
Title:
MinimumMinimum 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-linesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingLineId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-componentItems-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the component items in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the component items for the approval flow. -
componentCharges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
ComponentIdPath: string
(byte)
Hierarchy of the component item unique values from the configuration model.
-
ComponentItem: string
Name of the component item.
-
ComponentItemDescription: string
Description of the component item.
-
ComponentItemId: integer
(int64)
Value that uniquely identifies the component item.
-
ComponentPath: string
Hierarchy of the component item from the configuration model.
-
ComponentPathId: string
Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.
-
COMPPath: string
(byte)
Hierarchy of the values of the component item from the configuration model.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LineType: string
Type of line applied to the price list component items in the price 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:
30Default Value:ORA_BUYAbbreviation that identifies the type of line applied to the price list component items in the price list. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListComponentItemId: integer
(int64)
Value that uniquely identifies the price list component item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the component items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-item-response
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the charges in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber: integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Charge's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate: string
(date-time)
Date when the charge becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-coveredItems-item-response
Type:
Show Source
object-
ActionType: string
Type of action for the coverage item record. Valid values include Add, and so on. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES.
-
ActionTypeCode: string
Title:
Action TypeMaximum Length:30Default Value:ORA_ADDAbbreviation that identifies the type of action for the coverage item record. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the covered items in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the covered items for the approval flow. -
CoverageUOM: string
Unit of measure for coverage.
-
CoverageUOMCode: string
Title:
Coverage UOMMaximum Length:30Abbreviation that identifies the unit of measure for coverage. -
coveredCharges: array
Price List Charges
Title:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the covered items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the pricing covered items when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListCoveredItemId: integer
(int64)
Value that uniquely identifies the price list covered item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Title:
Pricing UOMMaximum Length:30Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Charges
Type:
arrayTitle:
Price List ChargesThe Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-response
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
CalculationAmount: number
Title:
Calculation AmountValue of the calculation amount. -
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the charges in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the charges for the approval flow. -
ChargeLineNumber: integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
chargesDFF
-
CoverageBasis: string
Pricing basis for the covered item.
-
CoverageBasisId: integer
(int64)
Title:
Return BasisValue that uniquely identifies the pricing basis for the covered item. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Charge's approval status when the approval flow is enabled. It's null if the feature opt in is No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the item for the charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate: string
(date-time)
Date when the charge becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-itemsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListItemId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the rate plans in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the rate plans for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
Currency: string
Name of the currency for the rate plan.
-
CurrencyCode: string
Maximum Length:
15Abbreviation that uniquely identifies the currency for the rate plan. -
EndDate: string
(date-time)
Date when the rate plan becomes inactive.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the rate plans when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the approval status of the rate plans when the approval flow is enabled. This status will be null if the feature opt in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ratePlanCharges: array
Rate Plan Charges
Title:
Rate Plan ChargesA rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges. -
RatePlanDescription: string
Title:
DescriptionMaximum Length:1000Description of the rate plan. -
RatePlanId: integer
(int64)
Value that uniquely identifies the rate plan.
-
RatePlanName: string
Title:
NameMaximum Length:80Name of the rate plan. -
RatePlanNumber: string
Read Only:
trueMaximum Length:120Number that uniquely identifies the rate plan. -
StartDate: string
(date-time)
Date when the rate plan becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Rate Plan Charges
Type:
arrayTitle:
Rate Plan ChargesA rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-item-response
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N. -
AllowPeriodicBilling: string
Maximum Length:
1Periodic billing for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. The default value is N. -
AllowPeriodicRevenueRecognition: string
Maximum Length:
1Periodic revenue recognition for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. The default value is N. -
BasePrice: number
Value of the base price of the item.
-
basePriceMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
BasePriceMatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix.
-
CalculationMethod: string
Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, and Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, and Markup percent. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
-
CalculationTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChangeType: string
Read Only:
trueMaximum Length:255Type of change for the rate plan charge in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the rate plan charge for the approval flow. -
ChargeLineNumber: integer
(int32)
Title:
Line NumberNumber that identifies the line of the rate plan charge. -
ChargePeriod: string
Name of the charge period.
-
ChargePeriodCode: string
Maximum Length:
3Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscriptions Management add the usages for a usage charge. Use a time unit of measure when you set the value. Pricing uses the UOM class that you set in the RCS_DEFAULT_UOM_CLASS_CODE_FOR_SVC_DURATION profile option to validate the charge period that you set. -
chargesDFF: array
chargesDFF
-
CostCalculationAmount: number
Title:
Cost Calculation AmountValue of the cost calculation amount. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Date when the rate plan charge becomes inactive.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Value of the status of the rate plan charge in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the rate plan charge in the approval flow. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Value that uniquely identifies the matrix.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity for the charge of the rate plan.
-
ParentEntityTypeCode: string
Maximum Length:
30Abbreviation that identifies the parent entity for the charge of the rate plan. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
pricingMatrixes: array
Pricing Matrixes
Title:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features. -
pricingTiers: array
Tier Headers
Title:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation. -
QuantityAttribute: string
Maximum Length:
300Value of the attribute used for capturing the extensible capabilities of the quantity for a usage charge. -
QuantityUOMAttribute: string
Maximum Length:
300Value of the attribute used for capturing the extensible capabilities of the quantity unit of measure for a usage charge. -
RatePlanChargeId: integer
(int64)
Value that uniquely identifies the rate plan charge.
-
StartDate: string
(date-time)
Date when the rate plan charge becomes active.
-
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
UsageUOM: string
Name of the unit of measure for the usage charge.
-
UsageUOMCode: string
Maximum Length:
12Abbreviation that uniquely identifies the unit of measure for the usage charge.
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Pricing Matrixes
Type:
arrayTitle:
Pricing MatrixesA pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type:
arrayTitle:
Tier HeadersA tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the pricing matrixes in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the pricing matrixes when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Value that uniquely identifies the matrix. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the dimensions in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
CompareToAttribute: string
Title:
Compare to AttributeRead Only:trueMaximum Length:80Compare to attribute for a dimension. -
ComparisonOperatorCode: string
Title:
ComparisonRead Only:trueMaximum Length:30Default Value:EComparison operator for a dimension. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
DataType: string
Title:
Data TypeRead Only:trueMaximum Length:30Default Value:STRINGData type for a dimension. -
DefaultIsFixedValue: string
Title:
Default Is Fixed ValueRead Only:trueMaximum Length:1Default Value:NDefault to a fixed value for a dimension. -
DefaultValueDate: string
(date)
Title:
Default ValueRead Only:trueDefault date for a dimension. -
DefaultValueNumber: number
Title:
Default ValueRead Only:trueDefault number for a dimension. -
DefaultValueString: string
Title:
Default ValueRead Only:trueMaximum Length:100Default string for a dimension. -
DefaultValueTimestamp: string
(date-time)
Title:
Default ValueRead Only:trueDefault time stamp for a dimension. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
DimensionType: string
Title:
ColumnTypeRead Only:trueMaximum Length:50Type for the dimension. -
DisplaySequence: integer
(int32)
Title:
Display SequenceRead Only:trueDisplay sequence for a dimension. -
DomainType: string
Title:
Domain TypeRead Only:trueMaximum Length:30Default Value:NONEDomain type for a dimension. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the dimensions when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
IsNullable: string
Title:
Allow NullRead Only:trueMaximum Length:1Default Value:NIndicates whether the dimension can be a null value. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixDimensionId: integer
(int64)
Read Only:
trueValue 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 WildcardRead Only:trueMaximum Length:1Default Value:NContains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension can't be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
RequiredRead Only:trueMaximum Length:240Default Value:NContains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension isn't required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is DisplayedRead Only:trueMaximum Length:1Default Value:NIndicates 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 NameRead Only:trueMaximum Length:100Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-rules-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the matrix rules in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate 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.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the matrix rules when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-chargesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the pricing matrixes in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the pricing matrixes for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the pricing matrixes when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Value that uniquely identifies the matrix. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Title:
Rule Table IdValue that uniquely identifies the pricing matrix. -
MatrixName: string
Title:
NameMaximum Length:64Name of the pricing matrix. -
rules: array
Matrix Rules
Title:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Nested Schema : Matrix Dimensions
Type:
arrayTitle:
Matrix DimensionsA matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
arrayTitle:
Matrix RulesA matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the dimensions in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the dimensions for the approval flow. -
CompareToAttribute: string
Title:
Compare to AttributeRead Only:trueMaximum Length:80Compare to attribute for a dimension. -
ComparisonOperatorCode: string
Title:
ComparisonRead Only:trueMaximum Length:30Default Value:EComparison operator for a dimension. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
DataType: string
Title:
Data TypeRead Only:trueMaximum Length:30Default Value:STRINGData type for a dimension. -
DefaultIsFixedValue: string
Title:
Default Is Fixed ValueRead Only:trueMaximum Length:1Default Value:NDefault to a fixed value for a dimension. -
DefaultValueDate: string
(date)
Title:
Default ValueRead Only:trueDefault date for a dimension. -
DefaultValueNumber: number
Title:
Default ValueRead Only:trueDefault number for a dimension. -
DefaultValueString: string
Title:
Default ValueRead Only:trueMaximum Length:100Default string for a dimension. -
DefaultValueTimestamp: string
(date-time)
Title:
Default ValueRead Only:trueDefault time stamp for a dimension. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the dimension.
-
DimensionType: string
Title:
ColumnTypeRead Only:trueMaximum Length:50Type for the dimension. -
DisplaySequence: integer
(int32)
Title:
Display SequenceRead Only:trueDisplay sequence for a dimension. -
DomainType: string
Title:
Domain TypeRead Only:trueMaximum Length:30Default Value:NONEDomain type for a dimension. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the dimensions when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
IsNullable: string
Title:
Allow NullRead Only:trueMaximum Length:1Default Value:NIndicates whether the dimension can be a null value. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixDimensionId: integer
(int64)
Read Only:
trueValue 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 WildcardRead Only:trueMaximum Length:1Default Value:NContains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension can't be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
RequiredRead Only:trueMaximum Length:240Default Value:NContains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension isn't required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is DisplayedRead Only:trueMaximum Length:1Default Value:NIndicates 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 NameRead Only:trueMaximum Length:100Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-rules-item-response
Type:
Show Source
object-
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the matrix rules in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that designates the type of change for the matrix rules for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate 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.
-
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Approval status of the matrix rules when the approval flow is enabled. This status is null if the feature opt-in is set to No. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
trueValue that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End DateDate when the matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start DateDate when the matrix rule becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation 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 MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation 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 MethodMaximum Length:30Default Value:PER_UNITAbbreviation 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 ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the tier header in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier header for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EnforceAdjustmentCalculation: string
Title:
Enforce adjustment calculation on each tierRead Only:trueMaximum Length:30Default Value:NContains one of the following values: Y or N. If Y, then enforce adjustment calculation. If N, then don't enforce calculation. The default value is N. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Status value of the tier header in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier header in the approval flow. -
headerDFF: array
headerDFF
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
lines: array
Tier Lines
Title:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments. -
links: array
Links
Title:
LinksThe 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:
30Abbreviation 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 ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesA tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingHeaderId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-response
Type:
Show Source
object-
AdjustmentAmount: number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue 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 TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Abbreviation that identifies the method of adjustment.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
ChangeType: string
Read Only:
trueMaximum Length:255Change type for the tier line in the approval flow. -
ChangeTypeCode: string
Maximum Length:
30Code that specifies the type of change for the tier line for the approval flow. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EntityApprovalStatus: string
Read Only:
trueMaximum Length:255Status value of the tier line in the approval flow. -
EntityApprovalStatusCode: string
Maximum Length:
30Code for the status of the tier line in the approval flow. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
linesDFF: array
linesDFF
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum: number
Title:
MinimumMinimum 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingLineId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ChargeDefinitionVVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: PricingChargeDefinitionId; Target Attribute: PricingChargeDefinitionId
- Display Attribute: PricingChargeDefintion
- accessSets
-
Parameters:
- PriceListId:
$request.path.PriceListId
The Price List Access Sets resource associates access sets with a price list. - PriceListId:
- headerDFF
-
Parameters:
- PriceListId:
$request.path.PriceListId
- PriceListId:
- items
-
Parameters:
- PriceListId:
$request.path.PriceListId
The Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items. - PriceListId:
Examples
This example describes how to create a price list with a subscription item that has a rate plan with a basic usage charge.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/priceLists"
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 creates.
{
"PriceListName": "Price List Jan 01",
"BusinessUnit": "Vision Operations",
"Currency": "US Dollar",
"StartDate": "2022-01-01",
"items": [
{
"Item": "OAL_SUBSCRIPTION_FIXED",
"ItemLevelCode": "ITEM",
"LineTypeCode": "ORA_BUY",
"PricingUOM": "Each",
"ratePlans": [
{
"RatePlanName": "Rate Plan Jan 01",
"RatePlanDescription": "Rate Plan for Testing",
"StartDate": "2022-01-01",
"EndDate": "2022-12-31",
"ratePlanCharges": [
{
"PricingChargeDefinition": "Mobile Charge",
"UsageUOM": "MNS",
"ChargePeriodCode":"MNS",
"CalculationMethod": "Price",
"BasePrice": 0.1,
"StartDate": "2022-01-01",
"EndDate": "2022-12-31"
}
]
}
]
}
]
}Example Response Body
The following example includes the contents of the response body in JSON format:
{
"PriceListName": "Price List Jan 01",
"PriceListId": 300100575415124,
"PriceListDescription": null,
"PriceListType": "Segment price list",
"PriceListTypeCode": "SEGMENT",
"BusinessUnit": "Vision Operations",
"BusinessUnitId": 204,
"Currency": "US Dollar",
"CurrencyCode": "USD",
"Status": "In progress",
"StatusCode": "IN_PROGRESS",
"StartDate": "2022-01-01T00:00:00+00:00",
"EndDate": null,
"PricingChargeDefinition": null,
"PricingChargeDefinitionCode": null,
"PricingChargeDefinitionId": null,
"LineType": "Buy",
"LineTypeCode": "ORA_BUY",
"CalculationMethod": "Price",
"CalculationMethodCode": "PRICE",
"CreationDate": "2023-02-08T12:20:49.001+00:00",
"CreatedBy": "PRICING_MGR_OPERATIONS",
"LastUpdateDate": "2023-02-08T12:20:58.031+00:00",
"LastUpdatedBy": "PRICING_MGR_OPERATIONS",
"items": [
{
"PriceListId": 300100575415124,
"PriceListItemId": 300100575415125,
"Item": "OAL_SUBSCRIPTION_FIXED",
"InventoryItemId": 300100113529155,
"ItemDescription": "OAL_SUBSCRIPTION_FIXED",
"PricingUOM": "Each",
"PricingUOMCode": "Ea",
"LineType": "Buy",
"LineTypeCode": "ORA_BUY",
"PrimaryPricingUOM": "Y",
"ServiceDurationPeriod": "YEAR",
"ServiceDurationPeriodCode": "0zE",
"ServiceDuration": 2,
"ItemLevelCode": "ITEM",
"ItemLevel": "Item",
"CreationDate": "2023-02-08T12:20:49.594+00:00",
"CreatedBy": "PRICING_MGR_OPERATIONS",
"LastUpdateDate": "2023-02-08T12:20:58.253+00:00",
"LastUpdatedBy": "PRICING_MGR_OPERATIONS",
"ratePlans": [
{
"RatePlanId": 300100575415126,
"RatePlanName": "Rate Plan Jan 01",
"RatePlanDescription": "Rate Plan for Testing",
"RatePlanNumber": "17001",
"CurrencyCode": "USD",
"Currency": "US Dollar",
"StartDate": "2022-01-01T00:00:00+00:00",
"EndDate": "2022-12-31T00:00:00+00:00",
"CreatedBy": "PRICING_MGR_OPERATIONS",
"CreationDate": "2023-02-08T12:20:50.702+00:00",
"LastUpdateDate": "2023-02-08T12:20:58.289+00:00",
"LastUpdatedBy": "PRICING_MGR_OPERATIONS",
"ratePlanCharges": [
{
"RatePlanChargeId": 300100575415128,
"ParentEntityId": 300100575415126,
"ParentEntityTypeCode": "ORA_RATE_PLAN",
"PriceListId": 300100575415124,
"PricingChargeDefinition": "Mobile Charge",
"PricingChargeDefinitionCode": "MOBILE_CHARGE",
"PricingChargeDefinitionId": 300100542702863,
"PricePeriodicity": null,
"PricePeriodicityCode": null,
"UsageUOM": "MNS",
"UsageUOMCode": "MNS",
"ChargePeriod": "MNS",
"ChargePeriodCode": "MNS",
"CalculationMethod": "Price",
"CalculationMethodCode": "PRICE",
"CalculationType": null,
"CalculationTypeCode": null,
"AllowManualAdjustment": null,
"BasePrice": 0.1,
"CostCalculationAmount": null,
"StartDate": "2022-01-01T00:00:00+00:00",
"EndDate": "2022-12-31T00:00:00+00:00",
"ChargeLineNumber": 1,
"MatrixId": null,
"TierHeaderId": null,
"BasePriceMatrixId": null,
"QuantityAttribute": null,
"QuantityUOMAttribute": null,
"AllowPeriodicBilling": null,
"AllowPeriodicRevenueRecognition": null,
"CreationDate": "2023-02-08T12:20:52.546+00:00",
"CreatedBy": "PRICING_MGR_OPERATIONS",
"LastUpdateDate": "2023-02-08T12:20:58.570+00:00",
"LastUpdatedBy": "PRICING_MGR_OPERATIONS",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128",
"name": "ratePlanCharges",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128",
"name": "ratePlanCharges",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126",
"name": "ratePlans",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128/child/basePriceMatrixes",
"name": "basePriceMatrixes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128/child/chargesDFF",
"name": "chargesDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128/child/pricingMatrixes",
"name": "pricingMatrixes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges/300100575415128/child/pricingTiers",
"name": "pricingTiers",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126",
"name": "ratePlans",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126",
"name": "ratePlans",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125",
"name": "items",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans/300100575415126/child/ratePlanCharges",
"name": "ratePlanCharges",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125",
"name": "items",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125",
"name": "items",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124",
"name": "priceLists",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/charges",
"name": "charges",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/componentItems",
"name": "componentItems",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/coveredItems",
"name": "coveredItems",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/itemsDFF",
"name": "itemsDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items/300100575415125/child/ratePlans",
"name": "ratePlans",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124",
"name": "priceLists",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124",
"name": "priceLists",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/accessSets",
"name": "accessSets",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/headerDFF",
"name": "headerDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/priceLists/300100575415124/child/items",
"name": "items",
"kind": "collection"
}
]
}