Validate Sales Prices
post
/fscmRestApi/serviceMappings/contextServices/Sales/ValidateSalesPrices
Validate Sales Prices
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ChangeSummary: array
ChangeSummary
-
Charge: array
Charge
-
ChargeComponent: array
ChargeComponent
-
Header: array
Header
-
Line: array
Line
-
LineAttribute: array
LineAttribute
-
PriceValidation: array
PriceValidation
-
PriceViolation: array
PriceViolation
-
PricingMessage: array
PricingMessage
-
PricingServiceParameter: array
PricingServiceParameter
Nested Schema : ChangeSummary
Type:
Show Source
array
-
Array of:
object ChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
Show Source
array
-
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:
Show Source
array
-
Array of:
object ChargeComponentType
Stores the price elements for each charge applied within the pricing process.
Nested Schema : Header
Type:
Show Source
array
-
Array of:
object HeaderType
Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
Nested Schema : Line
Type:
Show Source
array
-
Array of:
object LineType
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Nested Schema : LineAttribute
Type:
Show Source
array
-
Array of:
object LineAttributeType
Values that store the transaction item attributes. This attribute is used only for input.
Nested Schema : PriceValidation
Type:
Show Source
array
-
Array of:
object PriceValidationType
This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.
Nested Schema : PriceViolation
Type:
Show Source
array
-
Array of:
object PriceViolationType
This entity is an output from Pricing. It stores the guidelines violated in the pricing process.
Nested Schema : PricingMessage
Type:
Show Source
array
-
Array of:
object PricingMessageType
This entity contains one instance for each pricing error found on the transaction.
Nested Schema : PricingServiceParameter
Type:
Show Source
array
-
Array of:
object PricingServiceParameterType
This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.
Nested Schema : ChangeSummaryType
Type:
object
Values that store the summary of the changes.
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.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationUOMCode: string
Indicates the coverage duration unit of measure used to calculate the coverage extended amount that applies to a coverage association.
-
CurrencyCode: string
Indicates the currency used in the charge
-
EstimatedPricedQuantityFlag: boolean
This attribute indicates whether the priced quantity is an estimated number.
-
EstimatedUnitPriceFlag: boolean
This attribute indicates whether the unit price is an estimated number.
-
FloorUnitPrice: object
FloorUnitPrice
-
GSAUnitPrice: object
GSAUnitPrice
-
LineId: integer
(int64)
Indicates the Line ID of the parent line of a charge.
-
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
UOM code for priced quantity, for example 'Ton'. Values for this attribute will come either from PIM or the reciprocal service QOC provides.
-
PricePeriodicityCode: string
Indidates periodicty for both recurring and recurring usage price types
-
PriceTypeCode: string
Price type of a given charge.
-
PrimaryFlag: boolean
Indicates whether this charge is the primary charge.
-
RollupFlag: boolean
Marks a charge as a rollup/aggregate charge.
-
SequenceNumber: integer
(int64)
The value of this attribute indicates the sequence number for the charge.
-
SourceChargeId: integer
(int64)
Indicates the ID of a source charge created by an external pricing engine.
-
TaxIncludedFlag: boolean
Indicates whether the charge includes tax.
-
UsagePeriodCode: string
Usage period code for the estimated usage quantity.
-
UsageUOMCode: string
Usage uom code for the estimated usage quantity.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
UOM code of the coverage duration.
-
Value: number
Indicates the coverage duration of a charge that applies to a coverage association.
Nested Schema : FloorUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Unit price amount derived from a matching floor price list on the strategy for the current transaction.
-
Value: number
Unit price amount derived from a matching floor price list on the strategy for the current transaction.
Nested Schema : GSAUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Unit price amount derived from a matching GSA price list on the strategy for the current transaction.
-
Value: number
Unit price amount derived from a matching GSA price list on the strategy for the current transaction.
Nested Schema : PricedQuantity
Type:
Show Source
object
-
UomCode: string
If price type equals usage or recurring usage, -If "IsPerUnitUsage? = TRUE, pricedQuantity = Estimated Usage Quantity * Line.Requested Quantity for simple products, pricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP -If ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity If price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP
-
Value: number
If price type equals usage or recurring usage, -If "IsPerUnitUsage? = TRUE, pricedQuantity = Estimated Usage Quantity * Line.Requested Quantity for simple products, pricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP -If ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity If price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP
Nested Schema : ChargeComponentType
Type:
object
Stores the price elements for each charge applied within the pricing process.
Show Source
-
AggregateChargeComponentId: integer
(int64)
Indicates the reference to the ID of an aggregate charge component on the roll-up charge. The ID is used to model a many-to-one relationship between the charge components of a native charge and the roll-up charge.
-
ChargeComponentId: integer
(int64)
Charge Component Id
-
ChargeId: integer
(int64)
chargeId on which price/adjustment applied to
-
CoverageExtendedAmount: object
CoverageExtendedAmount
-
CurrencyCode: string
Indicates the currency used in the charge component. Needed due to service standardization.
-
Explanation: string
Message for display in a price breakdown or PWF UI.
-
ExplanationMessageName: string
The name of an explanation message.
-
ExtendedAmount: object
ExtendedAmount
-
HeaderCurrencyCode: string
Indicates the header currency. Needed due to service standardization.
-
HeaderCurrencyCoverageExtendedAmount: object
HeaderCurrencyCoverageExtendedAmount
-
HeaderCurrencyExtendedAmount: object
HeaderCurrencyExtendedAmount
-
HeaderCurrencyUnitPrice: object
HeaderCurrencyUnitPrice
-
PercentOfComparisonElement: number
The percentage that this unit price is of the basis charge component unit price. By default the basis is the List Price. This attribute captures the Margin %, the % the Net Price is of the List Price etc.
-
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.
-
RollupFlag: boolean
Marks a charge component as a rollup/aggregate value for the charge component price element code.
-
SequenceNumber: integer
(int64)
Sequence number for the charge component.
-
SourceChargeComponentId: string
Indicates the ID of a source charge component created by an external pricing engine.
-
SourceChargeId: string
Indicates the ID of a source charge created by an external pricing engine.
-
SourceId: integer
(int64)
Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.
-
SourceParentChargeComponentId: string
Indicates the ID of a source parent charge component created by an external pricing engine.
-
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.
-
TaxIncludedFlag: boolean
Indicates whether a tax is included for a given charge component.
-
UnitPrice: object
UnitPrice
Nested Schema : CoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Indicates the coverage extended amount used for the entire service duration of a coverage association.
-
Value: number
Indicates the coverage extended amount used for the entire service duration of a coverage association.
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 : HeaderCurrencyCoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association.
-
Value: number
Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association.
Nested Schema : HeaderCurrencyExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
The currency of header.
-
Value: number
This attribute indicates the extended amount in header currency
Nested Schema : HeaderCurrencyUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
This attribute indicates the unit price in header currency
-
Value: number
This attribute indicates the unit price in header currency
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 : HeaderType
Type:
object
Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
Show Source
-
AllowCurrencyOverrideFlag: boolean
Indicate whether the currency can be overridden.
-
AppliedCurrencyCode: string
Currency code to be used as the default header currency.
-
BillingThirdPartyAccountId: integer
(int64)
Indicates the billing third-party account ID, used in tax calculations.
-
BillingThirdPartyAccountName: string
Name of the third-party account that pricing uses in tax calculations for billing.
-
BillingThirdPartyAccountNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillingThirdPartyAccountSiteId: integer
(int64)
Indicates the billing third-party account site ID, used in tax calculations.
-
BillingThirdPartyAccountSiteNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillToCustomerAccountSiteUseId: integer
(int64)
Indicates the bill to customer account site use ID, used in tax calculations.
-
CalculatePricingChargesFlag: boolean
Determines whether or not to price charges for a line item. Value is true (default) or false.
-
CalculateShippingChargesFlag: boolean
Determines whether or not to evaluate shipping-related charges for the document. Value is either true (default) or false.
-
CalculateTaxFlag: boolean
Determines whether or not to call Fusion Tax to derive tax amounts for the lines on the document. Value is either 'Y' (default) or 'N'.
-
CustomerId: integer
(int64)
Sold To Customer Id.
-
CustomerName: string
The Party Name in Customer Data Management provides this name.
-
CustomerNumber: string
The Party Number in Customer Data Management provides this number.
-
CustomerTypeCode: string
Indicates whether customer is internal or external.
-
DefaultCurrencyCode: string
The purpose of this is to retain the original currency returned for the strategy.
-
EndCustomerId: integer
(int64)
Id of the customer who receives the item.
-
EndCustomerName: string
Name of the customer who receives the item. The Party Name in Customer Data Management provides this name.
-
EndCustomerNumber: string
Number that identifies the customer who receives the item. The Party Number in Customer Data Management provides this number.
-
FulfillmentGeographyId: integer
(int64)
This will be either null (initially), or specified (when selected on SO or derived from SO Shipment.Ship To Address Id).
-
FulfillmentGeographyName: string
Name of the fulfillment geography.
-
HeaderId: integer
(int64)
Header Id.
-
InternalOrganizationLocationId: integer
(int64)
Indicates the internal organziation location ID.
-
LedgerId: integer
(int64)
Indicates the ledger ID.
-
LedgerName: string
Name of the ledger.
-
OverrideCurrencyCode: string
If AllowCurrencyOverrideFlag is set to Y on the strategy, OverrideCurrencyCode will replace the AppliedCurrencyCode. If AllowCurrencyOverrideFlag is set to N on the strategy, this value will not be used to replace the AppliedCurrencyCode.
-
PopulateCoverageLineChargesFlag: boolean
Contains True or False. The default value is false. True: populate charges that belong to the coverage on a coverage line and not create roll-up coverage charges. False: populate charges that belong to the coverage on a coverage association and create roll-up coverage charges on the coverage line.
-
PriceAsOf: string
Price as of date.
-
PricedOn: string
The date when the document is priced. This attribute will be populated with the system date at the beginning of a pricing process.
-
PriceValidFrom: string
Price valid from date.
-
PriceValidUntil: string
Price valid until date.
-
PricingSegmentCode: string
This attribute stores either the pricing segment code passed in from the caller or the pricing segment code derived by the pricing engine.
-
PricingSegmentExplanation: string
Message to state why the Pricing Segment has been applied.
-
PricingStrategyExplanation: string
Message to state why the Pricing Strategy has been applied.
-
PricingStrategyId: integer
(int64)
This attribute stores either the pricing strategy id passed in from the caller or the pricing strategy id derived by the pricing engine.
-
PricingStrategyName: string
The name of the pricing strategy. The caller provides the name or pricing determines the name.
-
RoundingBillToPartyId: integer
(int64)
Indicates the bill to party ID used for rounding in tax calculations.
-
RoundingBillToPartyName: string
Name that identifies the bill-to party to use when rounding a number during a tax calculation.
-
RoundingBillToPartyNumber: string
Number that identifies the bill-to party to use when rounding a number during a tax calculation.
-
RoundingBillToPartySiteId: integer
(int64)
Indicates the bill to party site ID used for rounding in tax calculations.
-
RoundingBillToPartySiteNumber: string
Number that identifies the bill-to party site to use when rounding a number during a tax calculation.
-
RoundingShipToPartyId: integer
(int64)
Indicates the ship to party ID used for rounding in tax calcuations.
-
RoundingShipToPartyName: string
Name that identifies the ship-to party to use when rounding a number during a tax calculation.
-
RoundingShipToPartyNumber: string
Number that identifies the ship-to party to use when rounding a number during a tax calculation.
-
SalesChannelCode: string
Sales Channel code.
-
SalesSubChannelCode: string
The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site.
-
SellingBusinessUnitId: integer
(int64)
Selling business unit id
-
SellingBusinessUnitName: string
Name of the selling business unit.
-
SellingLegalEntityId: integer
(int64)
Selling legal entity id.
-
SellingLegalEntityIdentifier: string
Value that uniquely identifies the selling legal entity that pricing uses for tax calculations.
-
TotalGroupEntityCode: string
Entities for which a Total is calculated.Values of the attribute are from the ORA_QP_TOTAL_ENTITY_TYPES lookup.
-
TotalUsageCode: string
Usage based on which a Total is calculated. Value of the attribute is from the ORA_QP_TOTAL_USAGE_TYPES lookup.
-
TransactionOn: string
This attribute stores the date of the transaction.
-
TransactionTypeCode: string
Indicates the transaction type of the passed in document. Transaction Types include QUOTE, ORDER, etc.
Nested Schema : LineType
Type:
object
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
ActionCode: string
Indicates the action to be performed for the line. Valid values include ORA_ADD, ORA_END, ORA_AMEND and so on. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES.
-
AllowCurrencyOverrideFlag: boolean
Indicate whether the currency can be overridden.
-
AllowPriceListUpdateFlag: boolean
Indicate whether a previously selected price list can be changed to a different price list.
-
AppliedPriceListId: integer
(int64)
Id of the price list applied.
-
AppliedShippingChargeListId: integer
(int64)
Id of the shipping charge list applied.
-
AssessableValue: object
AssessableValue
-
AssessableValueCurrencyCode: string
Abbreviation that identifies the currency of the assessable value.
-
AssessableValueOverrideFlag: boolean
Indicates whether the user entered a value for attribute AssessableValue. Values include true: user entered a value. false: user didn't enter a value.
-
BillFromLocationAddress1: string
Address line 1 of the bill-from location.
-
BillFromLocationAddress2: string
Address line 2 of the bill-from location.
-
BillFromLocationAddress3: string
Address line 3 of the bill-from location.
-
BillFromLocationAddress4: string
Address line 4 of the bill-from location.
-
BillFromLocationCity: string
City of the bill-from location.
-
BillFromLocationCountry: string
Country of the bill-from location.
-
BillFromLocationCounty: string
County of the bill-from location.
-
BillFromLocationId: integer
(int64)
Indicates the bill from location ID.
-
BillFromLocationPostalCode: string
Postal code of the bill-from location.
-
BillFromLocationProvince: string
Province of the bill-from location.
-
BillFromLocationState: string
State of the bill-from location.
-
BillToLocationAddress1: string
Address line 1 of the bill-to location.
-
BillToLocationAddress2: string
Address line 2 of the bill-to location.
-
BillToLocationAddress3: string
Address line 3 of the bill-to location.
-
BillToLocationAddress4: string
Address line 4 of the bill-to location.
-
BillToLocationCity: string
City of the bill-to location.
-
BillToLocationCountry: string
Country of the bill-to location.
-
BillToLocationCounty: string
County of the bill-to location.
-
BillToLocationId: integer
(int64)
Indicates the bill to location ID.
-
BillToLocationPostalCode: string
Postal code of the bill-to location.
-
BillToLocationProvince: string
Province of the bill-to location.
-
BillToLocationState: string
State of the bill-to location.
-
BillToPartyId: integer
(int64)
Indicates the bill to party ID.
-
BillToPartyName: string
Name that identifies the bill-to party.
-
BillToPartyNumber: string
Number that identifies the bill-to party.
-
BillToPartySiteId: integer
(int64)
indicates the bill to party site ID.
-
BillToPartySiteNumber: string
Number that identifies the bill-to party site.
-
ComponentIdPath: string
Item ID path for component items. Contains the Root Model Inventory Item Id to the immediate parent Inventory Item Id delimited with '>'
-
ComponentPath: string
Item Number path for component items. Contains the Root Model Item Number to the immediate parent Item Number delimited with '>'
-
DefaultCurrencyCode: string
Default currency code for the line. For R11, the Default Currency is determined at the header level for the strategy.
-
DefaultPriceListId: integer
(int64)
Id of the default price list.
-
DefaultTaxationCountry: string
Specifies the country of taxation for tax calculation purposes.
-
DocumentSubType: string
Classification used for both tax calculation and tax reporting depending upon the requirements of different countries.
-
ExemptionControlCode: string
Controls the application of exemptions to the transaction line during tax lines calculation.
-
ExtendedQuantity: object
ExtendedQuantity
-
FinalDischargeLocationId: integer
(int64)
Indicates the location of the final destination for purchases made by a customer, and is applicable to all transactions at line level.
-
FirstPartyTaxRegistration: string
Tax registration that the first-party organization uses for the transaction.
-
FirstPartyTaxRegistrationId: integer
(int64)
Indicates the tax registration that the first party organization used for a transaction.
-
FOBCode: string
Code that indicates freight on board.
-
FulfillmentGeographyId: integer
(int64)
This attribute represents the geography ID of the fulfillment.
-
HeaderId: integer
(int64)
HeaderId reference for the Line
-
IntendedUseClassificationCode: string
Abbreviation that identifies the classification that describes how the purchaser intends to use the item.
-
IntendedUseClassificationId: integer
(int64)
Indicates the classification purpose for which a product is used in a business by the purchaser.
-
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.
-
LineCategoryCode: string
Identifies the category of the line.
-
LineId: integer
(int64)
Line Id.
-
LineQuantity: object
LineQuantity
-
LineQuantityUOMCode: string
The requested UOM.
-
LineTypeCode: string
This identifies the action performed when the order line is fulfilled.
-
OverrideCurrencyCode: string
If the 'AllowCurrencyOverride' flag is set to be true on the pricing strategy, the value of this attribute will be be used as the default currency for any non-overridden currency on charges and totals.
-
OverridePriceListId: integer
(int64)
If allowed by pricing, this is the price list that user selects to override the price to for a particular line item.
-
OverridePriceListName: string
Name of the price list the user selects to override the price for a line item. Pricing uses this attribute only if a price list override is allowed.
-
PerModelUnitQuantity: object
PerModelUnitQuantity
-
PooLocationId: integer
(int64)
Indicates the location that initiates or negotiates a sales order for products and services.? This ID represents the Point of Order Origin location.
-
PooPartyId: integer
(int64)
Indicates the party that initiates or negotiates a sales order for products and services. This ID represents the Point of Order Origin party identifier.
-
PooPartyName: string
Name that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item.
-
PooPartyNumber: string
Number that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item.
-
PriceAsOf: string
This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
-
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.
-
PriceValidFrom: string
Price valid from date.
-
PriceValidUntil: string
Price valid until date.
-
PricingStrategyId: integer
(int64)
Id of the pricing strategy applied on this line
-
PricingStrategyName: string
Name of the pricing strategy that pricing applied on this line.
-
ProductCategory: string
Classification of products as product categories for tax purposes.
-
ProductFiscalClassificationId: integer
(int64)
Classification of products based on the inventory item category for tax purposes.
-
ProductType: string
Classification of products as product types for tax purposes.
-
ReferenceLineId: integer
(int64)
Indicates the order line to be used as reference in returns pricing processing.
-
ReturnReasonCode: string
Indicates the return reason code.
-
RootCoverageLineId: integer
(int64)
Indicates the root coverage line in the hierarchy.
-
RootLineId: integer
(int64)
Top most root line Id.
-
RoundingBillToPartyId: integer
(int64)
Indicates the rounding bill to party ID.
-
RoundingBillToPartyName: string
Name that identifies the rounding bill-to party.
-
RoundingBillToPartyNumber: string
Number that identifies the rounding bill-to party.
-
RoundingShipToPartyId: integer
(int64)
Indicates the rounding ship to party ID.
-
RoundingShipToPartyName: string
Name that identifies the rounding ship-to party.
-
RoundingShipToPartyNumber: string
Number that identifies the rounding ship-to party.
-
ServiceDuration: object
ServiceDuration
-
ServiceDurationPeriodCode: string
Service duration period code.
-
ServiceEndDate: string
Date when the service ends. This date applies to each item that is defined with the Sales Product Type as Installation, Subscription, and so on, and where the Service Duration Type is Fixed, Variable, or Open Ended.
-
ServiceStartDate: string
Date when the service starts. This date applies to each item that is defined with the Sales Product Type as Installation, Subscription, and so on, and where the Service Duration Type is Fixed, Variable, or Open Ended.
-
ShipFromLocationAddress1: string
Address line 1 of the ship-from location.
-
ShipFromLocationAddress2: string
Address line 2 of the ship-from location.
-
ShipFromLocationAddress3: string
Address line 3 of the ship-from location.
-
ShipFromLocationAddress4: string
Address line 4 of the ship-from location.
-
ShipFromLocationCity: string
City of the ship-from location.
-
ShipFromLocationCountry: string
Country of the ship-from location.
-
ShipFromLocationCounty: string
County of the ship-from location.
-
ShipFromLocationId: integer
(int64)
Indicates the ship from location ID.
-
ShipFromLocationPostalCode: string
Postal code of the ship-from location.
-
ShipFromLocationProvince: string
Province of the ship-from location.
-
ShipFromLocationState: string
State of the ship-from location.
-
ShipFromOrganizationCode: string
Organization from where logistics ships the goods.
-
ShipFromOrganizationId: integer
(int64)
Organization from where the goods are shipped.
-
ShipFromPartyId: integer
(int64)
Indicates the ship from party ID.
-
ShipFromPartyName: string
Name that identifies the ship-from party.
-
ShipFromPartyNumber: string
Number that identifies the ship-from party.
-
ShipFromPartySiteId: integer
(int64)
Indicates the ship from party site ID.
-
ShipFromPartySiteNumber: string
Number that identifies the ship-from party site.
-
ShipMethodCode: string
Abbreviation that identifies the shipping method, such as overnight. Logistics uses this method to transfer goods from one destination to another destination.
-
ShipMethodId: integer
(int64)
The shipping method such as UPS-Parcel-Ground used for transfer of goods from one destination to another.
-
ShipSetName: string
Group of sales order lines that need to ship together from their common origin to a common destination.
-
ShipToLocationAddress1: string
Address line 1 of the ship-to location.
-
ShipToLocationAddress2: string
Address line 2 of the ship-to location.
-
ShipToLocationAddress3: string
Address line 3 of the ship-to location.
-
ShipToLocationAddress4: string
Address line 4 of the ship-to location.
-
ShipToLocationCity: string
City of the ship-to location.
-
ShipToLocationCountry: string
Country of the ship-to location.
-
ShipToLocationCounty: string
County of the ship-to location.
-
ShipToLocationId: integer
(int64)
indicates the ship to location ID.
-
ShipToLocationPostalCode: string
Postal code of the ship-to location.
-
ShipToLocationProvince: string
Province of the ship-to location.
-
ShipToLocationState: string
State of the ship-to location.
-
ShipToPartyId: integer
(int64)
Indicates the ship to party ID.
-
ShipToPartyName: string
Name that identifies the ship-to party.
-
ShipToPartyNumber: string
Number that identifies the ship-to party.
-
ShipToPartySiteId: integer
(int64)
Indicates the ship to party site ID.
-
ShipToPartySiteNumber: string
Number that identifies the ship-to party site.
-
ShipToSiteUseId: integer
(int64)
Address of the person or organization party where the goods are being sent.
-
SkipShippingChargesFlag: boolean
Determines whether or not to evaluate line level shipping-related charges. Value is either true or false (default).
-
TaxClassificationCode: string
Indicates the tax codes or groups defined in Fusion Payables.
-
TaxExemptionCertificateNumber: string
Number that uniquely identifies the certificate number for tax exemption. You can use it with the Tax Exemption Reason Code to handle tax exemption.
-
TaxExemptionReasonCode: string
Abbreviation that identifies the tax exemption reason.? You can use it with the Tax Exemption Certificate Number to handle tax exemption.
-
ThirdPartyTaxRegistrationId: integer
(int64)
Indicates the Tax Registration Number used by the third party involved in the transaction.
-
ThirdPartyTaxRegistrationNumber: string
Tax registration that the third-party organization uses for the transaction.
-
TradingHQLocationAddress1: string
Address line 1 of the trading headquarters location.
-
TradingHQLocationAddress2: string
Address line 2 of the trading headquarters location.
-
TradingHQLocationAddress3: string
Address line 3 of the trading headquarters location.
-
TradingHQLocationAddress4: string
Address line 4 of the trading headquarters location.
-
TradingHQLocationCity: string
City of the trading headquarters location.
-
TradingHQLocationCountry: string
Country of the trading headquarters location.
-
TradingHQLocationCounty: string
County of the trading headquarters location.
-
TradingHQLocationId: integer
(int64)
indicates the trading HQ location ID.
-
TradingHQLocationPostalCode: string
Postal code of the trading headquarters location.
-
TradingHQLocationProvince: string
Province of the trading headquarters location.
-
TradingHQLocationState: string
State of the trading headquarters location.
-
TradingHQPartySiteId: integer
(int64)
indicates the trading HQ party site ID.
-
TradingHQPartySiteNumber: string
Number that identifies the site where the trading headquarters party resides.
-
TransactionBusinessCategory: string
Classifies a transaction for tax purposes, as required by a tax authority.
-
TransactionOn: string
This attribute stores the date of the transaction.
-
UserDefinedFiscalClassificationCode: string
Additional classification of a transaction for tax purpose, as required by a tax authority.
Nested Schema : AssessableValue
Type:
Show Source
object
-
CurrencyCode: string
Currency code of the assessable value.
-
Value: number
The taxable amount in the currency that the sales order uses. The value is either the list price, or the net price, or a value that the user enters. The value is an extended amount.
Nested Schema : ExtendedQuantity
Type:
Show Source
object
-
UomCode: string
Rolled-up quantity of CP. This is the same as the line requested quantity for simple products, but is a product of the requested quantity of the component and its ancestors for a configurable product component.
-
Value: number
Rolled-up quantity of CP. This is the same as the line requested quantity for simple products, but is a product of the requested quantity of the component and its ancestors for a configurable product component.
Nested Schema : LineQuantity
Type:
Show Source
object
-
UomCode: string
Quantity requested to be priced. In the case of a CP component, the RequestedQuantity should be a relative quantity. In the case of simple products, value of RequestedQuantity equals the value of ExtendedQuantity.
-
Value: number
Quantity requested to be priced. In the case of a CP component, the RequestedQuantity should be a relative quantity. In the case of simple products, value of RequestedQuantity equals the value of ExtendedQuantity.
Nested Schema : PerModelUnitQuantity
Type:
Show Source
object
-
UomCode: string
Indicates the unit quantity per root model for the lines of a configuration.
-
Value: number
Indicates the unit quantity per root model for the lines of a configuration.
Nested Schema : ServiceDuration
Type:
Show Source
object
-
UomCode: string
UOM code of service duration.
-
Value: number
Duration for the service.
Nested Schema : LineAttributeType
Type:
object
Values that store the transaction item attributes. This attribute is used only for input.
Show Source
-
AttributeId: integer
(int64)
Value that uniquely identifies the transactional item attribute.
-
AttributeValue: string
Attribute value. (Obsolete).
-
DataTypeCode: string
Abbreviation that identifies the data type of the transactional item attribute. Valid values include N for number, S for character, D for date, or T for date and time.
-
DateValue: string
Value of the transactional item attribute when the datatype is Date.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
InternalName: string
Internal name of the transactional item attribute.
-
LineAttributeId: integer
(int64)
Value that uniquely identifies line attribute.
-
LineId: integer
(int64)
Value that uniquely identifies line.
-
NumberValue: number
Value of the transactional item attribute when the datatype is Number and the validation type is Format Only. If the validation type is Dependent or Independent, then NumberValue represents the nontranslated ValueCode of the value set member.
-
TimestampValue: string
Value of the transactional item attribute when the datatype is Timestamp.
-
VarcharValue: string
Value of the transactional item attribute when the datatype is Character and the validation type is Format Only. If the validation type is Dependent or Independent, then VarcharValue represents the nontranslated ValueCode of the value set member.
Nested Schema : PriceValidationType
Type:
object
This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.
Show Source
-
ChargeDefinitionCode: string
The unique code of a pricing charge definition.
-
ChargeId: integer
(int64)
The source application charge ID of the charge component being validated.
-
ConstrainingUnitPrice: object
ConstrainingUnitPrice
-
ConstrainingValue: number
The constraining value for percentage-based or amount-based guidelines.
-
ConstrainingValueCurrencyCode: string
The currency code for the constraining value
-
ConstrainingValueType: string
The type of a constraining value,such as percentage based or amount based.
-
Explanation: string
The explanation message that provides details of a validation.
-
ExplanationMessageName: string
The name of an explanation message.
-
HeaderCurrencyCode: string
Indicates the header currency
-
HeaderCurrencyConstrainingAmount: object
HeaderCurrencyConstrainingAmount
-
ManualPriceAdjustmentId: integer
(int64)
The ID of a manual price adjustment associated with a parent entity.
-
ParentEntityCode: string
The parent entity code to which a price validation record belongs.
-
ParentEntityId: integer
(int64)
The parent entity ID to which a price validation record belongs.
-
PricePeriodicityCode: string
The periodicity of the Recurring and Recurring Usage price types.
-
PriceValidationId: integer
(int64)
The primary key of the SDO record.
-
RollupFlag: boolean
Indicates whether a validation is for a rolled-up charge.
-
ValidationComponentCode: string
The charge component or total against which the guideline is evaluated.
-
ValidationComponentEntityId: integer
(int64)
The charge component ID or total ID against which the guideline is evaluated.
-
ValidationComponentEntityType: string
The type of component entity against which the guideline is evaluated- Charge Component or Total
-
ValidationSourceRuleId: integer
(int64)
The ID of a source rule evaluated for a price validation record.
-
ValidationSourceTypeCode: string
The source type of a price validation record. Values include Charge Guideline, Total Guideline, Floor Price, and GSA Price.
-
ValidationStatus: string
Indicates whether a price validation has failed or passed.
-
ViolationTypeCode: string
The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATIONS_TYPES
Nested Schema : ConstrainingUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Currency the constraining value is in.
-
Value: number
The unit price of the constraining value.
Nested Schema : HeaderCurrencyConstrainingAmount
Type:
Show Source
object
-
CurrencyCode: string
The constraining value calculated for the ValidationComponentCode attribute.
-
Value: number
The constraining value calculated for the ValidationComponentCode attribute.
Nested Schema : PriceViolationType
Type:
object
This entity is an output from Pricing. It stores the guidelines violated in the pricing process.
Show Source
-
Explanation: string
Explanation message for the violation
-
GuidelineRuleId: integer
(int64)
Id of the guideline that caused the violation record.
-
ParentEntityCode: string
The parent entity type code of the record that caused the violation. Value is CHARGE_COMPONENT
-
ParentEntityId: integer
(int64)
The Id of the SDO record that caused the violation.
-
PriceViolationId: integer
(int64)
Id of the PriceViolation SDO entity.
-
PriceViolationTypeCode: string
This attribute indicates the violation type. Values include: ALERT, APPROVAL_REQUIRED, REJECTED
-
ValidationTypeCode: string
The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATION_TYPES.
Nested Schema : PricingMessageType
Type:
object
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
MessageName: string
Name of the error message.
-
MessageSourceCode: string
Abbreviation that indicates the source of the 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 MESSAGE_TYPE.
-
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)
The unique key of this error.
Nested Schema : PricingServiceParameterType
Type:
object
This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.
Show Source
-
OutputStatus: string
Value that indicates the output status. Values include Success or Error.
-
PerformValueIdConversionsFlag: boolean
Contains one of the following values: true or false. If true, then convert value to identifier or convert identifier to value. If false, then do not convert. The default value is false.
-
PopulateCoverageLineChargesFlag: boolean
Contains one of the following values: true or false. If true, then populate the charges for coverage line. If false, then do not populate the charges for coverage line. The default value is false.
-
PricingContext: string
Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.
-
ProcessingMessage: string
Message generated for the transaction when the output status is set to Error.
-
ValidationLevel: string
Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only.
-
ValidationMode: string
Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only.
Response
Supported Media Types
- application/json
200 Response
Sales Prices Validated successfully.
Root Schema : schema
Type:
Show Source
object
-
ChangeSummary: array
ChangeSummary
-
Charge: array
Charge
-
ChargeComponent: array
ChargeComponent
-
Header: array
Header
-
Line: array
Line
-
LineAttribute: array
LineAttribute
-
PriceValidation: array
PriceValidation
-
PriceViolation: array
PriceViolation
-
PricingMessage: array
PricingMessage
-
PricingServiceParameter: array
PricingServiceParameter
Nested Schema : ChangeSummary
Type:
Show Source
array
-
Array of:
object ChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
Show Source
array
-
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:
Show Source
array
-
Array of:
object ChargeComponentType
Stores the price elements for each charge applied within the pricing process.
Nested Schema : Header
Type:
Show Source
array
-
Array of:
object HeaderType
Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
Nested Schema : Line
Type:
Show Source
array
-
Array of:
object LineType
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Nested Schema : LineAttribute
Type:
Show Source
array
-
Array of:
object LineAttributeType
Values that store the transaction item attributes. This attribute is used only for input.
Nested Schema : PriceValidation
Type:
Show Source
array
-
Array of:
object PriceValidationType
This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.
Nested Schema : PriceViolation
Type:
Show Source
array
-
Array of:
object PriceViolationType
This entity is an output from Pricing. It stores the guidelines violated in the pricing process.
Nested Schema : PricingMessage
Type:
Show Source
array
-
Array of:
object PricingMessageType
This entity contains one instance for each pricing error found on the transaction.
Nested Schema : PricingServiceParameter
Type:
Show Source
array
-
Array of:
object PricingServiceParameterType
This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.
Nested Schema : ChangeSummaryType
Type:
object
Values that store the summary of the changes.
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.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationUOMCode: string
Indicates the coverage duration unit of measure used to calculate the coverage extended amount that applies to a coverage association.
-
CurrencyCode: string
Indicates the currency used in the charge
-
EstimatedPricedQuantityFlag: boolean
This attribute indicates whether the priced quantity is an estimated number.
-
EstimatedUnitPriceFlag: boolean
This attribute indicates whether the unit price is an estimated number.
-
FloorUnitPrice: object
FloorUnitPrice
-
GSAUnitPrice: object
GSAUnitPrice
-
LineId: integer
(int64)
Indicates the Line ID of the parent line of a charge.
-
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
UOM code for priced quantity, for example 'Ton'. Values for this attribute will come either from PIM or the reciprocal service QOC provides.
-
PricePeriodicityCode: string
Indidates periodicty for both recurring and recurring usage price types
-
PriceTypeCode: string
Price type of a given charge.
-
PrimaryFlag: boolean
Indicates whether this charge is the primary charge.
-
RollupFlag: boolean
Marks a charge as a rollup/aggregate charge.
-
SequenceNumber: integer
(int64)
The value of this attribute indicates the sequence number for the charge.
-
SourceChargeId: integer
(int64)
Indicates the ID of a source charge created by an external pricing engine.
-
TaxIncludedFlag: boolean
Indicates whether the charge includes tax.
-
UsagePeriodCode: string
Usage period code for the estimated usage quantity.
-
UsageUOMCode: string
Usage uom code for the estimated usage quantity.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
UOM code of the coverage duration.
-
Value: number
Indicates the coverage duration of a charge that applies to a coverage association.
Nested Schema : FloorUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Unit price amount derived from a matching floor price list on the strategy for the current transaction.
-
Value: number
Unit price amount derived from a matching floor price list on the strategy for the current transaction.
Nested Schema : GSAUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Unit price amount derived from a matching GSA price list on the strategy for the current transaction.
-
Value: number
Unit price amount derived from a matching GSA price list on the strategy for the current transaction.
Nested Schema : PricedQuantity
Type:
Show Source
object
-
UomCode: string
If price type equals usage or recurring usage, -If "IsPerUnitUsage? = TRUE, pricedQuantity = Estimated Usage Quantity * Line.Requested Quantity for simple products, pricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP -If ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity If price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP
-
Value: number
If price type equals usage or recurring usage, -If "IsPerUnitUsage? = TRUE, pricedQuantity = Estimated Usage Quantity * Line.Requested Quantity for simple products, pricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP -If ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity If price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP
Nested Schema : ChargeComponentType
Type:
object
Stores the price elements for each charge applied within the pricing process.
Show Source
-
AggregateChargeComponentId: integer
(int64)
Indicates the reference to the ID of an aggregate charge component on the roll-up charge. The ID is used to model a many-to-one relationship between the charge components of a native charge and the roll-up charge.
-
ChargeComponentId: integer
(int64)
Charge Component Id
-
ChargeId: integer
(int64)
chargeId on which price/adjustment applied to
-
CoverageExtendedAmount: object
CoverageExtendedAmount
-
CurrencyCode: string
Indicates the currency used in the charge component. Needed due to service standardization.
-
Explanation: string
Message for display in a price breakdown or PWF UI.
-
ExplanationMessageName: string
The name of an explanation message.
-
ExtendedAmount: object
ExtendedAmount
-
HeaderCurrencyCode: string
Indicates the header currency. Needed due to service standardization.
-
HeaderCurrencyCoverageExtendedAmount: object
HeaderCurrencyCoverageExtendedAmount
-
HeaderCurrencyExtendedAmount: object
HeaderCurrencyExtendedAmount
-
HeaderCurrencyUnitPrice: object
HeaderCurrencyUnitPrice
-
PercentOfComparisonElement: number
The percentage that this unit price is of the basis charge component unit price. By default the basis is the List Price. This attribute captures the Margin %, the % the Net Price is of the List Price etc.
-
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.
-
RollupFlag: boolean
Marks a charge component as a rollup/aggregate value for the charge component price element code.
-
SequenceNumber: integer
(int64)
Sequence number for the charge component.
-
SourceChargeComponentId: string
Indicates the ID of a source charge component created by an external pricing engine.
-
SourceChargeId: string
Indicates the ID of a source charge created by an external pricing engine.
-
SourceId: integer
(int64)
Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.
-
SourceParentChargeComponentId: string
Indicates the ID of a source parent charge component created by an external pricing engine.
-
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.
-
TaxIncludedFlag: boolean
Indicates whether a tax is included for a given charge component.
-
UnitPrice: object
UnitPrice
Nested Schema : CoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Indicates the coverage extended amount used for the entire service duration of a coverage association.
-
Value: number
Indicates the coverage extended amount used for the entire service duration of a coverage association.
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 : HeaderCurrencyCoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association.
-
Value: number
Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association.
Nested Schema : HeaderCurrencyExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
The currency of header.
-
Value: number
This attribute indicates the extended amount in header currency
Nested Schema : HeaderCurrencyUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
This attribute indicates the unit price in header currency
-
Value: number
This attribute indicates the unit price in header currency
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 : HeaderType
Type:
object
Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
Show Source
-
AllowCurrencyOverrideFlag: boolean
Indicate whether the currency can be overridden.
-
AppliedCurrencyCode: string
Currency code to be used as the default header currency.
-
BillingThirdPartyAccountId: integer
(int64)
Indicates the billing third-party account ID, used in tax calculations.
-
BillingThirdPartyAccountName: string
Name of the third-party account that pricing uses in tax calculations for billing.
-
BillingThirdPartyAccountNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillingThirdPartyAccountSiteId: integer
(int64)
Indicates the billing third-party account site ID, used in tax calculations.
-
BillingThirdPartyAccountSiteNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillToCustomerAccountSiteUseId: integer
(int64)
Indicates the bill to customer account site use ID, used in tax calculations.
-
CalculatePricingChargesFlag: boolean
Determines whether or not to price charges for a line item. Value is true (default) or false.
-
CalculateShippingChargesFlag: boolean
Determines whether or not to evaluate shipping-related charges for the document. Value is either true (default) or false.
-
CalculateTaxFlag: boolean
Determines whether or not to call Fusion Tax to derive tax amounts for the lines on the document. Value is either 'Y' (default) or 'N'.
-
CustomerId: integer
(int64)
Sold To Customer Id.
-
CustomerName: string
The Party Name in Customer Data Management provides this name.
-
CustomerNumber: string
The Party Number in Customer Data Management provides this number.
-
CustomerTypeCode: string
Indicates whether customer is internal or external.
-
DefaultCurrencyCode: string
The purpose of this is to retain the original currency returned for the strategy.
-
EndCustomerId: integer
(int64)
Id of the customer who receives the item.
-
EndCustomerName: string
Name of the customer who receives the item. The Party Name in Customer Data Management provides this name.
-
EndCustomerNumber: string
Number that identifies the customer who receives the item. The Party Number in Customer Data Management provides this number.
-
FulfillmentGeographyId: integer
(int64)
This will be either null (initially), or specified (when selected on SO or derived from SO Shipment.Ship To Address Id).
-
FulfillmentGeographyName: string
Name of the fulfillment geography.
-
HeaderId: integer
(int64)
Header Id.
-
InternalOrganizationLocationId: integer
(int64)
Indicates the internal organziation location ID.
-
LedgerId: integer
(int64)
Indicates the ledger ID.
-
LedgerName: string
Name of the ledger.
-
OverrideCurrencyCode: string
If AllowCurrencyOverrideFlag is set to Y on the strategy, OverrideCurrencyCode will replace the AppliedCurrencyCode. If AllowCurrencyOverrideFlag is set to N on the strategy, this value will not be used to replace the AppliedCurrencyCode.
-
PopulateCoverageLineChargesFlag: boolean
Contains True or False. The default value is false. True: populate charges that belong to the coverage on a coverage line and not create roll-up coverage charges. False: populate charges that belong to the coverage on a coverage association and create roll-up coverage charges on the coverage line.
-
PriceAsOf: string
Price as of date.
-
PricedOn: string
The date when the document is priced. This attribute will be populated with the system date at the beginning of a pricing process.
-
PriceValidFrom: string
Price valid from date.
-
PriceValidUntil: string
Price valid until date.
-
PricingSegmentCode: string
This attribute stores either the pricing segment code passed in from the caller or the pricing segment code derived by the pricing engine.
-
PricingSegmentExplanation: string
Message to state why the Pricing Segment has been applied.
-
PricingStrategyExplanation: string
Message to state why the Pricing Strategy has been applied.
-
PricingStrategyId: integer
(int64)
This attribute stores either the pricing strategy id passed in from the caller or the pricing strategy id derived by the pricing engine.
-
PricingStrategyName: string
The name of the pricing strategy. The caller provides the name or pricing determines the name.
-
RoundingBillToPartyId: integer
(int64)
Indicates the bill to party ID used for rounding in tax calculations.
-
RoundingBillToPartyName: string
Name that identifies the bill-to party to use when rounding a number during a tax calculation.
-
RoundingBillToPartyNumber: string
Number that identifies the bill-to party to use when rounding a number during a tax calculation.
-
RoundingBillToPartySiteId: integer
(int64)
Indicates the bill to party site ID used for rounding in tax calculations.
-
RoundingBillToPartySiteNumber: string
Number that identifies the bill-to party site to use when rounding a number during a tax calculation.
-
RoundingShipToPartyId: integer
(int64)
Indicates the ship to party ID used for rounding in tax calcuations.
-
RoundingShipToPartyName: string
Name that identifies the ship-to party to use when rounding a number during a tax calculation.
-
RoundingShipToPartyNumber: string
Number that identifies the ship-to party to use when rounding a number during a tax calculation.
-
SalesChannelCode: string
Sales Channel code.
-
SalesSubChannelCode: string
The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site.
-
SellingBusinessUnitId: integer
(int64)
Selling business unit id
-
SellingBusinessUnitName: string
Name of the selling business unit.
-
SellingLegalEntityId: integer
(int64)
Selling legal entity id.
-
SellingLegalEntityIdentifier: string
Value that uniquely identifies the selling legal entity that pricing uses for tax calculations.
-
TotalGroupEntityCode: string
Entities for which a Total is calculated.Values of the attribute are from the ORA_QP_TOTAL_ENTITY_TYPES lookup.
-
TotalUsageCode: string
Usage based on which a Total is calculated. Value of the attribute is from the ORA_QP_TOTAL_USAGE_TYPES lookup.
-
TransactionOn: string
This attribute stores the date of the transaction.
-
TransactionTypeCode: string
Indicates the transaction type of the passed in document. Transaction Types include QUOTE, ORDER, etc.
Nested Schema : LineType
Type:
object
Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
Show Source
-
ActionCode: string
Indicates the action to be performed for the line. Valid values include ORA_ADD, ORA_END, ORA_AMEND and so on. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES.
-
AllowCurrencyOverrideFlag: boolean
Indicate whether the currency can be overridden.
-
AllowPriceListUpdateFlag: boolean
Indicate whether a previously selected price list can be changed to a different price list.
-
AppliedPriceListId: integer
(int64)
Id of the price list applied.
-
AppliedShippingChargeListId: integer
(int64)
Id of the shipping charge list applied.
-
AssessableValue: object
AssessableValue
-
AssessableValueCurrencyCode: string
Abbreviation that identifies the currency of the assessable value.
-
AssessableValueOverrideFlag: boolean
Indicates whether the user entered a value for attribute AssessableValue. Values include true: user entered a value. false: user didn't enter a value.
-
BillFromLocationAddress1: string
Address line 1 of the bill-from location.
-
BillFromLocationAddress2: string
Address line 2 of the bill-from location.
-
BillFromLocationAddress3: string
Address line 3 of the bill-from location.
-
BillFromLocationAddress4: string
Address line 4 of the bill-from location.
-
BillFromLocationCity: string
City of the bill-from location.
-
BillFromLocationCountry: string
Country of the bill-from location.
-
BillFromLocationCounty: string
County of the bill-from location.
-
BillFromLocationId: integer
(int64)
Indicates the bill from location ID.
-
BillFromLocationPostalCode: string
Postal code of the bill-from location.
-
BillFromLocationProvince: string
Province of the bill-from location.
-
BillFromLocationState: string
State of the bill-from location.
-
BillToLocationAddress1: string
Address line 1 of the bill-to location.
-
BillToLocationAddress2: string
Address line 2 of the bill-to location.
-
BillToLocationAddress3: string
Address line 3 of the bill-to location.
-
BillToLocationAddress4: string
Address line 4 of the bill-to location.
-
BillToLocationCity: string
City of the bill-to location.
-
BillToLocationCountry: string
Country of the bill-to location.
-
BillToLocationCounty: string
County of the bill-to location.
-
BillToLocationId: integer
(int64)
Indicates the bill to location ID.
-
BillToLocationPostalCode: string
Postal code of the bill-to location.
-
BillToLocationProvince: string
Province of the bill-to location.
-
BillToLocationState: string
State of the bill-to location.
-
BillToPartyId: integer
(int64)
Indicates the bill to party ID.
-
BillToPartyName: string
Name that identifies the bill-to party.
-
BillToPartyNumber: string
Number that identifies the bill-to party.
-
BillToPartySiteId: integer
(int64)
indicates the bill to party site ID.
-
BillToPartySiteNumber: string
Number that identifies the bill-to party site.
-
ComponentIdPath: string
Item ID path for component items. Contains the Root Model Inventory Item Id to the immediate parent Inventory Item Id delimited with '>'
-
ComponentPath: string
Item Number path for component items. Contains the Root Model Item Number to the immediate parent Item Number delimited with '>'
-
DefaultCurrencyCode: string
Default currency code for the line. For R11, the Default Currency is determined at the header level for the strategy.
-
DefaultPriceListId: integer
(int64)
Id of the default price list.
-
DefaultTaxationCountry: string
Specifies the country of taxation for tax calculation purposes.
-
DocumentSubType: string
Classification used for both tax calculation and tax reporting depending upon the requirements of different countries.
-
ExemptionControlCode: string
Controls the application of exemptions to the transaction line during tax lines calculation.
-
ExtendedQuantity: object
ExtendedQuantity
-
FinalDischargeLocationId: integer
(int64)
Indicates the location of the final destination for purchases made by a customer, and is applicable to all transactions at line level.
-
FirstPartyTaxRegistration: string
Tax registration that the first-party organization uses for the transaction.
-
FirstPartyTaxRegistrationId: integer
(int64)
Indicates the tax registration that the first party organization used for a transaction.
-
FOBCode: string
Code that indicates freight on board.
-
FulfillmentGeographyId: integer
(int64)
This attribute represents the geography ID of the fulfillment.
-
HeaderId: integer
(int64)
HeaderId reference for the Line
-
IntendedUseClassificationCode: string
Abbreviation that identifies the classification that describes how the purchaser intends to use the item.
-
IntendedUseClassificationId: integer
(int64)
Indicates the classification purpose for which a product is used in a business by the purchaser.
-
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.
-
LineCategoryCode: string
Identifies the category of the line.
-
LineId: integer
(int64)
Line Id.
-
LineQuantity: object
LineQuantity
-
LineQuantityUOMCode: string
The requested UOM.
-
LineTypeCode: string
This identifies the action performed when the order line is fulfilled.
-
OverrideCurrencyCode: string
If the 'AllowCurrencyOverride' flag is set to be true on the pricing strategy, the value of this attribute will be be used as the default currency for any non-overridden currency on charges and totals.
-
OverridePriceListId: integer
(int64)
If allowed by pricing, this is the price list that user selects to override the price to for a particular line item.
-
OverridePriceListName: string
Name of the price list the user selects to override the price for a line item. Pricing uses this attribute only if a price list override is allowed.
-
PerModelUnitQuantity: object
PerModelUnitQuantity
-
PooLocationId: integer
(int64)
Indicates the location that initiates or negotiates a sales order for products and services.? This ID represents the Point of Order Origin location.
-
PooPartyId: integer
(int64)
Indicates the party that initiates or negotiates a sales order for products and services. This ID represents the Point of Order Origin party identifier.
-
PooPartyName: string
Name that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item.
-
PooPartyNumber: string
Number that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item.
-
PriceAsOf: string
This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
-
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.
-
PriceValidFrom: string
Price valid from date.
-
PriceValidUntil: string
Price valid until date.
-
PricingStrategyId: integer
(int64)
Id of the pricing strategy applied on this line
-
PricingStrategyName: string
Name of the pricing strategy that pricing applied on this line.
-
ProductCategory: string
Classification of products as product categories for tax purposes.
-
ProductFiscalClassificationId: integer
(int64)
Classification of products based on the inventory item category for tax purposes.
-
ProductType: string
Classification of products as product types for tax purposes.
-
ReferenceLineId: integer
(int64)
Indicates the order line to be used as reference in returns pricing processing.
-
ReturnReasonCode: string
Indicates the return reason code.
-
RootCoverageLineId: integer
(int64)
Indicates the root coverage line in the hierarchy.
-
RootLineId: integer
(int64)
Top most root line Id.
-
RoundingBillToPartyId: integer
(int64)
Indicates the rounding bill to party ID.
-
RoundingBillToPartyName: string
Name that identifies the rounding bill-to party.
-
RoundingBillToPartyNumber: string
Number that identifies the rounding bill-to party.
-
RoundingShipToPartyId: integer
(int64)
Indicates the rounding ship to party ID.
-
RoundingShipToPartyName: string
Name that identifies the rounding ship-to party.
-
RoundingShipToPartyNumber: string
Number that identifies the rounding ship-to party.
-
ServiceDuration: object
ServiceDuration
-
ServiceDurationPeriodCode: string
Service duration period code.
-
ServiceEndDate: string
Date when the service ends. This date applies to each item that is defined with the Sales Product Type as Installation, Subscription, and so on, and where the Service Duration Type is Fixed, Variable, or Open Ended.
-
ServiceStartDate: string
Date when the service starts. This date applies to each item that is defined with the Sales Product Type as Installation, Subscription, and so on, and where the Service Duration Type is Fixed, Variable, or Open Ended.
-
ShipFromLocationAddress1: string
Address line 1 of the ship-from location.
-
ShipFromLocationAddress2: string
Address line 2 of the ship-from location.
-
ShipFromLocationAddress3: string
Address line 3 of the ship-from location.
-
ShipFromLocationAddress4: string
Address line 4 of the ship-from location.
-
ShipFromLocationCity: string
City of the ship-from location.
-
ShipFromLocationCountry: string
Country of the ship-from location.
-
ShipFromLocationCounty: string
County of the ship-from location.
-
ShipFromLocationId: integer
(int64)
Indicates the ship from location ID.
-
ShipFromLocationPostalCode: string
Postal code of the ship-from location.
-
ShipFromLocationProvince: string
Province of the ship-from location.
-
ShipFromLocationState: string
State of the ship-from location.
-
ShipFromOrganizationCode: string
Organization from where logistics ships the goods.
-
ShipFromOrganizationId: integer
(int64)
Organization from where the goods are shipped.
-
ShipFromPartyId: integer
(int64)
Indicates the ship from party ID.
-
ShipFromPartyName: string
Name that identifies the ship-from party.
-
ShipFromPartyNumber: string
Number that identifies the ship-from party.
-
ShipFromPartySiteId: integer
(int64)
Indicates the ship from party site ID.
-
ShipFromPartySiteNumber: string
Number that identifies the ship-from party site.
-
ShipMethodCode: string
Abbreviation that identifies the shipping method, such as overnight. Logistics uses this method to transfer goods from one destination to another destination.
-
ShipMethodId: integer
(int64)
The shipping method such as UPS-Parcel-Ground used for transfer of goods from one destination to another.
-
ShipSetName: string
Group of sales order lines that need to ship together from their common origin to a common destination.
-
ShipToLocationAddress1: string
Address line 1 of the ship-to location.
-
ShipToLocationAddress2: string
Address line 2 of the ship-to location.
-
ShipToLocationAddress3: string
Address line 3 of the ship-to location.
-
ShipToLocationAddress4: string
Address line 4 of the ship-to location.
-
ShipToLocationCity: string
City of the ship-to location.
-
ShipToLocationCountry: string
Country of the ship-to location.
-
ShipToLocationCounty: string
County of the ship-to location.
-
ShipToLocationId: integer
(int64)
indicates the ship to location ID.
-
ShipToLocationPostalCode: string
Postal code of the ship-to location.
-
ShipToLocationProvince: string
Province of the ship-to location.
-
ShipToLocationState: string
State of the ship-to location.
-
ShipToPartyId: integer
(int64)
Indicates the ship to party ID.
-
ShipToPartyName: string
Name that identifies the ship-to party.
-
ShipToPartyNumber: string
Number that identifies the ship-to party.
-
ShipToPartySiteId: integer
(int64)
Indicates the ship to party site ID.
-
ShipToPartySiteNumber: string
Number that identifies the ship-to party site.
-
ShipToSiteUseId: integer
(int64)
Address of the person or organization party where the goods are being sent.
-
SkipShippingChargesFlag: boolean
Determines whether or not to evaluate line level shipping-related charges. Value is either true or false (default).
-
TaxClassificationCode: string
Indicates the tax codes or groups defined in Fusion Payables.
-
TaxExemptionCertificateNumber: string
Number that uniquely identifies the certificate number for tax exemption. You can use it with the Tax Exemption Reason Code to handle tax exemption.
-
TaxExemptionReasonCode: string
Abbreviation that identifies the tax exemption reason.? You can use it with the Tax Exemption Certificate Number to handle tax exemption.
-
ThirdPartyTaxRegistrationId: integer
(int64)
Indicates the Tax Registration Number used by the third party involved in the transaction.
-
ThirdPartyTaxRegistrationNumber: string
Tax registration that the third-party organization uses for the transaction.
-
TradingHQLocationAddress1: string
Address line 1 of the trading headquarters location.
-
TradingHQLocationAddress2: string
Address line 2 of the trading headquarters location.
-
TradingHQLocationAddress3: string
Address line 3 of the trading headquarters location.
-
TradingHQLocationAddress4: string
Address line 4 of the trading headquarters location.
-
TradingHQLocationCity: string
City of the trading headquarters location.
-
TradingHQLocationCountry: string
Country of the trading headquarters location.
-
TradingHQLocationCounty: string
County of the trading headquarters location.
-
TradingHQLocationId: integer
(int64)
indicates the trading HQ location ID.
-
TradingHQLocationPostalCode: string
Postal code of the trading headquarters location.
-
TradingHQLocationProvince: string
Province of the trading headquarters location.
-
TradingHQLocationState: string
State of the trading headquarters location.
-
TradingHQPartySiteId: integer
(int64)
indicates the trading HQ party site ID.
-
TradingHQPartySiteNumber: string
Number that identifies the site where the trading headquarters party resides.
-
TransactionBusinessCategory: string
Classifies a transaction for tax purposes, as required by a tax authority.
-
TransactionOn: string
This attribute stores the date of the transaction.
-
UserDefinedFiscalClassificationCode: string
Additional classification of a transaction for tax purpose, as required by a tax authority.
Nested Schema : AssessableValue
Type:
Show Source
object
-
CurrencyCode: string
Currency code of the assessable value.
-
Value: number
The taxable amount in the currency that the sales order uses. The value is either the list price, or the net price, or a value that the user enters. The value is an extended amount.
Nested Schema : ExtendedQuantity
Type:
Show Source
object
-
UomCode: string
Rolled-up quantity of CP. This is the same as the line requested quantity for simple products, but is a product of the requested quantity of the component and its ancestors for a configurable product component.
-
Value: number
Rolled-up quantity of CP. This is the same as the line requested quantity for simple products, but is a product of the requested quantity of the component and its ancestors for a configurable product component.
Nested Schema : LineQuantity
Type:
Show Source
object
-
UomCode: string
Quantity requested to be priced. In the case of a CP component, the RequestedQuantity should be a relative quantity. In the case of simple products, value of RequestedQuantity equals the value of ExtendedQuantity.
-
Value: number
Quantity requested to be priced. In the case of a CP component, the RequestedQuantity should be a relative quantity. In the case of simple products, value of RequestedQuantity equals the value of ExtendedQuantity.
Nested Schema : PerModelUnitQuantity
Type:
Show Source
object
-
UomCode: string
Indicates the unit quantity per root model for the lines of a configuration.
-
Value: number
Indicates the unit quantity per root model for the lines of a configuration.
Nested Schema : ServiceDuration
Type:
Show Source
object
-
UomCode: string
UOM code of service duration.
-
Value: number
Duration for the service.
Nested Schema : LineAttributeType
Type:
object
Values that store the transaction item attributes. This attribute is used only for input.
Show Source
-
AttributeId: integer
(int64)
Value that uniquely identifies the transactional item attribute.
-
AttributeValue: string
Attribute value. (Obsolete).
-
DataTypeCode: string
Abbreviation that identifies the data type of the transactional item attribute. Valid values include N for number, S for character, D for date, or T for date and time.
-
DateValue: string
Value of the transactional item attribute when the datatype is Date.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
InternalName: string
Internal name of the transactional item attribute.
-
LineAttributeId: integer
(int64)
Value that uniquely identifies line attribute.
-
LineId: integer
(int64)
Value that uniquely identifies line.
-
NumberValue: number
Value of the transactional item attribute when the datatype is Number and the validation type is Format Only. If the validation type is Dependent or Independent, then NumberValue represents the nontranslated ValueCode of the value set member.
-
TimestampValue: string
Value of the transactional item attribute when the datatype is Timestamp.
-
VarcharValue: string
Value of the transactional item attribute when the datatype is Character and the validation type is Format Only. If the validation type is Dependent or Independent, then VarcharValue represents the nontranslated ValueCode of the value set member.
Nested Schema : PriceValidationType
Type:
object
This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.
Show Source
-
ChargeDefinitionCode: string
The unique code of a pricing charge definition.
-
ChargeId: integer
(int64)
The source application charge ID of the charge component being validated.
-
ConstrainingUnitPrice: object
ConstrainingUnitPrice
-
ConstrainingValue: number
The constraining value for percentage-based or amount-based guidelines.
-
ConstrainingValueCurrencyCode: string
The currency code for the constraining value
-
ConstrainingValueType: string
The type of a constraining value,such as percentage based or amount based.
-
Explanation: string
The explanation message that provides details of a validation.
-
ExplanationMessageName: string
The name of an explanation message.
-
HeaderCurrencyCode: string
Indicates the header currency
-
HeaderCurrencyConstrainingAmount: object
HeaderCurrencyConstrainingAmount
-
ManualPriceAdjustmentId: integer
(int64)
The ID of a manual price adjustment associated with a parent entity.
-
ParentEntityCode: string
The parent entity code to which a price validation record belongs.
-
ParentEntityId: integer
(int64)
The parent entity ID to which a price validation record belongs.
-
PricePeriodicityCode: string
The periodicity of the Recurring and Recurring Usage price types.
-
PriceValidationId: integer
(int64)
The primary key of the SDO record.
-
RollupFlag: boolean
Indicates whether a validation is for a rolled-up charge.
-
ValidationComponentCode: string
The charge component or total against which the guideline is evaluated.
-
ValidationComponentEntityId: integer
(int64)
The charge component ID or total ID against which the guideline is evaluated.
-
ValidationComponentEntityType: string
The type of component entity against which the guideline is evaluated- Charge Component or Total
-
ValidationSourceRuleId: integer
(int64)
The ID of a source rule evaluated for a price validation record.
-
ValidationSourceTypeCode: string
The source type of a price validation record. Values include Charge Guideline, Total Guideline, Floor Price, and GSA Price.
-
ValidationStatus: string
Indicates whether a price validation has failed or passed.
-
ViolationTypeCode: string
The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATIONS_TYPES
Nested Schema : ConstrainingUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Currency the constraining value is in.
-
Value: number
The unit price of the constraining value.
Nested Schema : HeaderCurrencyConstrainingAmount
Type:
Show Source
object
-
CurrencyCode: string
The constraining value calculated for the ValidationComponentCode attribute.
-
Value: number
The constraining value calculated for the ValidationComponentCode attribute.
Nested Schema : PriceViolationType
Type:
object
This entity is an output from Pricing. It stores the guidelines violated in the pricing process.
Show Source
-
Explanation: string
Explanation message for the violation
-
GuidelineRuleId: integer
(int64)
Id of the guideline that caused the violation record.
-
ParentEntityCode: string
The parent entity type code of the record that caused the violation. Value is CHARGE_COMPONENT
-
ParentEntityId: integer
(int64)
The Id of the SDO record that caused the violation.
-
PriceViolationId: integer
(int64)
Id of the PriceViolation SDO entity.
-
PriceViolationTypeCode: string
This attribute indicates the violation type. Values include: ALERT, APPROVAL_REQUIRED, REJECTED
-
ValidationTypeCode: string
The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATION_TYPES.
Nested Schema : PricingMessageType
Type:
object
This entity contains one instance for each pricing error found on the transaction.
Show Source
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
MessageName: string
Name of the error message.
-
MessageSourceCode: string
Abbreviation that indicates the source of the 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 MESSAGE_TYPE.
-
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)
The unique key of this error.
Nested Schema : PricingServiceParameterType
Type:
object
This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.
Show Source
-
OutputStatus: string
Value that indicates the output status. Values include Success or Error.
-
PerformValueIdConversionsFlag: boolean
Contains one of the following values: true or false. If true, then convert value to identifier or convert identifier to value. If false, then do not convert. The default value is false.
-
PopulateCoverageLineChargesFlag: boolean
Contains one of the following values: true or false. If true, then populate the charges for coverage line. If false, then do not populate the charges for coverage line. The default value is false.
-
PricingContext: string
Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.
-
ProcessingMessage: string
Message generated for the transaction when the output status is set to Error.
-
ValidationLevel: string
Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only.
-
ValidationMode: string
Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only.
400 Response
Invalid input request.