Price Usages
post
/fscmRestApi/serviceMappings/contextServices/Sales/PriceUsages
Price Usages
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ChangeSummary: array
ChangeSummary
Values that store the summary of the changes.
-
Charge: array
Charge
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
-
ChargeComponent: array
ChargeComponent
Stores the price elements for each charge applied within the pricing process.
-
Line: array
Line
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
-
PricingMessage: array
PricingMessage
This entity contains one instance for each pricing error found on the transaction.
-
PricingServiceParameter: array
PricingServiceParameter
Values that the calling applications send to Oracle Pricing Cloud. These attributes also store the output status of the pricing process.
Nested Schema : ChangeSummary
Type:
array
Values that store the summary of the changes.
Show Source
-
Array of:
object ChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
array
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Show Source
-
Array of:
object ChargeType
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Nested Schema : ChargeComponent
Type:
array
Stores the price elements for each charge applied within the pricing process.
Show Source
-
Array of:
object ChargeComponentType
Stores the price elements for each charge applied within the pricing process.
Nested Schema : Line
Type:
array
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
Array of:
object LineType
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Nested Schema : PricingMessage
Type:
array
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
Array of:
object PricingMessageType
This entity contains one instance for each pricing error found on the transaction.
Nested Schema : PricingServiceParameter
Type:
array
Values that the calling applications send to Oracle Pricing Cloud. These attributes also store the output status of the pricing process.
Show Source
-
Array of:
object PricingServiceParameterType
Value that the calling applications send to Oracle Pricing Cloud. This attribute also stores the output status of the pricing process
Nested Schema : ChangeSummaryType
Type:
object
Values that store the summary of the changes.
Show Source
Nested Schema : ChargeType
Type:
object
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Show Source
-
CanAdjustFlag: boolean
The flag from pricelist/shippingPolicy admin indicating whether this price can be discounted.
-
ChargeAppliesTo: string
Indicates the type of charge (Price, Return, or Shipping)
-
ChargeDefinitionCode: string
Unique Code of the Pricing Charge Definition
-
ChargeDefinitionId: integer
(int64)
Id of the charge definition entity.
-
ChargeId: integer
(int64)
Charge Id
-
ChargeSubtypeCode: string
Subtype of a given charge type.
-
ChargeTypeCode: string
Type of a given charge.
-
CurrencyCode: string
Indicates the currency used in the charge
-
LineId: integer
(int64)
Value that uniquely identifies the line.
-
ParentEntityCode: string
Parent entity of the charge. Values include Line and Line Coverage
-
ParentEntityId: integer
(int64)
Id of the parent entity of the charge.
-
PricedQuantity: object
PricedQuantity
-
PricedQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
PriceTypeCode: string
Price type of a given charge.
-
SequenceNumber: integer
(int64)
The value of this attribute indicates the sequence number for the charge.
Nested Schema : PricedQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
Value: number
The value indicates the Estimated Usage.
Nested Schema : ChargeComponentType
Type:
object
Stores the price elements for each charge applied within the pricing process.
Show Source
-
ChargeComponentId: integer
(int64)
Charge Component Id
-
ChargeId: integer
(int64)
chargeId on which price/adjustment applied to
-
CurrencyCode: string
Indicates the currency used in the charge component. Needed due to service standardization.
-
ExtendedAmount: object
ExtendedAmount
-
PriceElementCode: string
Element reference to the Price Elements setup eg. LISTPRICE, NETPRICE etc.
-
PriceElementUsageCode: string
Used by consuming applications to indicate how the charge component will be used. Values of this attribute will come from a QP lookup.
-
SequenceNumber: integer
(int64)
Sequence number for the charge component.
-
SourceId: integer
(int64)
Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.
-
SourceTypeCode: string
Type of the Pricing source eg. Segment Price List Line etc. The values are from the lookup QP_ENTITY_TYPES plus manual adjustment.
-
UnitPrice: object
UnitPrice
Nested Schema : ExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
This attribute indicates the extended amount in line currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quancity for CP. If either isEstimatedPricedQuantity or isEstimatedUnitPrice is set to Y, the extended amount will be an estimated amount.
-
Value: number
This attribute indicates the extended amount in line currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quancity for CP. If either isEstimatedPricedQuantity or isEstimatedUnitPrice is set to Y, the extended amount will be an estimated amount.
Nested Schema : UnitPrice
Type:
Show Source
object
-
CurrencyCode: string
The price or adjustment per unit in the charge currency for the line UOM.
-
Value: number
The price or adjustment per unit in the charge currency for the line UOM.
Nested Schema : LineType
Type:
object
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
InventoryItemId: integer
(int64)
Item to be Priced.
-
InventoryItemNumber: string
The number of the item that pricing must price.
-
InventoryOrganizationCode: string
Abbreviation that identifies the inventory organization that the Inventory Item Number references.
-
InventoryOrganizationId: integer
(int64)
The Inventory Org Id for this Inventory Item.
-
LineId: integer
(int64)
Line Id.
-
PricedOn: string
The date when the line is priced. This attribute will be populated with the system date at the beginning of a pricing process.
-
RatePlanId: integer
(int64)
Value that uniquely identifies the rate plan.
-
SubscriptionId: integer
(int64)
Value that uniquely identifies the subscription.
-
SubscriptionNumber: string
Number that indicates the subscription number.
-
SubscriptionProductId: integer
(int64)
Value that uniquely identifies the subscription line.
-
SubscriptionProductPuid: string
PUID of the subscription product
-
TransactionOn: string
This attribute stores the date of the transaction.
-
UsageQuantity: object
UsageQuantity
-
UsageQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the usage quantity.
Nested Schema : UsageQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure of usage.
-
Value: number
Usage quantity that is requested to be priced.
Nested Schema : PricingMessageType
Type:
object
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
MessageName: string
Name of the error message.
-
MessageText: string
Text describing the nature of the error that occurred.
-
MessageTypeCode: string
Value that indicates the type of message. A list of accepted values is defined in the lookup type FND.
-
ParentEntityCode: string
Abbreviation that indicates the parent entity of the error. Values include Line, Charge, and so on.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity on which the error occurred.
-
PricingMessageId: integer
(int64)
Value that uniquely identifies the error.
Nested Schema : PricingServiceParameterType
Type:
object
Value that the calling applications send to Oracle Pricing Cloud. This attribute also stores the output status of the pricing process
Show Source
-
CalculateToPriceElement: string
Value that determines which price element is calculated up to by the pricing engine. Value of this attribute is the element code for a price element of type Price or Margin. Values include List Price, Net Price, Margin, and so on. This attribute is currently used by Oracle Fusion Contracts.
-
OutputStatus: string
Value that indicates the output status. Values include Success or Error.
-
PricingContext: string
Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.
Response
Supported Media Types
- application/json
200 Response
Price calculated successfully.
Root Schema : schema
Type:
Show Source
object
-
ChangeSummary: array
ChangeSummary
Values that store the summary of the changes.
-
Charge: array
Charge
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
-
ChargeComponent: array
ChargeComponent
Stores the price elements for each charge applied within the pricing process.
-
Line: array
Line
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
-
PricingMessage: array
PricingMessage
This entity contains one instance for each pricing error found on the transaction.
-
PricingServiceParameter: array
PricingServiceParameter
Values that the calling applications send to Oracle Pricing Cloud. These attributes also store the output status of the pricing process.
Nested Schema : ChangeSummary
Type:
array
Values that store the summary of the changes.
Show Source
-
Array of:
object ChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
array
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Show Source
-
Array of:
object ChargeType
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Nested Schema : ChargeComponent
Type:
array
Stores the price elements for each charge applied within the pricing process.
Show Source
-
Array of:
object ChargeComponentType
Stores the price elements for each charge applied within the pricing process.
Nested Schema : Line
Type:
array
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
Array of:
object LineType
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Nested Schema : PricingMessage
Type:
array
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
Array of:
object PricingMessageType
This entity contains one instance for each pricing error found on the transaction.
Nested Schema : PricingServiceParameter
Type:
array
Values that the calling applications send to Oracle Pricing Cloud. These attributes also store the output status of the pricing process.
Show Source
-
Array of:
object PricingServiceParameterType
Value that the calling applications send to Oracle Pricing Cloud. This attribute also stores the output status of the pricing process
Nested Schema : ChangeSummaryType
Type:
object
Values that store the summary of the changes.
Show Source
Nested Schema : ChargeType
Type:
object
Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.
Show Source
-
CanAdjustFlag: boolean
The flag from pricelist/shippingPolicy admin indicating whether this price can be discounted.
-
ChargeAppliesTo: string
Indicates the type of charge (Price, Return, or Shipping)
-
ChargeDefinitionCode: string
Unique Code of the Pricing Charge Definition
-
ChargeDefinitionId: integer
(int64)
Id of the charge definition entity.
-
ChargeId: integer
(int64)
Charge Id
-
ChargeSubtypeCode: string
Subtype of a given charge type.
-
ChargeTypeCode: string
Type of a given charge.
-
CurrencyCode: string
Indicates the currency used in the charge
-
LineId: integer
(int64)
Value that uniquely identifies the line.
-
ParentEntityCode: string
Parent entity of the charge. Values include Line and Line Coverage
-
ParentEntityId: integer
(int64)
Id of the parent entity of the charge.
-
PricedQuantity: object
PricedQuantity
-
PricedQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
PriceTypeCode: string
Price type of a given charge.
-
SequenceNumber: integer
(int64)
The value of this attribute indicates the sequence number for the charge.
Nested Schema : PricedQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
Value: number
The value indicates the Estimated Usage.
Nested Schema : ChargeComponentType
Type:
object
Stores the price elements for each charge applied within the pricing process.
Show Source
-
ChargeComponentId: integer
(int64)
Charge Component Id
-
ChargeId: integer
(int64)
chargeId on which price/adjustment applied to
-
CurrencyCode: string
Indicates the currency used in the charge component. Needed due to service standardization.
-
ExtendedAmount: object
ExtendedAmount
-
PriceElementCode: string
Element reference to the Price Elements setup eg. LISTPRICE, NETPRICE etc.
-
PriceElementUsageCode: string
Used by consuming applications to indicate how the charge component will be used. Values of this attribute will come from a QP lookup.
-
SequenceNumber: integer
(int64)
Sequence number for the charge component.
-
SourceId: integer
(int64)
Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.
-
SourceTypeCode: string
Type of the Pricing source eg. Segment Price List Line etc. The values are from the lookup QP_ENTITY_TYPES plus manual adjustment.
-
UnitPrice: object
UnitPrice
Nested Schema : ExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
This attribute indicates the extended amount in line currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quancity for CP. If either isEstimatedPricedQuantity or isEstimatedUnitPrice is set to Y, the extended amount will be an estimated amount.
-
Value: number
This attribute indicates the extended amount in line currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quancity for CP. If either isEstimatedPricedQuantity or isEstimatedUnitPrice is set to Y, the extended amount will be an estimated amount.
Nested Schema : UnitPrice
Type:
Show Source
object
-
CurrencyCode: string
The price or adjustment per unit in the charge currency for the line UOM.
-
Value: number
The price or adjustment per unit in the charge currency for the line UOM.
Nested Schema : LineType
Type:
object
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
InventoryItemId: integer
(int64)
Item to be Priced.
-
InventoryItemNumber: string
The number of the item that pricing must price.
-
InventoryOrganizationCode: string
Abbreviation that identifies the inventory organization that the Inventory Item Number references.
-
InventoryOrganizationId: integer
(int64)
The Inventory Org Id for this Inventory Item.
-
LineId: integer
(int64)
Line Id.
-
PricedOn: string
The date when the line is priced. This attribute will be populated with the system date at the beginning of a pricing process.
-
RatePlanId: integer
(int64)
Value that uniquely identifies the rate plan.
-
SubscriptionId: integer
(int64)
Value that uniquely identifies the subscription.
-
SubscriptionNumber: string
Number that indicates the subscription number.
-
SubscriptionProductId: integer
(int64)
Value that uniquely identifies the subscription line.
-
SubscriptionProductPuid: string
PUID of the subscription product
-
TransactionOn: string
This attribute stores the date of the transaction.
-
UsageQuantity: object
UsageQuantity
-
UsageQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the usage quantity.
Nested Schema : UsageQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure of usage.
-
Value: number
Usage quantity that is requested to be priced.
Nested Schema : PricingMessageType
Type:
object
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
MessageName: string
Name of the error message.
-
MessageText: string
Text describing the nature of the error that occurred.
-
MessageTypeCode: string
Value that indicates the type of message. A list of accepted values is defined in the lookup type FND.
-
ParentEntityCode: string
Abbreviation that indicates the parent entity of the error. Values include Line, Charge, and so on.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity on which the error occurred.
-
PricingMessageId: integer
(int64)
Value that uniquely identifies the error.
Nested Schema : PricingServiceParameterType
Type:
object
Value that the calling applications send to Oracle Pricing Cloud. This attribute also stores the output status of the pricing process
Show Source
-
CalculateToPriceElement: string
Value that determines which price element is calculated up to by the pricing engine. Value of this attribute is the element code for a price element of type Price or Margin. Values include List Price, Net Price, Margin, and so on. This attribute is currently used by Oracle Fusion Contracts.
-
OutputStatus: string
Value that indicates the output status. Values include Success or Error.
-
PricingContext: string
Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.
400 Response
Invalid input request.