Create rate plan charges
post
/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/ratePlans/{RatePlanId}/child/ratePlanCharges
Request
Path Parameters
-
PriceListId(required): integer(int64)
Value that uniquely identifies the price list.
-
PriceListItemId(required): integer(int64)
Value that uniquely identifies the price list item.
-
RatePlanId(required): integer(int64)
Value that uniquely identifies the rate plan.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
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
-
AllowManualAdjustment: string
Maximum Length:
30
Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N. -
AllowPeriodicBilling: string
Maximum Length:
1
Periodic billing for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. -
AllowPeriodicRevenueRecognition: string
Maximum Length:
1
Periodic revenue recognition for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. -
BasePrice: number
Value of the base price of the item.
-
basePriceMatrixes: array
Base Price Matrixes
Title:
Base Price Matrixes
The Base Price Matrixes resource manages the base price matrix for a rate plan charge. -
BasePriceMatrixId: integer
(int64)
Value that uniquely identifies the base price matrix for the rate plan charge.
-
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:
30
Abbreviation 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:
30
Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChargeLineNumber(required): integer
(int32)
Title:
Line Number
Number that identifies the line of the rate plan charge. -
ChargePeriod: string
Name of the charge period.
-
ChargePeriodCode: string
Maximum Length:
3
Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up 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
Flexfields for Price List Charges
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CostCalculationAmount: number
Title:
Cost Calculation Amount
Value of the cost calculation amount. -
EndDate: string
(date-time)
Date when the rate plan charge becomes inactive.
-
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the parent entity for the charge of the rate plan.
-
ParentEntityTypeCode(required): string
Maximum Length:
30
Abbreviation 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:
12
Abbreviation 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
Matrix Headers
Title:
Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities. -
pricingTiers: array
Tier Headers
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts. -
QuantityAttribute: string
Maximum Length:
300
Value of the attribute used for capturing the extensible capabilities of the quantity for a usage charge. This attribute needs to be defined under Manage Service Mappings. -
QuantityUOMAttribute: string
Maximum Length:
300
Value of the attribute used for capturing the extensible capabilities of the quantity unit of measure for a usage charge. This attribute needs to be defined under Manage Service Mappings. -
RatePlanChargeId: integer
(int64)
Value that uniquely identifies the charge of the rate plan.
-
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:
12
Abbreviation that uniquely identifies the unit of measure for the usage charge.
Nested Schema : Base Price Matrixes
Type:
array
Title:
Base Price Matrixes
The Base Price Matrixes resource manages the base price matrix for a rate plan charge.
Show Source
Nested Schema : Flexfields for Price List Charges
Type:
array
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Matrix Headers
Type:
array
Title:
Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities.
Show Source
Nested Schema : Tier Headers
Type:
array
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
dimensions: array
Matrix Dimensions
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header. -
MatrixId: integer
(int64)
Title:
Rule Table Id
Value that uniquely identifies the pricing matrix header. -
MatrixName: string
Title:
Name
Maximum Length:64
Name of the pricing matrix header. -
rules: array
Matrix Rules
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Nested Schema : Matrix Dimensions
Type:
array
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header.
Show Source
Nested Schema : Matrix Rules
Type:
array
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-post-request
Type:
Show Source
object
-
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
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
-
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.
-
RuleEndDate: string
(date-time)
Title:
End Date
Date when the price list matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the price list matrix rule becomes active.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-post-request
Type:
Show Source
object
-
dimensions: array
Matrix Dimensions
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header. -
MatrixId: integer
(int64)
Title:
Rule Table Id
Value that uniquely identifies the pricing matrix header. -
MatrixName: string
Title:
Name
Maximum Length:64
Name of the pricing matrix header. -
rules: array
Matrix Rules
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Nested Schema : Matrix Dimensions
Type:
array
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header.
Show Source
Nested Schema : Matrix Rules
Type:
array
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-post-request
Type:
Show Source
object
-
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
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
-
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.
-
RuleEndDate: string
(date-time)
Title:
End Date
Date when the price list matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the price list 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 Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
Name of the tier aggregation method. Valid values include On line and On document. A list of accepted values is defined in the lookup type ORA_QP_AGGREGATION_METHODS.
-
AggregationMethodCode: string
Title:
Aggregation Method
Maximum Length:30
Default Value:ORA_ON_DOCUMENT
Abbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Default Value:PER_UNIT
Abbreviation that identifies the method of tier application. -
AppliesTo: string
Name of the tier applicability. Valid values include Highest tier and All tiers. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES.
-
AppliesToCode: string
Title:
Apply To
Maximum Length:30
Default Value:HIGHEST_TIER
Abbreviation that identifies the tier applicability. -
headerDFF: array
Flexfields for Price List Header
Title:
Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list. -
lines: array
Tier Lines
Title:
Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityType: string
Type of the parent entity. Valid values include Pricing charge and Pricing term. A list of accepted values is defined in the lookup type ORA_QP_PARENT_ENTITY_TYPES.
-
ParentEntityTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of the parent entity. -
PartialBlockAction: string
Name of the tier partial block action. Valid values include Partial blocks and Satisfied blocks. A list of accepted values is defined in the lookup type ORA_QP_PARTIAL_BLOCK_ACTIONS.
-
PartialBlockActionCode: string
Title:
Partial Block Action
Maximum Length:30
Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier Basis
Value that uniquely identifies the tier basis. -
TierBasisType: string
Type of the tier basis. Valid values include Extended amount and Item quantity. A list of accepted values is defined in the lookup type ORA_QP_TIER_BASIS_TYPES.
-
TierBasisTypeCode(required): string
Title:
Tier Basis Type
Maximum Length:30
Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Flexfields for Price List Header
Type:
array
Title:
Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type:
array
Title:
Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-post-request
Type:
Show Source
object
-
AdjustmentAmount(required): number
Title:
Adjustment Amount
Value of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Abbreviation that identifies the method of tier application. -
IncrementValue: integer
Title:
Increment Value
Increment value number. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line. -
Maximum: number
Title:
Maximum
Maximum value for the tier line. -
Minimum(required): number
Title:
Minimum
Minimum 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 : Flexfields for Tier Lines
Type:
array
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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-items-ratePlans-ratePlanCharges-item-response
Type:
Show Source
object
-
AllowManualAdjustment: string
Maximum Length:
30
Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N. -
AllowPeriodicBilling: string
Maximum Length:
1
Periodic billing for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. -
AllowPeriodicRevenueRecognition: string
Maximum Length:
1
Periodic revenue recognition for a subscription. This attribute applies only to one-time charges. Contains one of the following values: Y or N. -
BasePrice: number
Value of the base price of the item.
-
basePriceMatrixes: array
Base Price Matrixes
Title:
Base Price Matrixes
The Base Price Matrixes resource manages the base price matrix for a rate plan charge. -
BasePriceMatrixId: integer
(int64)
Value that uniquely identifies the base price matrix for the rate plan charge.
-
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:
30
Abbreviation 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:
30
Abbreviation that identifies the type of calculation applied to the price list item charges in the price list. -
ChargeLineNumber: integer
(int32)
Title:
Line Number
Number that identifies the line of the rate plan charge. -
ChargePeriod: string
Name of the charge period.
-
ChargePeriodCode: string
Maximum Length:
3
Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up 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
Flexfields for Price List Charges
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CostCalculationAmount: number
Title:
Cost Calculation Amount
Value of the cost calculation amount. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EndDate: string
(date-time)
Date when the rate plan charge becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity for the charge of the rate plan.
-
ParentEntityTypeCode: string
Maximum Length:
30
Abbreviation 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:
12
Abbreviation 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
Matrix Headers
Title:
Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities. -
pricingTiers: array
Tier Headers
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts. -
QuantityAttribute: string
Maximum Length:
300
Value of the attribute used for capturing the extensible capabilities of the quantity for a usage charge. This attribute needs to be defined under Manage Service Mappings. -
QuantityUOMAttribute: string
Maximum Length:
300
Value of the attribute used for capturing the extensible capabilities of the quantity unit of measure for a usage charge. This attribute needs to be defined under Manage Service Mappings. -
RatePlanChargeId: integer
(int64)
Value that uniquely identifies the charge of the rate plan.
-
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:
12
Abbreviation that uniquely identifies the unit of measure for the usage charge.
Nested Schema : Base Price Matrixes
Type:
array
Title:
Base Price Matrixes
The Base Price Matrixes resource manages the base price matrix for a rate plan charge.
Show Source
Nested Schema : Flexfields for Price List Charges
Type:
array
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Headers
Type:
array
Title:
Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities.
Show Source
Nested Schema : Tier Headers
Type:
array
Title:
Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Title:
Rule Table Id
Value that uniquely identifies the pricing matrix header. -
MatrixName: string
Title:
Name
Maximum Length:64
Name of the pricing matrix header. -
rules: array
Matrix Rules
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Nested Schema : Matrix Dimensions
Type:
array
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
array
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-response
Type:
Show Source
object
-
CompareToAttribute: string
Title:
Compare to Attribute
Read Only:true
Maximum Length:80
Represents the pricing entity attribute to which the dimension is mapped against. -
ComparisonOperatorCode: string
Title:
Comparison
Read Only:true
Maximum Length:30
Default Value:E
Represents the comparison operator. Valid values include =, <,>, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.,> -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
DataType: string
Title:
Data Type
Read Only:true
Maximum Length:30
Default Value:STRING
Type of the dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DefaultIsFixedValue: string
Title:
Default Is Fixed Value
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the default value for the dimension is fixed. If N, then the default value for the dimension is not fixed. The default value is N. -
DefaultValueDate: string
(date)
Title:
Default Value
Read Only:true
Default value for a dimension with a date data type. -
DefaultValueNumber: number
Title:
Default Value
Read Only:true
Default value for a dimension with a number data type. -
DefaultValueString: string
Title:
Default Value
Read Only:true
Maximum Length:100
Default value for a dimension with a string data type. -
DefaultValueTimestamp: string
(date-time)
Title:
Default Value
Read Only:true
Default value for a dimension with a time stamp data type. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
DimensionType: string
Title:
ColumnType
Read Only:true
Maximum Length:50
Type of the dimension. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Sequence in which the dimensions get displayed. -
DomainType: string
Title:
Domain Type
Read Only:true
Maximum Length:30
Default Value:NONE
Type of the domain. Valid values include lookup, view object query, custom, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
IsNullable: string
Title:
Allow Null
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null. If N, then the dimension cannot be null. The default value is Y. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixDimensionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the dimension for a pricing matrix. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
NullasWildCard: string
Title:
Null Is Wildcard
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension cannot be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
Required
Read Only:true
Maximum Length:240
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension is not required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is Displayed
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N. -
SourceCodeName: string
Title:
Source Code Name
Read Only:true
Maximum Length:100
Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-rules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
Dimension1: string
Name of the first dimension in the matrix.
-
Dimension10: string
Name of the tenth dimension in the matrix.
-
Dimension10KeyValue: string
Value that uniquely identifies the tenth dimension value in the matrix.
-
Dimension10Value: string
Value of the tenth dimension in the matrix.
-
Dimension11: string
Name of the eleventh dimension in the matrix.
-
Dimension11KeyValue: string
Value that uniquely identifies the eleventh dimension value in the matrix.
-
Dimension11Value: string
Value of the eleventh dimension in the matrix.
-
Dimension12: string
Name of the twelfth dimension in the matrix.
-
Dimension12KeyValue: string
Value that uniquely identifies the twelfth dimension value in the matrix.
-
Dimension12Value: string
Value of the twelfth dimension in the matrix.
-
Dimension13: string
Name of the thirteenth dimension in the matrix.
-
Dimension13KeyValue: string
Value that uniquely identifies the thirteenth dimension value in the matrix.
-
Dimension13Value: string
Value of the thirteenth dimension in the matrix.
-
Dimension14: string
Name of the fourteenth dimension in the matrix.
-
Dimension14KeyValue: string
Value that uniquely identifies the fourteenth dimension value in the matrix.
-
Dimension14Value: string
Value of the fourteenth dimension in the matrix.
-
Dimension15: string
Name of the fifteenth dimension in the matrix.
-
Dimension15KeyValue: string
Value that uniquely identifies the fifteenth dimension value in the matrix.
-
Dimension15Value: string
Value of the fifteenth dimension in the matrix.
-
Dimension16: string
Name of the sixteenth dimension in the matrix.
-
Dimension16KeyValue: string
Value that uniquely identifies the sixteenth dimension value in the matrix.
-
Dimension16Value: string
Value of the sixteenth dimension in the matrix.
-
Dimension17: string
Name of the seventeenth dimension in the matrix.
-
Dimension17KeyValue: string
Value that uniquely identifies the seventeenth dimension value in the matrix.
-
Dimension17Value: string
Value of the seventeenth dimension in the matrix.
-
Dimension18: string
Name of the eighteenth dimension in the matrix.
-
Dimension18KeyValue: string
Value that uniquely identifies the eighteenth dimension value in the matrix.
-
Dimension18Value: string
Value of the eighteenth dimension in the matrix.
-
Dimension19: string
Name of the nineteenth dimension in the matrix.
-
Dimension19KeyValue: string
Value that uniquely identifies the nineteenth dimension value in the matrix.
-
Dimension19Value: string
Value of the nineteenth dimension in the matrix.
-
Dimension1KeyValue: string
Value that uniquely identifies the first dimension value in the matrix.
-
Dimension1Value: string
Value of the first dimension in the matrix.
-
Dimension2: string
Name of the second dimension in the matrix.
-
Dimension20: string
Name of the twentieth dimension in the matrix.
-
Dimension20KeyValue: string
Value that uniquely identifies the twentieth dimension value in the matrix.
-
Dimension20Value: string
Value of the twentieth dimension in the matrix.
-
Dimension21: string
Name of the twenty-first dimension in the matrix.
-
Dimension21KeyValue: string
Value that uniquely identifies the twenty-first dimension value in the matrix.
-
Dimension21Value: string
Value of the twenty-first dimension in the matrix.
-
Dimension22: string
Name of the twenty-second dimension in the matrix.
-
Dimension22KeyValue: string
Value that uniquely identifies the twenty-second dimension value in the matrix.
-
Dimension22Value: string
Value of the twenty-second dimension in the matrix.
-
Dimension23: string
Name of the twenty-third dimension in the matrix.
-
Dimension23KeyValue: string
Value that uniquely identifies the twenty-third dimension value in the matrix.
-
Dimension23Value: string
Value of the twenty-third dimension in the matrix.
-
Dimension24: string
Name of the twenty-fourth dimension in the matrix.
-
Dimension24KeyValue: string
Value that uniquely identifies the twenty-fourth dimension value in the matrix.
-
Dimension24Value: string
Value of the twenty-fourth dimension in the matrix.
-
Dimension25: string
Name of the twenty-fifth dimension in the matrix.
-
Dimension25KeyValue: string
Value that uniquely identifies the twenty-fifth dimension value in the matrix.
-
Dimension25Value: string
Value of the twenty-fifth dimension in the matrix.
-
Dimension2KeyValue: string
Value that uniquely identifies the second dimension value in the matrix.
-
Dimension2Value: string
Value of the second dimension in the matrix.
-
Dimension3: string
Name of the third dimension in the matrix.
-
Dimension3KeyValue: string
Value that uniquely identifies the third dimension value in the matrix.
-
Dimension3Value: string
Value of the third dimension in the matrix.
-
Dimension4: string
Name of the fourth dimension in the matrix.
-
Dimension4KeyValue: string
Value that uniquely identifies the fourth dimension value in the matrix.
-
Dimension4Value: string
Value of the fourth dimension in the matrix.
-
Dimension5: string
Name of the fifth dimension in the matrix.
-
Dimension5KeyValue: string
Value that uniquely identifies the fifth dimension value in the matrix.
-
Dimension5Value: string
Value of the fifth dimension in the matrix.
-
Dimension6: string
Name of the sixth dimension in the matrix.
-
Dimension6KeyValue: string
Value that uniquely identifies the sixth dimension value in the matrix.
-
Dimension6Value: string
Value of the sixth dimension in the matrix.
-
Dimension7: string
Name of the seventh dimension in the matrix.
-
Dimension7KeyValue: string
Value that uniquely identifies the seventh dimension value in the matrix.
-
Dimension7Value: string
Value of the seventh dimension in the matrix.
-
Dimension8: string
Name of the eighth dimension in the matrix.
-
Dimension8KeyValue: string
Value that uniquely identifies the eighth dimension value in the matrix.
-
Dimension8Value: string
Value of the eighth dimension in the matrix.
-
Dimension9: string
Name of the ninth dimension in the matrix.
-
Dimension9KeyValue: string
Value that uniquely identifies the ninth dimension value in the matrix.
-
Dimension9Value: string
Value of the ninth dimension in the matrix.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End Date
Date when the price list matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the price list matrix rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Value
Maximum Length:150
Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
dimensions: array
Matrix Dimensions
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Title:
Rule Table Id
Value that uniquely identifies the pricing matrix header. -
MatrixName: string
Title:
Name
Maximum Length:64
Name of the pricing matrix header. -
rules: array
Matrix Rules
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Nested Schema : Matrix Dimensions
Type:
array
Title:
Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Matrix Rules
Type:
array
Title:
Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-response
Type:
Show Source
object
-
CompareToAttribute: string
Title:
Compare to Attribute
Read Only:true
Maximum Length:80
Represents the pricing entity attribute to which the dimension is mapped against. -
ComparisonOperatorCode: string
Title:
Comparison
Read Only:true
Maximum Length:30
Default Value:E
Represents the comparison operator. Valid values include =, <,>, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.,> -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
DataType: string
Title:
Data Type
Read Only:true
Maximum Length:30
Default Value:STRING
Type of the dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DefaultIsFixedValue: string
Title:
Default Is Fixed Value
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the default value for the dimension is fixed. If N, then the default value for the dimension is not fixed. The default value is N. -
DefaultValueDate: string
(date)
Title:
Default Value
Read Only:true
Default value for a dimension with a date data type. -
DefaultValueNumber: number
Title:
Default Value
Read Only:true
Default value for a dimension with a number data type. -
DefaultValueString: string
Title:
Default Value
Read Only:true
Maximum Length:100
Default value for a dimension with a string data type. -
DefaultValueTimestamp: string
(date-time)
Title:
Default Value
Read Only:true
Default value for a dimension with a time stamp data type. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
DimensionType: string
Title:
ColumnType
Read Only:true
Maximum Length:50
Type of the dimension. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Sequence in which the dimensions get displayed. -
DomainType: string
Title:
Domain Type
Read Only:true
Maximum Length:30
Default Value:NONE
Type of the domain. Valid values include lookup, view object query, custom, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
IsNullable: string
Title:
Allow Null
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null. If N, then the dimension cannot be null. The default value is Y. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixDimensionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the dimension for a pricing matrix. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
NullasWildCard: string
Title:
Null Is Wildcard
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension cannot be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
Required
Read Only:true
Maximum Length:240
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension is not required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is Displayed
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N. -
SourceCodeName: string
Title:
Source Code Name
Read Only:true
Maximum Length:100
Name of the source code for the matrix dimension.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-rules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
Dimension1: string
Name of the first dimension in the matrix.
-
Dimension10: string
Name of the tenth dimension in the matrix.
-
Dimension10KeyValue: string
Value that uniquely identifies the tenth dimension value in the matrix.
-
Dimension10Value: string
Value of the tenth dimension in the matrix.
-
Dimension11: string
Name of the eleventh dimension in the matrix.
-
Dimension11KeyValue: string
Value that uniquely identifies the eleventh dimension value in the matrix.
-
Dimension11Value: string
Value of the eleventh dimension in the matrix.
-
Dimension12: string
Name of the twelfth dimension in the matrix.
-
Dimension12KeyValue: string
Value that uniquely identifies the twelfth dimension value in the matrix.
-
Dimension12Value: string
Value of the twelfth dimension in the matrix.
-
Dimension13: string
Name of the thirteenth dimension in the matrix.
-
Dimension13KeyValue: string
Value that uniquely identifies the thirteenth dimension value in the matrix.
-
Dimension13Value: string
Value of the thirteenth dimension in the matrix.
-
Dimension14: string
Name of the fourteenth dimension in the matrix.
-
Dimension14KeyValue: string
Value that uniquely identifies the fourteenth dimension value in the matrix.
-
Dimension14Value: string
Value of the fourteenth dimension in the matrix.
-
Dimension15: string
Name of the fifteenth dimension in the matrix.
-
Dimension15KeyValue: string
Value that uniquely identifies the fifteenth dimension value in the matrix.
-
Dimension15Value: string
Value of the fifteenth dimension in the matrix.
-
Dimension16: string
Name of the sixteenth dimension in the matrix.
-
Dimension16KeyValue: string
Value that uniquely identifies the sixteenth dimension value in the matrix.
-
Dimension16Value: string
Value of the sixteenth dimension in the matrix.
-
Dimension17: string
Name of the seventeenth dimension in the matrix.
-
Dimension17KeyValue: string
Value that uniquely identifies the seventeenth dimension value in the matrix.
-
Dimension17Value: string
Value of the seventeenth dimension in the matrix.
-
Dimension18: string
Name of the eighteenth dimension in the matrix.
-
Dimension18KeyValue: string
Value that uniquely identifies the eighteenth dimension value in the matrix.
-
Dimension18Value: string
Value of the eighteenth dimension in the matrix.
-
Dimension19: string
Name of the nineteenth dimension in the matrix.
-
Dimension19KeyValue: string
Value that uniquely identifies the nineteenth dimension value in the matrix.
-
Dimension19Value: string
Value of the nineteenth dimension in the matrix.
-
Dimension1KeyValue: string
Value that uniquely identifies the first dimension value in the matrix.
-
Dimension1Value: string
Value of the first dimension in the matrix.
-
Dimension2: string
Name of the second dimension in the matrix.
-
Dimension20: string
Name of the twentieth dimension in the matrix.
-
Dimension20KeyValue: string
Value that uniquely identifies the twentieth dimension value in the matrix.
-
Dimension20Value: string
Value of the twentieth dimension in the matrix.
-
Dimension21: string
Name of the twenty-first dimension in the matrix.
-
Dimension21KeyValue: string
Value that uniquely identifies the twenty-first dimension value in the matrix.
-
Dimension21Value: string
Value of the twenty-first dimension in the matrix.
-
Dimension22: string
Name of the twenty-second dimension in the matrix.
-
Dimension22KeyValue: string
Value that uniquely identifies the twenty-second dimension value in the matrix.
-
Dimension22Value: string
Value of the twenty-second dimension in the matrix.
-
Dimension23: string
Name of the twenty-third dimension in the matrix.
-
Dimension23KeyValue: string
Value that uniquely identifies the twenty-third dimension value in the matrix.
-
Dimension23Value: string
Value of the twenty-third dimension in the matrix.
-
Dimension24: string
Name of the twenty-fourth dimension in the matrix.
-
Dimension24KeyValue: string
Value that uniquely identifies the twenty-fourth dimension value in the matrix.
-
Dimension24Value: string
Value of the twenty-fourth dimension in the matrix.
-
Dimension25: string
Name of the twenty-fifth dimension in the matrix.
-
Dimension25KeyValue: string
Value that uniquely identifies the twenty-fifth dimension value in the matrix.
-
Dimension25Value: string
Value of the twenty-fifth dimension in the matrix.
-
Dimension2KeyValue: string
Value that uniquely identifies the second dimension value in the matrix.
-
Dimension2Value: string
Value of the second dimension in the matrix.
-
Dimension3: string
Name of the third dimension in the matrix.
-
Dimension3KeyValue: string
Value that uniquely identifies the third dimension value in the matrix.
-
Dimension3Value: string
Value of the third dimension in the matrix.
-
Dimension4: string
Name of the fourth dimension in the matrix.
-
Dimension4KeyValue: string
Value that uniquely identifies the fourth dimension value in the matrix.
-
Dimension4Value: string
Value of the fourth dimension in the matrix.
-
Dimension5: string
Name of the fifth dimension in the matrix.
-
Dimension5KeyValue: string
Value that uniquely identifies the fifth dimension value in the matrix.
-
Dimension5Value: string
Value of the fifth dimension in the matrix.
-
Dimension6: string
Name of the sixth dimension in the matrix.
-
Dimension6KeyValue: string
Value that uniquely identifies the sixth dimension value in the matrix.
-
Dimension6Value: string
Value of the sixth dimension in the matrix.
-
Dimension7: string
Name of the seventh dimension in the matrix.
-
Dimension7KeyValue: string
Value that uniquely identifies the seventh dimension value in the matrix.
-
Dimension7Value: string
Value of the seventh dimension in the matrix.
-
Dimension8: string
Name of the eighth dimension in the matrix.
-
Dimension8KeyValue: string
Value that uniquely identifies the eighth dimension value in the matrix.
-
Dimension8Value: string
Value of the eighth dimension in the matrix.
-
Dimension9: string
Name of the ninth dimension in the matrix.
-
Dimension9KeyValue: string
Value that uniquely identifies the ninth dimension value in the matrix.
-
Dimension9Value: string
Value of the ninth dimension in the matrix.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the matrix rule. -
RuleEndDate: string
(date-time)
Title:
End Date
Date when the price list matrix rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the price list matrix rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
Name of the tier aggregation method. Valid values include On line and On document. A list of accepted values is defined in the lookup type ORA_QP_AGGREGATION_METHODS.
-
AggregationMethodCode: string
Title:
Aggregation Method
Maximum Length:30
Default Value:ORA_ON_DOCUMENT
Abbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Default Value:PER_UNIT
Abbreviation that identifies the method of tier application. -
AppliesTo: string
Name of the tier applicability. Valid values include Highest tier and All tiers. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES.
-
AppliesToCode: string
Title:
Apply To
Maximum Length:30
Default Value:HIGHEST_TIER
Abbreviation that identifies the tier applicability. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EnforceAdjustmentCalculation: string
Title:
Enforce adjustment calculation on each tier
Read Only:true
Maximum Length:30
Default Value:N
Contains one of the following values: Y or N. If Y, then enforce adjustment calculation. If N, then do not enforce calculation. The default value is N. -
headerDFF: array
Flexfields for Price List Header
Title:
Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
lines: array
Tier Lines
Title:
Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityType: string
Type of the parent entity. Valid values include Pricing charge and Pricing term. A list of accepted values is defined in the lookup type ORA_QP_PARENT_ENTITY_TYPES.
-
ParentEntityTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of the parent entity. -
PartialBlockAction: string
Name of the tier partial block action. Valid values include Partial blocks and Satisfied blocks. A list of accepted values is defined in the lookup type ORA_QP_PARTIAL_BLOCK_ACTIONS.
-
PartialBlockActionCode: string
Title:
Partial Block Action
Maximum Length:30
Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier Basis
Value that uniquely identifies the tier basis. -
TierBasisType: string
Type of the tier basis. Valid values include Extended amount and Item quantity. A list of accepted values is defined in the lookup type ORA_QP_TIER_BASIS_TYPES.
-
TierBasisTypeCode: string
Title:
Tier Basis Type
Maximum Length:30
Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Flexfields for Price List Header
Type:
array
Title:
Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type:
array
Title:
Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment Amount
Value of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
Value that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
-
ApplicationMethodCode: string
Title:
Application Method
Maximum Length:30
Abbreviation that identifies the method of tier application. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
IncrementValue: integer
Title:
Increment Value
Increment value number. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Maximum: number
Title:
Maximum
Maximum value for the tier line. -
Minimum: number
Title:
Minimum
Minimum value for the tier line. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber: integer
(int32)
Line number of the tier.
Nested Schema : Flexfields for Tier Lines
Type:
array
Title:
Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The 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 Value
Maximum Length:150
Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ChargeDefinitionsVVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: PricingChargeDefinitionId; Target Attribute: PricingChargeDefinitionId
- Display Attribute: PricingChargeDefinitionId
- basePriceMatrixes
-
Parameters:
- PriceListId:
$request.path.PriceListId
- PriceListItemId:
$request.path.PriceListItemId
- RatePlanChargeId:
$request.path.RatePlanChargeId
- RatePlanId:
$request.path.RatePlanId
The Base Price Matrixes resource manages the base price matrix for a rate plan charge. - PriceListId:
- chargesDFF
-
Parameters:
- PriceListId:
$request.path.PriceListId
- PriceListItemId:
$request.path.PriceListItemId
- RatePlanChargeId:
$request.path.RatePlanChargeId
- RatePlanId:
$request.path.RatePlanId
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. - PriceListId:
- pricingMatrixes
-
Parameters:
- PriceListId:
$request.path.PriceListId
- PriceListItemId:
$request.path.PriceListItemId
- RatePlanChargeId:
$request.path.RatePlanChargeId
- RatePlanId:
$request.path.RatePlanId
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities. - PriceListId:
- pricingTiers
-
Parameters:
- PriceListId:
$request.path.PriceListId
- PriceListItemId:
$request.path.PriceListItemId
- RatePlanChargeId:
$request.path.RatePlanChargeId
- RatePlanId:
$request.path.RatePlanId
The Tier Headers resource manages tier headers for pricing charges and discounts. - PriceListId: