Calculate Sales Totals
post
/fscmRestApi/priceExecution/documentPrices/calculateSalesTotals
Calculate Sales Totals
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
Values that represent a charge calculated within the pricing process or a charge that is passed to Pricing by consuming applications.
-
ChargeComponent: array
ChargeComponent
Values that store the price elements for each charge applied within the pricing process.
-
CoverageAssociation: array
CoverageAssociation
Values that represent the association between a coverage line and its covered item for a service duration.
-
Header: array
Header
Values that represent the sales order or quote header, sales agreement header, or contract header.
-
Line: array
Line
Values that represent the sales order or quote line, sales agreement line, or contract line.
-
PricingMessage: array
PricingMessage
Contains one instance for each pricing error found on the transaction.
-
Total: array
Total
Values that store the calculated pricing total values.
-
TotalComponent: array
TotalComponent
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Nested Schema : ChangeSummary
Type:
array
Values that store the summary of the changes.
Show Source
-
Array of:
object CSTChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
array
Values that represent a charge calculated within the pricing process or a charge that is passed to Pricing by consuming applications.
Show Source
-
Array of:
object CSTChargeType
Values that represent a charge calculated within the pricing process or a charge that is passed to Oracle Pricing Cloud by consuming applications.
Nested Schema : ChargeComponent
Type:
array
Values that store the price elements for each charge applied within the pricing process.
Show Source
-
Array of:
object CSTChargeComponentType
Values that store the price elements for each charge applied within the pricing process.
Nested Schema : CoverageAssociation
Type:
array
Values that represent the association between a coverage line and its covered item for a service duration.
Show Source
-
Array of:
object CSTCoverageAssociationType
Values that represent the association between a coverage line and its covered item for a service duration.
Nested Schema : Header
Type:
array
Values that represent the sales order or quote header, sales agreement header, or contract header.
Show Source
-
Array of:
object CSTHeaderType
Values that represent the sales order or quote header, sales agreement header, or contract header.
Nested Schema : Line
Type:
array
Values that represent the sales order or quote line, sales agreement line, or contract line.
Show Source
-
Array of:
object CSTLineType
Values that represent the sales order or quote line, sales agreement line, or contract line.
Nested Schema : PricingMessage
Type:
array
Contains one instance for each pricing error found on the transaction.
Show Source
-
Array of:
object CSTPricingMessageType
Contains one instance for each pricing error found on the transaction.
Nested Schema : Total
Type:
array
Values that store the calculated pricing total values.
Show Source
-
Array of:
object CSTTotalType
Values that store the calculated pricing total values.
Nested Schema : TotalComponent
Type:
array
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Show Source
-
Array of:
object CSTTotalComponentType
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Nested Schema : CSTChangeSummaryType
Type:
object
Values that store the summary of the changes.
Nested Schema : CSTChargeType
Type:
object
Values that represent a charge calculated within the pricing process or a charge that is passed to Oracle Pricing Cloud by consuming applications.
Show Source
-
CanAdjustFlag: boolean
Contains one of the following values: true or false. If true, then the price can be discounted. If false, then the price cannot be discounted. The default value is false.
-
ChargeAppliesTo: string
Value that indicates the type of charge. Valid values include Price, Return, or Shipping.
-
ChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
ChargeDefinitionId: integer
(int64)
Value that uniquely identifies the charge definition entity.
-
ChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
ChargeSubtypeCode: string
Abbreviation that identifies the subtype of a given charge type.
-
ChargeTypeCode: string
Abbreviation that identifies the type of a given charge.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationUOMCode: string
Abbreviation that indicates the unit of measure of the coverage duration.
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge.
-
EstimatedPricedQuantityFlag: boolean
Contains one of the following values: true or false. If true, then the priced quantity is an estimated number. If false, then the priced quantity is not an estimated number. The default value is false.
-
EstimatedUnitPriceFlag: boolean
Contains one of the following values: true or false. If true, then the unit price is an estimated number. If false, then the unit price is not an estimated number. The default value is false.
-
FloorUnitPrice: object
FloorUnitPrice
-
GSAUnitPrice: object
GSAUnitPrice
-
LineId: integer
(int64)
Number that indicates the order line.
-
ParentEntityCode: string
Value that indicate the parent entity of the charge. Values include Line and Line Coverage.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity of the charge.
-
PricedQuantity: object
PricedQuantity
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
-
PricedQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
PricePeriodicityCode: string
Value that indicates periodicity for both recurring and recurring usage price types.
-
PriceTypeCode: string
Abbreviation that identifies the price type of a given charge.
-
PrimaryFlag: boolean
Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. The default value is false.
-
RollupFlag: boolean
Contains one of the following values: true or false. If true, then mark a charge as a rollup or aggregate charge. If false, then do not mark a charge as a rollup or aggregate charge. The default value is false.
-
SequenceNumber: integer
(int64)
Number that indicates the sequence for the charge.
-
SourceChargeId: integer
(int64)
Value that uniquely identifies the source charge created by an external pricing engine.
-
TaxIncludedFlag: boolean
Contains one of the following values: true or false. If true, then the charge includes tax. If false, then the charge does not include tax. The default value is false.
-
UsagePeriodCode: string
Abbreviation that indicates the period of usage.
-
UsageUOMCode: string
Abbreviation that indicates the unit of measure of usage.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the duration of the coverage.
Nested Schema : FloorUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
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
Abbreviation that identifies the currency.
-
Value: number
Unit price amount derived from a Government Services Administration price list on the strategy for the current transaction.
Nested Schema : PricedQuantity
Type:
object
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
Show Source
-
UomCode: string
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the quantity to be priced.
Nested Schema : CSTChargeComponentType
Type:
object
Values that store the price elements for each charge applied within the pricing process.
Show Source
-
AggregateChargeComponentId: integer
(int64)
Value that uniquely identifies the aggregate charge component on the roll-up charge. This attribute 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)
Value that uniquely identifies the charge component.
-
ChargeId: integer
(int64)
Value that uniquely identifies the charge on which price or adjustment is applied.
-
CoverageExtendedAmount: object
CoverageExtendedAmount
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge component. This attribuite is required for service standardization.
-
Explanation: string
Message that is displayed in a price breakdown or PWF UI. - Venkat
-
ExplanationMessageName: string
Name of the explanation message.
-
ExtendedAmount: object
ExtendedAmount
-
HeaderCurrencyCode: string
Abbreviation that identifies the header currency. This attribute is required to service standardization.
-
HeaderCurrencyCoverageExtendedAmount: object
HeaderCurrencyCoverageExtendedAmount
-
HeaderCurrencyExtendedAmount: object
HeaderCurrencyExtendedAmount
-
HeaderCurrencyUnitPrice: object
HeaderCurrencyUnitPrice
-
PercentOfComparisonElement: number
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, and so on.
-
PriceElementCode: string
Value that identifies the element reference to the price elements setup. For example, LISTPRICE, NETPRICE, and so on.
-
PriceElementUsageCode: string
Value that is used by consuming applications to indicate how the charge component will be used. A list of accepted values is defined in the lookup type QP.
-
RollupFlag: boolean
Contains one of the following values: true or false. If true, then mark a charge component as a rollup or aggregate value for the charge component price element code. If false, then do not mark a charge component as a rollup or aggregate value for the charge component price element code. The default value is false.
-
SequenceNumber: integer
(int64)
Number that identifies the sequence for the charge component.
-
SourceChargeComponentId: string
Value that uniquely identifies the source charge component created by an external pricing engine.
-
SourceChargeId: string
Value that uniquely identifies the source charge created by an external pricing engine.
-
SourceId: integer
(int64)
Value that uniquely identifies the lowest level pricing source; for example, price list line, tier rule, CP rule, formula, AP, shipping line, and so on.
-
SourceParentChargeComponentId: string
Value that uniquely identifies the source of the parent charge component.
-
SourceTypeCode: string
Value that indicates the type of the pricing source; for example, Segment Price List Line, and so on. A list of accepted values is defined in the lookup type QP_ENTITY_TYPES and manually adjusted.
-
TaxIncludedFlag: boolean
Contains one of the following values: true or false. If true, then the tax is included for a given charge component. If false, then the tax is not included for a given charge component. The default value is false.
-
UnitPrice: object
UnitPrice
Nested Schema : CoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Number that indicates the coverage extended amount used for the entire service duration of a coverage association.
Nested Schema : ExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Value that 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 quantity for configurable products. 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
Abbreviation that identifies the currency.
-
Value: number
Number that 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
Abbreviation that identifies the currency.
-
Value: number
Extended amount for the header currency.
Nested Schema : HeaderCurrencyUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Number that indicates the unit price in header currency.
Nested Schema : UnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Value that is the price or adjustment per unit in the charge currency for the line unit of measure.
Nested Schema : CSTCoverageAssociationType
Type:
object
Values that represent the association between a coverage line and its covered item for a service duration.
Show Source
-
ActionCode: string
Abbreviation that identifies the action to be performed for the coverage association.
-
AllowPriceListUpdateFlag: boolean
Contains one of the following values: true or false. If true, then a previously selected price list can be changed to a different price list. If false, then a previously selected price list cannot be changed to a different price list. The default value is false.
-
AppliedPriceListId: integer
(int64)
Value that uniquely identifies the price list applied for the coverage association.
-
AssociationParentLineId: integer
(int64)
Value that uniquely identifies the line that represents the covered item for percentage-based coverage pricing rules.
-
CoverageAssociationId: integer
(int64)
Value that uniquely identifies the coverage association. This value is required.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationEndDate: string
Date when the coverage association ends. This value is required to be sent on the association line.
-
CoverageDurationStartDate: string
Date when the coverage association started. This value is required to be sent on the association line for current logic.
-
CoverageDurationUOMCode: string
Abbreviation that identifies the unit of measure code used to price the coverage association for the coverage duration.
-
CoverageLineId: integer
(int64)
Value that uniquely identifies the line of the coverage item for which coverage association is specified. This is a required attribute.
-
CoveredInventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item of the covered item or covered asset for the coverage association.
-
CoveredInventoryItemNumber: string
Number that indicates the inventory item of the covered item or the covered asset for the coverage association.
-
CoveredItemQuantity: object
CoveredItemQuantity
-
CoveredItemUOMCode: string
Abbreviation that identifies the asset or covered item unit of measure for the coverage association.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency for the coverage association.
-
DefaultPriceListId: integer
(int64)
Value that uniquely identifies the default price list for the coverage association. This is a required attribute.
-
OverridePriceListId: integer
(int64)
Value that uniquely identifies the override price list. If allowed by pricing, refers to the identifier of a price list used to override price for a specific coverage association.
-
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.
-
PriceAsOf: string
Value that is used to compare effectivities on pricing setups. The caller can default header priceAsOf to coverage association.
-
TransactionOn: string
Date when the transaction occurred.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the duration of the coverage.
Nested Schema : CoveredItemQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the asset or covered item quantity covered for the coverage association.
Nested Schema : CSTHeaderType
Type:
object
Values that represent the sales order or quote header, sales agreement header, or contract header.
Show Source
-
AllowCurrencyOverrideFlag: boolean
Contains one of the following values: true or false. If true, then the currency can be overridden. If false, then the currency cannot be overridden. The default value is false.
-
AppliedCurrencyCode: string
Abbreviation that identifies the currency to be used as the default header currency.
-
BillingThirdPartyAccountId: integer
(int64)
Value that uniquely identifies the billing third-party account. This attribute is 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)
Value that uniquely identifies the billing third-party account site. This attribute is used in tax calculations.
-
BillingThirdPartyAccountSiteNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillToCustomerAccountSiteUseId: integer
(int64)
Value that uniquely identifies the bill to customer account site. This attribute is used in tax calculations.
-
CalculatePricingChargesFlag: boolean
Contains one of the following values: true or false. If true, then calculate price charges for a line item. If false, then do not calculate price charges for a line item. The default value is true.
-
CalculateShippingChargesFlag: boolean
Contains one of the following values: true or false. If true, then evaluate shipping-related charges for the document. If false, then do not evaluate shipping-related charges for the document. The default value is true.
-
CalculateTaxFlag: boolean
Contains one of the following values: Y or N. If Y, then call Oracle Fusion Tax to derive tax amounts for the lines on the document. If N, then do not call Oracle Fusion Tax to derive tax amounts for the lines on the document. The default value is Y.
-
CustomerId: integer
(int64)
Value that uniquely identifies the sold-to customer.
-
CustomerName: string
Name of the customer. The Party Name in customer data management provides this name.
-
CustomerNumber: string
Number that identifies the customer. The Party Number in customer data management provides this number.
-
CustomerTypeCode: string
Indicates whether customer is internal or external.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency. This attribute retains the original currency returned for the strategy.
-
EndCustomerId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the fulfillment geography. This value will either be null (initially), or specified (from sales order).
-
FulfillmentGeographyName: string
Name of the fulfillment geography.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
InternalOrganizationLocationId: integer
(int64)
Value that uniquely identifies the internal organization location.
-
LedgerId: integer
(int64)
Value that uniquely identifies the ledger.
-
LedgerName: string
Name of the ledger.
-
OverrideCurrencyCode: string
Abbreviation that identifies the override currency. 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 one of the following values: true or false. If true, then the coverage line charges need to be populated. If false, then the coverage line charges need not be populated. The default value is false.
-
PriceAsOf: string
Value that indicates the price as of date.
-
PricedOn: string
Date when the document is priced. This attribute stores the application date at the beginning of a pricing process.
-
PriceValidFrom: string
Date from when the price is valid.
-
PriceValidUntil: string
Date until when the price is valid.
-
PricingSegmentCode: string
Value that stores either the pricing segment code sent from the caller or the pricing segment code derived by the pricing engine.
-
PricingSegmentExplanation: string
Message that states the reason for applying the pricing segment.
-
PricingStrategyExplanation: string
Message that states the reason for applying the pricing strategy.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy. This attribute stores either the pricing strategy identifier sent from the caller or the pricing strategy identifier derived by the pricing engine.
-
PricingStrategyName: string
Name of the pricing strategy. The caller provides the name or pricing determines the name.
-
RoundingBillToPartyId: integer
(int64)
Value that uniquely identifies the bill-to party 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)
Value that uniquely identifies the bill-to party site 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)
Value that uniquely identifies the ship-to party 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
Abbreviation that indicates the sales channel.
-
SalesSubChannelCode: string
Abbreviation that indicates the subgroup within a channel that initiated the order. For example, for the Web channel this attribute contains the name of the web-site.
-
SellingBusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
SellingBusinessUnitName: string
Name of the selling business unit.
-
SellingLegalEntityId: integer
(int64)
Value that uniquely identifies the selling legal entity.
-
SellingLegalEntityIdentifier: string
Value that uniquely identifies the selling legal entity that pricing uses for tax calculations.
-
TotalGroupEntityCode: string
Abbreviation that indicates the group entity.
-
TotalUsageCode: string
Abbreviation that indicates the total usage.
-
TransactionOn: string
Date when the transaction occurred.
-
TransactionTypeCode: string
Abbreviation that indicates the transaction type, whether it is a quote, an order, and so on. This information is used in determining which pricing process to invoke.
Nested Schema : CSTLineType
Type:
object
Values that represent the sales order or 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
Contains one of the following values: true or false. If true, then currency can be overridden. If false, then currency cannot be overridden. The default value is false.
-
AllowPriceListUpdateFlag: boolean
Contains one of the following values: true or false. If true, then the previously selected price list can be changed to a different price list. If false, then previously selected price list cannot be changed. The default value is false.
-
AppliedPriceListId: integer
(int64)
Value that uniquely identifies the price list applied.
-
AppliedShippingChargeListId: integer
(int64)
Value that uniquely identifies the shipping charge list that pricing 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
First line of the bill-from location address.
-
BillFromLocationAddress2: string
Second line of the bill-from location address.
-
BillFromLocationAddress3: string
Third line of the bill-from location address.
-
BillFromLocationAddress4: string
Fourth line of the bill-from location address.
-
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)
Value that uniquely identifies the bill-from location.
-
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
First line of the bill-to location address.
-
BillToLocationAddress2: string
Second line of the bill-to location address.
-
BillToLocationAddress3: string
Third line of the bill-to location address.
-
BillToLocationAddress4: string
Fourth line of the bill-to location address.
-
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)
Value that uniquely identifies the bill-to location.
-
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)
Value that uniquely identifies the bill-to party.
-
BillToPartyName: string
Name that identifies the bill-to party.
-
BillToPartyNumber: string
Number that identifies the bill-to party.
-
BillToPartySiteId: integer
(int64)
Value that uniquely identifies the bill-to party site.
-
BillToPartySiteNumber: string
Number that identifies the bill-to party site.
-
ComponentIdPath: string
Value that uniquely identifies the hierarchical path of the component items. The attribute value contains the root model item identifier to the immediate parent inventory item identifier separated by the delimiter >.
-
ComponentPath: string
Value that identifies the hierarchical path of the component items. The attribute value contains the root model item to the immediate parent inventory item number separated by the delimiter >.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency code for the line.
-
DefaultPriceListId: integer
(int64)
Value that uniquely identifies the default price list.
-
DefaultTaxationCountry: string
Value that 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
Value that controls the application of exemptions to the transaction line during tax lines calculation.
-
ExtendedQuantity: object
ExtendedQuantity
-
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the tax registration that the first party organization used for a transaction.
-
FOBCode: string
Abbreviation that identifies the freight on board.
-
FulfillmentGeographyId: integer
(int64)
Value that uniquely identifies the fulfillment geography.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header reference for the line.
-
IntendedUseClassificationCode: string
Abbreviation that identifies the classification that describes how the purchaser intends to use the item.
-
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the classification purpose for which a product is used in a business by the purchaser.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item to be priced.
-
InventoryItemNumber: string
Number of the item that pricing must price.
-
InventoryOrganizationCode: string
Abbreviation that identifies the inventory organization that the item number references.
-
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization for the item.
-
LineCategoryCode: string
Abbreviation that identifies the category of the line.
-
LineId: integer
(int64)
Value that uniquely identifies the line.
-
LineQuantity: object
LineQuantity
-
LineQuantityUOMCode: string
Abbreviation that identifies the requested unit of measure.
-
LineTypeCode: string
Abbreviation that identifies the action performed when the order line is fulfilled.
-
OverrideCurrencyCode: string
Abbreviation that identifies the override currency. If the AllowCurrencyOverride flag is set to true on the pricing strategy, the value of this attribute is used as the default currency for any non-overridden currency on charges and totals.
-
OverridePriceListId: integer
(int64)
Value that uniquely identifies the override price list. If allowed by pricing, this is the price list that the 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)
Value that uniquely identifies the location that initiates or negotiates a sales order for products and services. This value represents the point of order origin location.
-
PooPartyId: integer
(int64)
Value that uniquely identifies the party that initiates or negotiates a sales order for products and services. This value represents the point of order origin party identifier.
-
PooPartyName: string
Name of the party where the order originated from.
-
PooPartyNumber: string
Number that identifies the point of order origin party. This party starts or negotiates a sales order for an item.
-
PriceAsOf: string
Value that is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
-
PricedOn: string
Date when the line is priced. This attribute will be populated with the application date at the beginning of a pricing process.
-
PriceValidFrom: string
Date from when the price is valid.
-
PriceValidUntil: string
Date until when the price is valid.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the 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)
Value that uniquely identifies the order line to be used as reference in returns pricing processing.
-
ReturnReasonCode: string
Abbreviation that identifies the return reason code.
-
RootCoverageLineId: integer
(int64)
Value that uniquely identifies the root coverage line.
-
RootLineId: integer
(int64)
Value that uniquely identifies the top most root line.
-
RoundingBillToPartyId: integer
(int64)
Value that uniquely identifies the rounding bill-to party.
-
RoundingBillToPartyName: string
Name that identifies the rounding bill-to party.
-
RoundingBillToPartyNumber: string
Number that identifies the rounding bill-to party.
-
RoundingShipToPartyId: integer
(int64)
Value that uniquely identifies the rounding ship-to party.
-
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
Abbreviation that identifies the service duration period.
-
ServiceEndDate: string
Date when the service is terminated.
-
ServiceStartDate: string
Date when the service started.
-
ShipFromLocationAddress1: string
First line of the ship-from location address.
-
ShipFromLocationAddress2: string
Second line of the ship-from location address.
-
ShipFromLocationAddress3: string
Third line of the ship-from location address.
-
ShipFromLocationAddress4: string
Fourth line of the ship-from location address.
-
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)
Value that uniquely identifies the ship-from location.
-
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
Abbreviation that identifies the organization from where logistics ships the goods.
-
ShipFromOrganizationId: integer
(int64)
Value that uniquely identifies the organization from where the goods are shipped.
-
ShipFromPartyId: integer
(int64)
Value that uniquely identifies the ship-from party.
-
ShipFromPartyName: string
Name that identifies the ship-from party.
-
ShipFromPartyNumber: string
Number that identifies the ship-from party.
-
ShipFromPartySiteId: integer
(int64)
Value that uniquely identifies the ship-from party site.
-
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)
Value that uniquely identifies 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
First line of the ship-to location address.
-
ShipToLocationAddress2: string
Second line of the ship-to location address.
-
ShipToLocationAddress3: string
Third line of the ship-to location address.
-
ShipToLocationAddress4: string
Fourth line of the ship-to location address.
-
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)
Value that uniquely identifies the ship-to location.
-
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)
Value that uniquely identifies the ship-to party.
-
ShipToPartyName: string
Name that identifies the ship-to party.
-
ShipToPartyNumber: string
Number that identifies the ship-to party.
-
ShipToPartySiteId: integer
(int64)
Value that uniquely identifies the ship-to party site.
-
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
Contains one of the following values: true or false. If true, then evaluate line level shipping-related charges. If false, then do not evaluate line level shipping-related charges. The default value is false.
-
TaxClassificationCode: string
Value that indicates the tax codes or groups defined in Oracle Fusion Payables.
-
TaxExemptionCertificateNumber: string
Number that uniquely identifies the certificate number for tax exemption. You can use this value with the tax exemption reason code to handle tax exemption.
-
TaxExemptionReasonCode: string
Abbreviation that identifies the tax exemption reason. You can use this value with the tax exemption certificate number to handle tax exemption.
-
ThirdPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies 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
First line of the trading headquarters location address.
-
TradingHQLocationAddress2: string
Second line of the trading headquarters location address.
-
TradingHQLocationAddress3: string
Third line of the trading headquarters location address.
-
TradingHQLocationAddress4: string
Fourth line of the trading headquarters location address.
-
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)
Value that uniquely identifies the trading headquarters location.
-
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)
Value that uniquely identifies the trading headquarters party site.
-
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
Date when the transaction occurred.
-
UserDefinedFiscalClassificationCode: string
Value that identifies the additional classification of a transaction for tax purpose, as required by a tax authority.
Nested Schema : AssessableValue
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency 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
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the rolled-up quantity for configured products. 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
Abbreviation that identifies the unit of measure.
-
Value: number
Quantity requested to be priced. In the case of a configurable product 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
Abbreviation that identifies the unit of measure.
-
Value: number
Value that indicates the unit quantity per root model for the lines of a configuration.
Nested Schema : ServiceDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the duration of the service.
Nested Schema : CSTPricingMessageType
Type:
object
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.
-
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 : CSTTotalType
Type:
object
Values that store the calculated pricing total values.
Show Source
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge.
-
EstimatedFlag: boolean
Contains one of the following values: true or false. If true, then the total amount is an estimated value. If false, then the total amount is an accurate value. The default value is false.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
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.
-
PrimaryFlag: boolean
Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. The default value is false.
-
TotalAmount: object
TotalAmount
Value that is the calculated total value, e.g., 1000.00
-
TotalAnnotation: string
Annotation for the total amount.
-
TotalCode: string
Abbreviation that identifies the pricing total. Values include TOTAL_NET_PRICE.
-
TotalId: integer
(int64)
Value that uniquely identifies the total.
Nested Schema : TotalAmount
Type:
object
Value that is the calculated total value, e.g., 1000.00
Show Source
-
CurrencyCode: string
Abbreviation that identifies the currency of the total amount.
-
Value: number
Number that indicates the total amount.
Nested Schema : CSTTotalComponentType
Type:
object
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Show Source
-
ChargeComponentId: integer
(int64)
Value that uniquely identifies the charge component.
-
TotalComponentId: integer
(int64)
Value that uniquely identifies the total component.
-
TotalId: integer
(int64)
Value that uniquely identifies the total.
Response
Supported Media Types
- application/json
200 Response
Totals calculated successfully.
Root Schema : schema
Type:
Show Source
object
-
ChangeSummary: array
ChangeSummary
Values that store the summary of the changes.
-
Charge: array
Charge
Values that represent a charge calculated within the pricing process or a charge that is passed to Pricing by consuming applications.
-
ChargeComponent: array
ChargeComponent
Values that store the price elements for each charge applied within the pricing process.
-
CoverageAssociation: array
CoverageAssociation
Values that represent the association between a coverage line and its covered item for a service duration.
-
Header: array
Header
Values that represent the sales order or quote header, sales agreement header, or contract header.
-
Line: array
Line
Values that represent the sales order or quote line, sales agreement line, or contract line.
-
PricingMessage: array
PricingMessage
Contains one instance for each pricing error found on the transaction.
-
Total: array
Total
Values that store the calculated pricing total values.
-
TotalComponent: array
TotalComponent
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Nested Schema : ChangeSummary
Type:
array
Values that store the summary of the changes.
Show Source
-
Array of:
object CSTChangeSummaryType
Values that store the summary of the changes.
Nested Schema : Charge
Type:
array
Values that represent a charge calculated within the pricing process or a charge that is passed to Pricing by consuming applications.
Show Source
-
Array of:
object CSTChargeType
Values that represent a charge calculated within the pricing process or a charge that is passed to Oracle Pricing Cloud by consuming applications.
Nested Schema : ChargeComponent
Type:
array
Values that store the price elements for each charge applied within the pricing process.
Show Source
-
Array of:
object CSTChargeComponentType
Values that store the price elements for each charge applied within the pricing process.
Nested Schema : CoverageAssociation
Type:
array
Values that represent the association between a coverage line and its covered item for a service duration.
Show Source
-
Array of:
object CSTCoverageAssociationType
Values that represent the association between a coverage line and its covered item for a service duration.
Nested Schema : Header
Type:
array
Values that represent the sales order or quote header, sales agreement header, or contract header.
Show Source
-
Array of:
object CSTHeaderType
Values that represent the sales order or quote header, sales agreement header, or contract header.
Nested Schema : Line
Type:
array
Values that represent the sales order or quote line, sales agreement line, or contract line.
Show Source
-
Array of:
object CSTLineType
Values that represent the sales order or quote line, sales agreement line, or contract line.
Nested Schema : PricingMessage
Type:
array
Contains one instance for each pricing error found on the transaction.
Show Source
-
Array of:
object CSTPricingMessageType
Contains one instance for each pricing error found on the transaction.
Nested Schema : Total
Type:
array
Values that store the calculated pricing total values.
Show Source
-
Array of:
object CSTTotalType
Values that store the calculated pricing total values.
Nested Schema : TotalComponent
Type:
array
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Show Source
-
Array of:
object CSTTotalComponentType
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Nested Schema : CSTChangeSummaryType
Type:
object
Values that store the summary of the changes.
Nested Schema : CSTChargeType
Type:
object
Values that represent a charge calculated within the pricing process or a charge that is passed to Oracle Pricing Cloud by consuming applications.
Show Source
-
CanAdjustFlag: boolean
Contains one of the following values: true or false. If true, then the price can be discounted. If false, then the price cannot be discounted. The default value is false.
-
ChargeAppliesTo: string
Value that indicates the type of charge. Valid values include Price, Return, or Shipping.
-
ChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
ChargeDefinitionId: integer
(int64)
Value that uniquely identifies the charge definition entity.
-
ChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
ChargeSubtypeCode: string
Abbreviation that identifies the subtype of a given charge type.
-
ChargeTypeCode: string
Abbreviation that identifies the type of a given charge.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationUOMCode: string
Abbreviation that indicates the unit of measure of the coverage duration.
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge.
-
EstimatedPricedQuantityFlag: boolean
Contains one of the following values: true or false. If true, then the priced quantity is an estimated number. If false, then the priced quantity is not an estimated number. The default value is false.
-
EstimatedUnitPriceFlag: boolean
Contains one of the following values: true or false. If true, then the unit price is an estimated number. If false, then the unit price is not an estimated number. The default value is false.
-
FloorUnitPrice: object
FloorUnitPrice
-
GSAUnitPrice: object
GSAUnitPrice
-
LineId: integer
(int64)
Number that indicates the order line.
-
ParentEntityCode: string
Value that indicate the parent entity of the charge. Values include Line and Line Coverage.
-
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity of the charge.
-
PricedQuantity: object
PricedQuantity
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
-
PricedQuantityUOMCode: string
Abbreviation that indicates the unit of measure of the priced quantity.
-
PricePeriodicityCode: string
Value that indicates periodicity for both recurring and recurring usage price types.
-
PriceTypeCode: string
Abbreviation that identifies the price type of a given charge.
-
PrimaryFlag: boolean
Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. The default value is false.
-
RollupFlag: boolean
Contains one of the following values: true or false. If true, then mark a charge as a rollup or aggregate charge. If false, then do not mark a charge as a rollup or aggregate charge. The default value is false.
-
SequenceNumber: integer
(int64)
Number that indicates the sequence for the charge.
-
SourceChargeId: integer
(int64)
Value that uniquely identifies the source charge created by an external pricing engine.
-
TaxIncludedFlag: boolean
Contains one of the following values: true or false. If true, then the charge includes tax. If false, then the charge does not include tax. The default value is false.
-
UsagePeriodCode: string
Abbreviation that indicates the period of usage.
-
UsageUOMCode: string
Abbreviation that indicates the unit of measure of usage.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the duration of the coverage.
Nested Schema : FloorUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
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
Abbreviation that identifies the currency.
-
Value: number
Unit price amount derived from a Government Services Administration price list on the strategy for the current transaction.
Nested Schema : PricedQuantity
Type:
object
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
Show Source
-
UomCode: string
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the quantity to be priced.
Nested Schema : CSTChargeComponentType
Type:
object
Values that store the price elements for each charge applied within the pricing process.
Show Source
-
AggregateChargeComponentId: integer
(int64)
Value that uniquely identifies the aggregate charge component on the roll-up charge. This attribute 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)
Value that uniquely identifies the charge component.
-
ChargeId: integer
(int64)
Value that uniquely identifies the charge on which price or adjustment is applied.
-
CoverageExtendedAmount: object
CoverageExtendedAmount
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge component. This attribuite is required for service standardization.
-
Explanation: string
Message that is displayed in a price breakdown or PWF UI. - Venkat
-
ExplanationMessageName: string
Name of the explanation message.
-
ExtendedAmount: object
ExtendedAmount
-
HeaderCurrencyCode: string
Abbreviation that identifies the header currency. This attribute is required to service standardization.
-
HeaderCurrencyCoverageExtendedAmount: object
HeaderCurrencyCoverageExtendedAmount
-
HeaderCurrencyExtendedAmount: object
HeaderCurrencyExtendedAmount
-
HeaderCurrencyUnitPrice: object
HeaderCurrencyUnitPrice
-
PercentOfComparisonElement: number
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, and so on.
-
PriceElementCode: string
Value that identifies the element reference to the price elements setup. For example, LISTPRICE, NETPRICE, and so on.
-
PriceElementUsageCode: string
Value that is used by consuming applications to indicate how the charge component will be used. A list of accepted values is defined in the lookup type QP.
-
RollupFlag: boolean
Contains one of the following values: true or false. If true, then mark a charge component as a rollup or aggregate value for the charge component price element code. If false, then do not mark a charge component as a rollup or aggregate value for the charge component price element code. The default value is false.
-
SequenceNumber: integer
(int64)
Number that identifies the sequence for the charge component.
-
SourceChargeComponentId: string
Value that uniquely identifies the source charge component created by an external pricing engine.
-
SourceChargeId: string
Value that uniquely identifies the source charge created by an external pricing engine.
-
SourceId: integer
(int64)
Value that uniquely identifies the lowest level pricing source; for example, price list line, tier rule, CP rule, formula, AP, shipping line, and so on.
-
SourceParentChargeComponentId: string
Value that uniquely identifies the source of the parent charge component.
-
SourceTypeCode: string
Value that indicates the type of the pricing source; for example, Segment Price List Line, and so on. A list of accepted values is defined in the lookup type QP_ENTITY_TYPES and manually adjusted.
-
TaxIncludedFlag: boolean
Contains one of the following values: true or false. If true, then the tax is included for a given charge component. If false, then the tax is not included for a given charge component. The default value is false.
-
UnitPrice: object
UnitPrice
Nested Schema : CoverageExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Number that indicates the coverage extended amount used for the entire service duration of a coverage association.
Nested Schema : ExtendedAmount
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Value that 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 quantity for configurable products. 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
Abbreviation that identifies the currency.
-
Value: number
Number that 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
Abbreviation that identifies the currency.
-
Value: number
Extended amount for the header currency.
Nested Schema : HeaderCurrencyUnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Number that indicates the unit price in header currency.
Nested Schema : UnitPrice
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency.
-
Value: number
Value that is the price or adjustment per unit in the charge currency for the line unit of measure.
Nested Schema : CSTCoverageAssociationType
Type:
object
Values that represent the association between a coverage line and its covered item for a service duration.
Show Source
-
ActionCode: string
Abbreviation that identifies the action to be performed for the coverage association.
-
AllowPriceListUpdateFlag: boolean
Contains one of the following values: true or false. If true, then a previously selected price list can be changed to a different price list. If false, then a previously selected price list cannot be changed to a different price list. The default value is false.
-
AppliedPriceListId: integer
(int64)
Value that uniquely identifies the price list applied for the coverage association.
-
AssociationParentLineId: integer
(int64)
Value that uniquely identifies the line that represents the covered item for percentage-based coverage pricing rules.
-
CoverageAssociationId: integer
(int64)
Value that uniquely identifies the coverage association. This value is required.
-
CoverageDuration: object
CoverageDuration
-
CoverageDurationEndDate: string
Date when the coverage association ends. This value is required to be sent on the association line.
-
CoverageDurationStartDate: string
Date when the coverage association started. This value is required to be sent on the association line for current logic.
-
CoverageDurationUOMCode: string
Abbreviation that identifies the unit of measure code used to price the coverage association for the coverage duration.
-
CoverageLineId: integer
(int64)
Value that uniquely identifies the line of the coverage item for which coverage association is specified. This is a required attribute.
-
CoveredInventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item of the covered item or covered asset for the coverage association.
-
CoveredInventoryItemNumber: string
Number that indicates the inventory item of the covered item or the covered asset for the coverage association.
-
CoveredItemQuantity: object
CoveredItemQuantity
-
CoveredItemUOMCode: string
Abbreviation that identifies the asset or covered item unit of measure for the coverage association.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency for the coverage association.
-
DefaultPriceListId: integer
(int64)
Value that uniquely identifies the default price list for the coverage association. This is a required attribute.
-
OverridePriceListId: integer
(int64)
Value that uniquely identifies the override price list. If allowed by pricing, refers to the identifier of a price list used to override price for a specific coverage association.
-
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.
-
PriceAsOf: string
Value that is used to compare effectivities on pricing setups. The caller can default header priceAsOf to coverage association.
-
TransactionOn: string
Date when the transaction occurred.
Nested Schema : CoverageDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the duration of the coverage.
Nested Schema : CoveredItemQuantity
Type:
Show Source
object
-
UomCode: string
Abbreviation that indicates the unit of measure.
-
Value: number
Number that indicates the asset or covered item quantity covered for the coverage association.
Nested Schema : CSTHeaderType
Type:
object
Values that represent the sales order or quote header, sales agreement header, or contract header.
Show Source
-
AllowCurrencyOverrideFlag: boolean
Contains one of the following values: true or false. If true, then the currency can be overridden. If false, then the currency cannot be overridden. The default value is false.
-
AppliedCurrencyCode: string
Abbreviation that identifies the currency to be used as the default header currency.
-
BillingThirdPartyAccountId: integer
(int64)
Value that uniquely identifies the billing third-party account. This attribute is 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)
Value that uniquely identifies the billing third-party account site. This attribute is used in tax calculations.
-
BillingThirdPartyAccountSiteNumber: string
Number that identifies the third-party account that pricing uses in tax calculations for billing.
-
BillToCustomerAccountSiteUseId: integer
(int64)
Value that uniquely identifies the bill to customer account site. This attribute is used in tax calculations.
-
CalculatePricingChargesFlag: boolean
Contains one of the following values: true or false. If true, then calculate price charges for a line item. If false, then do not calculate price charges for a line item. The default value is true.
-
CalculateShippingChargesFlag: boolean
Contains one of the following values: true or false. If true, then evaluate shipping-related charges for the document. If false, then do not evaluate shipping-related charges for the document. The default value is true.
-
CalculateTaxFlag: boolean
Contains one of the following values: Y or N. If Y, then call Oracle Fusion Tax to derive tax amounts for the lines on the document. If N, then do not call Oracle Fusion Tax to derive tax amounts for the lines on the document. The default value is Y.
-
CustomerId: integer
(int64)
Value that uniquely identifies the sold-to customer.
-
CustomerName: string
Name of the customer. The Party Name in customer data management provides this name.
-
CustomerNumber: string
Number that identifies the customer. The Party Number in customer data management provides this number.
-
CustomerTypeCode: string
Indicates whether customer is internal or external.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency. This attribute retains the original currency returned for the strategy.
-
EndCustomerId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the fulfillment geography. This value will either be null (initially), or specified (from sales order).
-
FulfillmentGeographyName: string
Name of the fulfillment geography.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
InternalOrganizationLocationId: integer
(int64)
Value that uniquely identifies the internal organization location.
-
LedgerId: integer
(int64)
Value that uniquely identifies the ledger.
-
LedgerName: string
Name of the ledger.
-
OverrideCurrencyCode: string
Abbreviation that identifies the override currency. 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 one of the following values: true or false. If true, then the coverage line charges need to be populated. If false, then the coverage line charges need not be populated. The default value is false.
-
PriceAsOf: string
Value that indicates the price as of date.
-
PricedOn: string
Date when the document is priced. This attribute stores the application date at the beginning of a pricing process.
-
PriceValidFrom: string
Date from when the price is valid.
-
PriceValidUntil: string
Date until when the price is valid.
-
PricingSegmentCode: string
Value that stores either the pricing segment code sent from the caller or the pricing segment code derived by the pricing engine.
-
PricingSegmentExplanation: string
Message that states the reason for applying the pricing segment.
-
PricingStrategyExplanation: string
Message that states the reason for applying the pricing strategy.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy. This attribute stores either the pricing strategy identifier sent from the caller or the pricing strategy identifier derived by the pricing engine.
-
PricingStrategyName: string
Name of the pricing strategy. The caller provides the name or pricing determines the name.
-
RoundingBillToPartyId: integer
(int64)
Value that uniquely identifies the bill-to party 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)
Value that uniquely identifies the bill-to party site 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)
Value that uniquely identifies the ship-to party 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
Abbreviation that indicates the sales channel.
-
SalesSubChannelCode: string
Abbreviation that indicates the subgroup within a channel that initiated the order. For example, for the Web channel this attribute contains the name of the web-site.
-
SellingBusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
SellingBusinessUnitName: string
Name of the selling business unit.
-
SellingLegalEntityId: integer
(int64)
Value that uniquely identifies the selling legal entity.
-
SellingLegalEntityIdentifier: string
Value that uniquely identifies the selling legal entity that pricing uses for tax calculations.
-
TotalGroupEntityCode: string
Abbreviation that indicates the group entity.
-
TotalUsageCode: string
Abbreviation that indicates the total usage.
-
TransactionOn: string
Date when the transaction occurred.
-
TransactionTypeCode: string
Abbreviation that indicates the transaction type, whether it is a quote, an order, and so on. This information is used in determining which pricing process to invoke.
Nested Schema : CSTLineType
Type:
object
Values that represent the sales order or 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
Contains one of the following values: true or false. If true, then currency can be overridden. If false, then currency cannot be overridden. The default value is false.
-
AllowPriceListUpdateFlag: boolean
Contains one of the following values: true or false. If true, then the previously selected price list can be changed to a different price list. If false, then previously selected price list cannot be changed. The default value is false.
-
AppliedPriceListId: integer
(int64)
Value that uniquely identifies the price list applied.
-
AppliedShippingChargeListId: integer
(int64)
Value that uniquely identifies the shipping charge list that pricing 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
First line of the bill-from location address.
-
BillFromLocationAddress2: string
Second line of the bill-from location address.
-
BillFromLocationAddress3: string
Third line of the bill-from location address.
-
BillFromLocationAddress4: string
Fourth line of the bill-from location address.
-
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)
Value that uniquely identifies the bill-from location.
-
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
First line of the bill-to location address.
-
BillToLocationAddress2: string
Second line of the bill-to location address.
-
BillToLocationAddress3: string
Third line of the bill-to location address.
-
BillToLocationAddress4: string
Fourth line of the bill-to location address.
-
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)
Value that uniquely identifies the bill-to location.
-
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)
Value that uniquely identifies the bill-to party.
-
BillToPartyName: string
Name that identifies the bill-to party.
-
BillToPartyNumber: string
Number that identifies the bill-to party.
-
BillToPartySiteId: integer
(int64)
Value that uniquely identifies the bill-to party site.
-
BillToPartySiteNumber: string
Number that identifies the bill-to party site.
-
ComponentIdPath: string
Value that uniquely identifies the hierarchical path of the component items. The attribute value contains the root model item identifier to the immediate parent inventory item identifier separated by the delimiter >.
-
ComponentPath: string
Value that identifies the hierarchical path of the component items. The attribute value contains the root model item to the immediate parent inventory item number separated by the delimiter >.
-
DefaultCurrencyCode: string
Abbreviation that identifies the default currency code for the line.
-
DefaultPriceListId: integer
(int64)
Value that uniquely identifies the default price list.
-
DefaultTaxationCountry: string
Value that 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
Value that controls the application of exemptions to the transaction line during tax lines calculation.
-
ExtendedQuantity: object
ExtendedQuantity
-
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the tax registration that the first party organization used for a transaction.
-
FOBCode: string
Abbreviation that identifies the freight on board.
-
FulfillmentGeographyId: integer
(int64)
Value that uniquely identifies the fulfillment geography.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header reference for the line.
-
IntendedUseClassificationCode: string
Abbreviation that identifies the classification that describes how the purchaser intends to use the item.
-
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the classification purpose for which a product is used in a business by the purchaser.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item to be priced.
-
InventoryItemNumber: string
Number of the item that pricing must price.
-
InventoryOrganizationCode: string
Abbreviation that identifies the inventory organization that the item number references.
-
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization for the item.
-
LineCategoryCode: string
Abbreviation that identifies the category of the line.
-
LineId: integer
(int64)
Value that uniquely identifies the line.
-
LineQuantity: object
LineQuantity
-
LineQuantityUOMCode: string
Abbreviation that identifies the requested unit of measure.
-
LineTypeCode: string
Abbreviation that identifies the action performed when the order line is fulfilled.
-
OverrideCurrencyCode: string
Abbreviation that identifies the override currency. If the AllowCurrencyOverride flag is set to true on the pricing strategy, the value of this attribute is used as the default currency for any non-overridden currency on charges and totals.
-
OverridePriceListId: integer
(int64)
Value that uniquely identifies the override price list. If allowed by pricing, this is the price list that the 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)
Value that uniquely identifies the location that initiates or negotiates a sales order for products and services. This value represents the point of order origin location.
-
PooPartyId: integer
(int64)
Value that uniquely identifies the party that initiates or negotiates a sales order for products and services. This value represents the point of order origin party identifier.
-
PooPartyName: string
Name of the party where the order originated from.
-
PooPartyNumber: string
Number that identifies the point of order origin party. This party starts or negotiates a sales order for an item.
-
PriceAsOf: string
Value that is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
-
PricedOn: string
Date when the line is priced. This attribute will be populated with the application date at the beginning of a pricing process.
-
PriceValidFrom: string
Date from when the price is valid.
-
PriceValidUntil: string
Date until when the price is valid.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies 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)
Value that uniquely identifies the 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)
Value that uniquely identifies the order line to be used as reference in returns pricing processing.
-
ReturnReasonCode: string
Abbreviation that identifies the return reason code.
-
RootCoverageLineId: integer
(int64)
Value that uniquely identifies the root coverage line.
-
RootLineId: integer
(int64)
Value that uniquely identifies the top most root line.
-
RoundingBillToPartyId: integer
(int64)
Value that uniquely identifies the rounding bill-to party.
-
RoundingBillToPartyName: string
Name that identifies the rounding bill-to party.
-
RoundingBillToPartyNumber: string
Number that identifies the rounding bill-to party.
-
RoundingShipToPartyId: integer
(int64)
Value that uniquely identifies the rounding ship-to party.
-
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
Abbreviation that identifies the service duration period.
-
ServiceEndDate: string
Date when the service is terminated.
-
ServiceStartDate: string
Date when the service started.
-
ShipFromLocationAddress1: string
First line of the ship-from location address.
-
ShipFromLocationAddress2: string
Second line of the ship-from location address.
-
ShipFromLocationAddress3: string
Third line of the ship-from location address.
-
ShipFromLocationAddress4: string
Fourth line of the ship-from location address.
-
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)
Value that uniquely identifies the ship-from location.
-
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
Abbreviation that identifies the organization from where logistics ships the goods.
-
ShipFromOrganizationId: integer
(int64)
Value that uniquely identifies the organization from where the goods are shipped.
-
ShipFromPartyId: integer
(int64)
Value that uniquely identifies the ship-from party.
-
ShipFromPartyName: string
Name that identifies the ship-from party.
-
ShipFromPartyNumber: string
Number that identifies the ship-from party.
-
ShipFromPartySiteId: integer
(int64)
Value that uniquely identifies the ship-from party site.
-
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)
Value that uniquely identifies 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
First line of the ship-to location address.
-
ShipToLocationAddress2: string
Second line of the ship-to location address.
-
ShipToLocationAddress3: string
Third line of the ship-to location address.
-
ShipToLocationAddress4: string
Fourth line of the ship-to location address.
-
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)
Value that uniquely identifies the ship-to location.
-
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)
Value that uniquely identifies the ship-to party.
-
ShipToPartyName: string
Name that identifies the ship-to party.
-
ShipToPartyNumber: string
Number that identifies the ship-to party.
-
ShipToPartySiteId: integer
(int64)
Value that uniquely identifies the ship-to party site.
-
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
Contains one of the following values: true or false. If true, then evaluate line level shipping-related charges. If false, then do not evaluate line level shipping-related charges. The default value is false.
-
TaxClassificationCode: string
Value that indicates the tax codes or groups defined in Oracle Fusion Payables.
-
TaxExemptionCertificateNumber: string
Number that uniquely identifies the certificate number for tax exemption. You can use this value with the tax exemption reason code to handle tax exemption.
-
TaxExemptionReasonCode: string
Abbreviation that identifies the tax exemption reason. You can use this value with the tax exemption certificate number to handle tax exemption.
-
ThirdPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies 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
First line of the trading headquarters location address.
-
TradingHQLocationAddress2: string
Second line of the trading headquarters location address.
-
TradingHQLocationAddress3: string
Third line of the trading headquarters location address.
-
TradingHQLocationAddress4: string
Fourth line of the trading headquarters location address.
-
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)
Value that uniquely identifies the trading headquarters location.
-
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)
Value that uniquely identifies the trading headquarters party site.
-
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
Date when the transaction occurred.
-
UserDefinedFiscalClassificationCode: string
Value that identifies the additional classification of a transaction for tax purpose, as required by a tax authority.
Nested Schema : AssessableValue
Type:
Show Source
object
-
CurrencyCode: string
Abbreviation that identifies the currency 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
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the rolled-up quantity for configured products. 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
Abbreviation that identifies the unit of measure.
-
Value: number
Quantity requested to be priced. In the case of a configurable product 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
Abbreviation that identifies the unit of measure.
-
Value: number
Value that indicates the unit quantity per root model for the lines of a configuration.
Nested Schema : ServiceDuration
Type:
Show Source
object
-
UomCode: string
Abbreviation that identifies the unit of measure.
-
Value: number
Number that indicates the duration of the service.
Nested Schema : CSTPricingMessageType
Type:
object
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.
-
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 : CSTTotalType
Type:
object
Values that store the calculated pricing total values.
Show Source
-
CurrencyCode: string
Abbreviation that identifies the currency used in the charge.
-
EstimatedFlag: boolean
Contains one of the following values: true or false. If true, then the total amount is an estimated value. If false, then the total amount is an accurate value. The default value is false.
-
HeaderId: integer
(int64)
Value that uniquely identifies the header.
-
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.
-
PrimaryFlag: boolean
Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. The default value is false.
-
TotalAmount: object
TotalAmount
Value that is the calculated total value, e.g., 1000.00
-
TotalAnnotation: string
Annotation for the total amount.
-
TotalCode: string
Abbreviation that identifies the pricing total. Values include TOTAL_NET_PRICE.
-
TotalId: integer
(int64)
Value that uniquely identifies the total.
Nested Schema : TotalAmount
Type:
object
Value that is the calculated total value, e.g., 1000.00
Show Source
-
CurrencyCode: string
Abbreviation that identifies the currency of the total amount.
-
Value: number
Number that indicates the total amount.
Nested Schema : CSTTotalComponentType
Type:
object
Values that represent multiple charge components (price elements) that comprise a total; for example, multiple discounts are added to display the total discount.
Show Source
-
ChargeComponentId: integer
(int64)
Value that uniquely identifies the charge component.
-
TotalComponentId: integer
(int64)
Value that uniquely identifies the total component.
-
TotalId: integer
(int64)
Value that uniquely identifies the total.
400 Response
Invalid input request.