Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Header":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPHeaderType"
            }
        },
        "PriceViolation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPriceViolationType"
            }
        },
        "PricingMessage":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPricingMessageType"
            }
        },
        "PricingServiceParameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPricingServiceParameterType"
            }
        },
        "Line":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPLineType"
            }
        },
        "Charge":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChargeType"
            }
        },
        "LineAttribute":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPLineAttributeType"
            }
        },
        "ChargeComponent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChargeComponentType"
            }
        },
        "PriceValidation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPriceValidationType"
            }
        },
        "ChangeSummary":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChangeSummaryType"
            }
        }
    }
}

Nested Schema : ChangeSummary

Type: array

Show Source

• Array of: object ChangeSummaryType
  Values that store the summary of the changes.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChangeSummaryType"
    }
}

Nested Schema : Charge

Type: array

Show Source

• Array of: object ChargeType
  Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChargeType"
    }
}

Nested Schema : ChargeComponent

Type: array

Show Source

• Array of: object ChargeComponentType
  Stores the price elements for each charge applied within the pricing process.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChargeComponentType"
    }
}

Nested Schema : Header

Type: array

Show Source

• Array of: object HeaderType
  Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPHeaderType"
    }
}

Nested Schema : Line

Type: array

Show Source

• Array of: object LineType
  Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPLineType"
    }
}

Nested Schema : LineAttribute

Type: array

Show Source

• Array of: object LineAttributeType
  Values that store the transaction item attributes. This attribute is used only for input.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPLineAttributeType"
    }
}

Nested Schema : PriceValidation

Type: array

Show Source

• Array of: object PriceValidationType
  This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPriceValidationType"
    }
}

Nested Schema : PriceViolation

Type: array

Show Source

• Array of: object PriceViolationType
  This entity is an output from Pricing. It stores the guidelines violated in the pricing process.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPriceViolationType"
    }
}

Nested Schema : PricingMessage

Type: array

Show Source

• Array of: object PricingMessageType
  This entity contains one instance for each pricing error found on the transaction.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPricingMessageType"
    }
}

Nested Schema : PricingServiceParameter

Type: array

Show Source

• Array of: object PricingServiceParameterType
  This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPricingServiceParameterType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "CanAdjustFlag":{
            "type":"boolean",
            "description":"The flag from pricelist/shippingPolicy admin indicating whether this price can be discounted."
        },
        "ChargeAppliesTo":{
            "type":"string",
            "description":"Indicates the type of charge (Price, Return, or Shipping)"
        },
        "ChargeDefinitionCode":{
            "type":"string",
            "description":"Unique Code of the Pricing Charge Definition"
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"Id of the charge definition entity.",
            "format":"int64"
        },
        "ChargeId":{
            "type":"integer",
            "description":"Charge Id",
            "format":"int64"
        },
        "ChargeSubtypeCode":{
            "type":"string",
            "description":"Subtype of a given charge type."
        },
        "ChargeTypeCode":{
            "type":"string",
            "description":"Type of a given charge."
        },
        "CoverageDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage duration of a charge that applies to a coverage association."
                },
                "UomCode":{
                    "type":"string",
                    "description":"UOM code of the coverage duration."
                }
            }
        },
        "CoverageDurationUOMCode":{
            "type":"string",
            "description":"Indicates the coverage duration unit of measure used to calculate the coverage extended amount that applies to a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the currency used in the charge"
        },
        "EstimatedPricedQuantityFlag":{
            "type":"boolean",
            "description":"This attribute indicates whether the priced quantity is an estimated number."
        },
        "EstimatedUnitPriceFlag":{
            "type":"boolean",
            "description":"This attribute indicates whether the unit price is an estimated number."
        },
        "FloorUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
                }
            }
        },
        "GSAUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
                }
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Indicates the Line ID of the parent line of a charge.",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Parent entity of the charge. Values include Line and Line Coverage "
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Id of the parent entity of the charge.",
            "format":"int64"
        },
        "PricePeriodicityCode":{
            "type":"string",
            "description":"Indidates periodicty for both recurring  and recurring usage price types"
        },
        "PriceTypeCode":{
            "type":"string",
            "description":"Price type of a given charge."
        },
        "PricedQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
                },
                "UomCode":{
                    "type":"string",
                    "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
                }
            }
        },
        "PricedQuantityUOMCode":{
            "type":"string",
            "description":"UOM code for priced quantity, for example 'Ton'. Values for this attribute will come either from PIM or the reciprocal service QOC provides."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates whether this charge is the primary charge."
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Marks a charge as a rollup/aggregate charge."
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The value of this attribute indicates the sequence number for the charge.",
            "format":"int64"
        },
        "SourceChargeId":{
            "type":"integer",
            "description":"Indicates the ID of a source charge created by an external pricing engine.",
            "format":"int64"
        },
        "TaxIncludedFlag":{
            "type":"boolean",
            "description":"Indicates whether the charge includes tax."
        },
        "UsagePeriodCode":{
            "type":"string",
            "description":"Usage period code for the estimated usage quantity."
        },
        "UsageUOMCode":{
            "type":"string",
            "description":"Usage uom code for the estimated usage quantity."
        }
    },
    "description":"Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.",
    "xml":{
        "name":"ChargeType"
    }
}

Nested Schema : CoverageDuration

Type: object

Show Source

• UomCode: string
  UOM code of the coverage duration.
• Value: number
  Indicates the coverage duration of a charge that applies to a coverage association.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage duration of a charge that applies to a coverage association."
        },
        "UomCode":{
            "type":"string",
            "description":"UOM code of the coverage duration."
        }
    }
}

Nested Schema : FloorUnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
        }
    }
}

Nested Schema : GSAUnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
        }
    }
}

Nested Schema : PricedQuantity

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
        },
        "UomCode":{
            "type":"string",
            "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf 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

{
    "type":"object",
    "properties":{
        "AggregateChargeComponentId":{
            "type":"integer",
            "description":"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.",
            "format":"int64"
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"Charge Component Id",
            "format":"int64"
        },
        "ChargeId":{
            "type":"integer",
            "description":"chargeId on which price/adjustment applied to",
            "format":"int64"
        },
        "CoverageExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
                }
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the currency used in the charge component. Needed due to service standardization."
        },
        "Explanation":{
            "type":"string",
            "description":"Message for display in a price breakdown or PWF UI."
        },
        "ExplanationMessageName":{
            "type":"string",
            "description":"The name of an explanation message."
        },
        "ExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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. "
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"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. "
                }
            }
        },
        "HeaderCurrencyCode":{
            "type":"string",
            "description":"Indicates the header currency. Needed due to service standardization."
        },
        "HeaderCurrencyCoverageExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
                }
            }
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"This attribute indicates the extended amount in header currency"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The currency of header."
                }
            }
        },
        "HeaderCurrencyUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"This attribute indicates the unit price in header currency"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"This attribute indicates the unit price in header currency"
                }
            }
        },
        "PercentOfComparisonElement":{
            "type":"number",
            "description":"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":{
            "type":"string",
            "description":"Element reference to the Price Elements setup eg. LISTPRICE, NETPRICE etc."
        },
        "PriceElementUsageCode":{
            "type":"string",
            "description":"Used by consuming applications to indicate how the charge component will be used. Values of this attribute will come from a QP lookup. "
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Marks a charge component as a rollup/aggregate value for the charge component price element code."
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int64"
        },
        "SourceChargeComponentId":{
            "type":"string",
            "description":"Indicates the ID of a source charge component created by an external pricing engine."
        },
        "SourceChargeId":{
            "type":"string",
            "description":"Indicates the ID of a source charge created by an external pricing engine."
        },
        "SourceId":{
            "type":"integer",
            "description":"Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.",
            "format":"int64"
        },
        "SourceParentChargeComponentId":{
            "type":"string",
            "description":"Indicates the ID of a source parent charge component created by an external pricing engine."
        },
        "SourceTypeCode":{
            "type":"string",
            "description":"Type of the Pricing source eg. Segment Price List Line etc. The values are from the lookup QP_ENTITY_TYPES plus manual adjustment."
        },
        "TaxIncludedFlag":{
            "type":"boolean",
            "description":"Indicates whether a tax is included for a given charge component."
        },
        "UnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The price or adjustment per unit in the charge currency for the line UOM."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The price or adjustment per unit in the charge currency for the line UOM."
                }
            }
        }
    },
    "description":"Stores the price elements for each charge applied within the pricing process.",
    "xml":{
        "name":"ChargeComponentType"
    }
}

Nested Schema : CoverageExtendedAmount

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
        }
    }
}

Nested Schema : ExtendedAmount

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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. "
        },
        "CurrencyCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
        }
    }
}

Nested Schema : HeaderCurrencyExtendedAmount

Type: object

Show Source

• CurrencyCode: string
  The currency of header.
• Value: number
  This attribute indicates the extended amount in header currency

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"This attribute indicates the extended amount in header currency"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency of header."
        }
    }
}

Nested Schema : HeaderCurrencyUnitPrice

Type: object

Show Source

• CurrencyCode: string
  This attribute indicates the unit price in header currency
• Value: number
  This attribute indicates the unit price in header currency

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"This attribute indicates the unit price in header currency"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"This attribute indicates the unit price in header currency"
        }
    }
}

Nested Schema : UnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The price or adjustment per unit in the charge currency for the line UOM."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "properties":{
        "AllowCurrencyOverrideFlag":{
            "type":"boolean",
            "description":"Indicate whether the currency can be overridden."
        },
        "AppliedCurrencyCode":{
            "type":"string",
            "description":"Currency code to be used as the default header currency."
        },
        "BillToCustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Indicates the bill to customer account site use ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountId":{
            "type":"integer",
            "description":"Indicates the billing third-party account ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountName":{
            "type":"string",
            "description":"Name of the third-party account that pricing uses in tax calculations for billing."
        },
        "BillingThirdPartyAccountNumber":{
            "type":"string",
            "description":"Number that identifies the third-party account that pricing uses in tax calculations for billing."
        },
        "BillingThirdPartyAccountSiteId":{
            "type":"integer",
            "description":"Indicates the billing third-party account site ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountSiteNumber":{
            "type":"string",
            "description":"Number that identifies the third-party account that pricing uses in tax calculations for billing."
        },
        "CalculatePricingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to price charges for a line item. Value is true (default) or false."
        },
        "CalculateShippingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to evaluate shipping-related charges for the document. Value is either true (default) or false."
        },
        "CalculateTaxFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"integer",
            "description":"Sold To Customer Id.",
            "format":"int64"
        },
        "CustomerName":{
            "type":"string",
            "description":"The Party Name in Customer Data Management provides this name."
        },
        "CustomerNumber":{
            "type":"string",
            "description":"The Party Number in Customer Data Management provides this number."
        },
        "CustomerTypeCode":{
            "type":"string",
            "description":"Indicates whether customer is internal or external."
        },
        "DefaultCurrencyCode":{
            "type":"string",
            "description":"The purpose of this is to retain the original currency  returned for the strategy.  "
        },
        "EndCustomerId":{
            "type":"integer",
            "description":"Id of the customer who receives the item.",
            "format":"int64"
        },
        "EndCustomerName":{
            "type":"string",
            "description":"Name of the customer who receives the item. The Party Name in Customer Data Management provides this name."
        },
        "EndCustomerNumber":{
            "type":"string",
            "description":"Number that identifies the customer who receives the item. The Party Number in Customer Data Management provides this number."
        },
        "FulfillmentGeographyId":{
            "type":"integer",
            "description":"This will be either null (initially), or specified (when selected on SO or derived from SO Shipment.Ship To Address Id).",
            "format":"int64"
        },
        "FulfillmentGeographyName":{
            "type":"string",
            "description":"Name of the fulfillment geography."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Header Id.",
            "format":"int64"
        },
        "InternalOrganizationLocationId":{
            "type":"integer",
            "description":"Indicates the internal organziation location ID.",
            "format":"int64"
        },
        "LedgerId":{
            "type":"integer",
            "description":"Indicates the ledger ID.",
            "format":"int64"
        },
        "LedgerName":{
            "type":"string",
            "description":"Name of the ledger."
        },
        "OverrideCurrencyCode":{
            "type":"string",
            "description":"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":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Price as of date."
        },
        "PriceValidFrom":{
            "type":"string",
            "description":"Price valid from date."
        },
        "PriceValidUntil":{
            "type":"string",
            "description":"Price valid until date."
        },
        "PricedOn":{
            "type":"string",
            "description":"The date when the document is priced. This attribute will be populated with the system date at the beginning of a pricing process."
        },
        "PricingSegmentCode":{
            "type":"string",
            "description":"This attribute stores either the pricing segment code passed in from the caller or the pricing segment code derived by the pricing engine."
        },
        "PricingSegmentExplanation":{
            "type":"string",
            "description":"Message to state why the Pricing Segment has been applied."
        },
        "PricingStrategyExplanation":{
            "type":"string",
            "description":"Message to state why the Pricing Strategy has been applied."
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"This attribute stores either the pricing strategy id passed in from the caller or the pricing strategy id derived by the pricing engine.",
            "format":"int64"
        },
        "PricingStrategyName":{
            "type":"string",
            "description":"The name of the pricing strategy. The caller provides the name or pricing determines the name."
        },
        "RoundingBillToPartyId":{
            "type":"integer",
            "description":"Indicates the bill to party ID used for rounding in tax calculations.",
            "format":"int64"
        },
        "RoundingBillToPartyName":{
            "type":"string",
            "description":"Name that identifies the bill-to party to use when rounding a number during a tax calculation."
        },
        "RoundingBillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party to use when rounding a number during a tax calculation. "
        },
        "RoundingBillToPartySiteId":{
            "type":"integer",
            "description":"Indicates the bill to party site ID used for rounding in tax calculations.",
            "format":"int64"
        },
        "RoundingBillToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party site to use when rounding a number during a tax calculation."
        },
        "RoundingShipToPartyId":{
            "type":"integer",
            "description":"Indicates the ship to party ID used for rounding in tax calcuations.",
            "format":"int64"
        },
        "RoundingShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-to party to use when rounding a number during a tax calculation."
        },
        "RoundingShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party to use when rounding a number during a tax calculation."
        },
        "SalesChannelCode":{
            "type":"string",
            "description":"Sales Channel code."
        },
        "SalesSubChannelCode":{
            "type":"string",
            "description":"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":{
            "type":"integer",
            "description":"Selling business unit id",
            "format":"int64"
        },
        "SellingBusinessUnitName":{
            "type":"string",
            "description":"Name of the selling business unit."
        },
        "SellingLegalEntityId":{
            "type":"integer",
            "description":"Selling legal entity id.",
            "format":"int64"
        },
        "SellingLegalEntityIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the selling legal entity that pricing uses for tax calculations."
        },
        "TotalGroupEntityCode":{
            "type":"string",
            "description":"Entities for which a Total is calculated.Values of the attribute are from the ORA_QP_TOTAL_ENTITY_TYPES lookup."
        },
        "TotalUsageCode":{
            "type":"string",
            "description":"Usage based on which a Total is calculated. Value of the attribute is from the ORA_QP_TOTAL_USAGE_TYPES lookup."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "TransactionTypeCode":{
            "type":"string",
            "description":"Indicates the transaction type of the passed in document. Transaction Types include QUOTE, ORDER, etc."
        }
    },
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "xml":{
        "name":"HeaderType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "type":"string",
            "description":"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":{
            "type":"boolean",
            "description":"Indicate whether the currency can be overridden."
        },
        "AllowPriceListUpdateFlag":{
            "type":"boolean",
            "description":"Indicate whether a previously selected price list can be changed to a different price list."
        },
        "AppliedPriceListId":{
            "type":"integer",
            "description":"Id of the price list applied.",
            "format":"int64"
        },
        "AppliedShippingChargeListId":{
            "type":"integer",
            "description":"Id of the shipping charge list applied.",
            "format":"int64"
        },
        "AssessableValue":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Currency code of the assessable value."
                }
            }
        },
        "AssessableValueCurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the currency of the assessable value."
        },
        "AssessableValueOverrideFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Address line 1 of the bill-from location."
        },
        "BillFromLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the bill-from location."
        },
        "BillFromLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the bill-from location."
        },
        "BillFromLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the bill-from location."
        },
        "BillFromLocationCity":{
            "type":"string",
            "description":"City of the bill-from location."
        },
        "BillFromLocationCountry":{
            "type":"string",
            "description":"Country of the bill-from location."
        },
        "BillFromLocationCounty":{
            "type":"string",
            "description":"County of the bill-from location."
        },
        "BillFromLocationId":{
            "type":"integer",
            "description":"Indicates the bill from location ID.",
            "format":"int64"
        },
        "BillFromLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the bill-from location."
        },
        "BillFromLocationProvince":{
            "type":"string",
            "description":"Province of the bill-from location."
        },
        "BillFromLocationState":{
            "type":"string",
            "description":"State of the bill-from location."
        },
        "BillToLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the bill-to location."
        },
        "BillToLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the bill-to location."
        },
        "BillToLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the bill-to location."
        },
        "BillToLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the bill-to location."
        },
        "BillToLocationCity":{
            "type":"string",
            "description":"City of the bill-to location."
        },
        "BillToLocationCountry":{
            "type":"string",
            "description":"Country of the bill-to location."
        },
        "BillToLocationCounty":{
            "type":"string",
            "description":"County of the bill-to location."
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Indicates the bill to location ID.",
            "format":"int64"
        },
        "BillToLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the bill-to location."
        },
        "BillToLocationProvince":{
            "type":"string",
            "description":"Province of the bill-to location."
        },
        "BillToLocationState":{
            "type":"string",
            "description":"State of the bill-to location."
        },
        "BillToPartyId":{
            "type":"integer",
            "description":"Indicates the bill to party ID.",
            "format":"int64"
        },
        "BillToPartyName":{
            "type":"string",
            "description":"Name that identifies the bill-to party."
        },
        "BillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party."
        },
        "BillToPartySiteId":{
            "type":"integer",
            "description":"indicates the bill to party site ID.",
            "format":"int64"
        },
        "BillToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party site."
        },
        "ComponentIdPath":{
            "type":"string",
            "description":"Item ID path for component items.  Contains the Root Model Inventory Item Id to the immediate parent Inventory Item Id delimited with '>'"
        },
        "ComponentPath":{
            "type":"string",
            "description":"Item Number path for component items.  Contains the Root Model Item Number to the immediate parent Item Number delimited with '>'"
        },
        "DefaultCurrencyCode":{
            "type":"string",
            "description":"Default currency code for the line. For R11, the Default Currency is determined at the header level for the strategy. "
        },
        "DefaultPriceListId":{
            "type":"integer",
            "description":"Id of the default price list.",
            "format":"int64"
        },
        "DefaultTaxationCountry":{
            "type":"string",
            "description":"Specifies the country of taxation for tax calculation purposes."
        },
        "DocumentSubType":{
            "type":"string",
            "description":"Classification used for both tax calculation and tax reporting depending upon the requirements of different countries."
        },
        "ExemptionControlCode":{
            "type":"string",
            "description":"Controls the application of exemptions to the transaction line during tax lines calculation."
        },
        "ExtendedQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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. "
                },
                "UomCode":{
                    "type":"string",
                    "description":"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. "
                }
            }
        },
        "FinalDischargeLocationId":{
            "type":"integer",
            "description":"Indicates the location of the final destination for purchases made by a customer, and is applicable to all transactions at line level.",
            "format":"int64"
        },
        "FirstPartyTaxRegistration":{
            "type":"string",
            "description":"Tax registration that the first-party organization uses for the transaction."
        },
        "FirstPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Indicates the tax registration that the first party organization used for a transaction.",
            "format":"int64"
        },
        "FOBCode":{
            "type":"string",
            "description":"Code that indicates freight on board."
        },
        "FulfillmentGeographyId":{
            "type":"integer",
            "description":"This attribute represents the geography ID of the fulfillment.",
            "format":"int64"
        },
        "HeaderId":{
            "type":"integer",
            "description":"HeaderId reference for the Line",
            "format":"int64"
        },
        "IntendedUseClassificationId":{
            "type":"integer",
            "description":"Indicates the classification purpose for which a product is used in a business by the purchaser. ",
            "format":"int64"
        },
        "IntendedUseClassificationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the classification that describes how the purchaser intends to use the item."
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Item to be Priced.",
            "format":"int64"
        },
        "InventoryItemNumber":{
            "type":"string",
            "description":"The number of the item that pricing must price."
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"The Inventory Org Id for this Inventory Item. ",
            "format":"int64"
        },
        "InventoryOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that the Inventory Item Number references."
        },
        "LineCategoryCode":{
            "type":"string",
            "description":"Identifies the category of the line. "
        },
        "LineId":{
            "type":"integer",
            "description":"Line Id.",
            "format":"int64"
        },
        "LineQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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."
                },
                "UomCode":{
                    "type":"string",
                    "description":"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."
                }
            }
        },
        "LineQuantityUOMCode":{
            "type":"string",
            "description":"The requested UOM."
        },
        "LineTypeCode":{
            "type":"string",
            "description":"This identifies the action performed when the order line is fulfilled. "
        },
        "OverrideCurrencyCode":{
            "type":"string",
            "description":"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":{
            "type":"integer",
            "description":"If allowed by pricing, this is the price list that  user selects to override the price to for a particular line item.",
            "format":"int64"
        },
        "OverridePriceListName":{
            "type":"string",
            "description":"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.\n"
        },
        "PerModelUnitQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the unit quantity per root model for the lines of a configuration."
                },
                "UomCode":{
                    "type":"string",
                    "description":"Indicates the unit quantity per root model for the lines of a configuration."
                }
            }
        },
        "PooLocationId":{
            "type":"integer",
            "description":"Indicates the location that initiates or negotiates a sales order for products and services.? This ID represents the Point of Order Origin location.",
            "format":"int64"
        },
        "PooPartyId":{
            "type":"integer",
            "description":"Indicates the party that initiates or negotiates a sales order for products and services. This ID represents the Point of Order Origin party identifier.",
            "format":"int64"
        },
        "PooPartyName":{
            "type":"string",
            "description":"Name that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item."
        },
        "PooPartyNumber":{
            "type":"string",
            "description":"Number that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item. "
        },
        "PriceAsOf":{
            "type":"string",
            "description":"This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines."
        },
        "PriceValidFrom":{
            "type":"string",
            "description":"Price valid from date."
        },
        "PriceValidUntil":{
            "type":"string",
            "description":"Price valid until date."
        },
        "PricedOn":{
            "type":"string",
            "description":"The date when the line is priced. This attribute will be populated with the system date at the beginning of a pricing process."
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"Id of the pricing strategy applied on this line",
            "format":"int64"
        },
        "PricingStrategyName":{
            "type":"string",
            "description":"Name of the pricing strategy that pricing applied on this line."
        },
        "ProductCategory":{
            "type":"string",
            "description":"Classification of products as product categories for tax purposes.  "
        },
        "ProductFiscalClassificationId":{
            "type":"integer",
            "description":"Classification of products based on the inventory item category for tax purposes.",
            "format":"int64"
        },
        "ProductType":{
            "type":"string",
            "description":"Classification of products as product types for tax purposes."
        },
        "ReferenceLineId":{
            "type":"integer",
            "description":"Indicates the order line to be used as reference in returns pricing processing.",
            "format":"int64"
        },
        "ReturnReasonCode":{
            "type":"string",
            "description":"Indicates the return reason code."
        },
        "RootCoverageLineId":{
            "type":"integer",
            "description":"Indicates the root coverage line in the hierarchy.",
            "format":"int64"
        },
        "RootLineId":{
            "type":"integer",
            "description":"Top most root line Id. ",
            "format":"int64"
        },
        "RoundingBillToPartyId":{
            "type":"integer",
            "description":"Indicates the rounding bill to party ID.",
            "format":"int64"
        },
        "RoundingBillToPartyName":{
            "type":"string",
            "description":"Name that identifies the rounding bill-to party."
        },
        "RoundingBillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the rounding bill-to party."
        },
        "RoundingShipToPartyId":{
            "type":"integer",
            "description":"Indicates the rounding ship to party ID.",
            "format":"int64"
        },
        "RoundingShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the rounding ship-to party."
        },
        "RoundingShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the rounding ship-to party."
        },
        "ServiceEndDate":{
            "type":"string",
            "description":"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."
        },
        "ServiceDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Duration for the service."
                },
                "UomCode":{
                    "type":"string",
                    "description":"UOM code of service duration."
                }
            }
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "ServiceStartDate":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Address line 1 of the ship-from location."
        },
        "ShipFromLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the ship-from location."
        },
        "ShipFromLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the ship-from location."
        },
        "ShipFromLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the ship-from location."
        },
        "ShipFromLocationCity":{
            "type":"string",
            "description":"City of the ship-from location."
        },
        "ShipFromLocationCountry":{
            "type":"string",
            "description":"Country of the ship-from location."
        },
        "ShipFromLocationCounty":{
            "type":"string",
            "description":"County of the ship-from location."
        },
        "ShipFromLocationId":{
            "type":"integer",
            "description":"Indicates the ship from location ID.",
            "format":"int64"
        },
        "ShipFromLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the ship-from location."
        },
        "ShipFromLocationProvince":{
            "type":"string",
            "description":"Province of the ship-from location."
        },
        "ShipFromLocationState":{
            "type":"string",
            "description":"State of the ship-from location."
        },
        "ShipFromOrganizationId":{
            "type":"integer",
            "description":"Organization from where the goods are shipped.",
            "format":"int64"
        },
        "ShipFromOrganizationCode":{
            "type":"string",
            "description":"Organization from where logistics ships the goods."
        },
        "ShipFromPartyId":{
            "type":"integer",
            "description":"Indicates the ship from party ID.",
            "format":"int64"
        },
        "ShipFromPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-from party."
        },
        "ShipFromPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-from party."
        },
        "ShipFromPartySiteId":{
            "type":"integer",
            "description":"Indicates the ship from party site ID.",
            "format":"int64"
        },
        "ShipFromPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the ship-from party site."
        },
        "ShipMethodId":{
            "type":"integer",
            "description":"The shipping method such as UPS-Parcel-Ground used for transfer of goods from one destination to another.",
            "format":"int64"
        },
        "ShipMethodCode":{
            "type":"string",
            "description":"Abbreviation that identifies the \nshipping method, such as overnight. Logistics uses this method to transfer goods from one destination to another destination."
        },
        "ShipSetName":{
            "type":"string",
            "description":"Group of sales order lines that need to ship together from their common origin to a common destination."
        },
        "ShipToLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the ship-to location."
        },
        "ShipToLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the ship-to location."
        },
        "ShipToLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the ship-to location."
        },
        "ShipToLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the ship-to location."
        },
        "ShipToLocationCity":{
            "type":"string",
            "description":"City of the ship-to location."
        },
        "ShipToLocationCountry":{
            "type":"string",
            "description":"Country of the ship-to location."
        },
        "ShipToLocationCounty":{
            "type":"string",
            "description":"County of the ship-to location."
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"indicates the ship to location ID.",
            "format":"int64"
        },
        "ShipToLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the ship-to location."
        },
        "ShipToLocationProvince":{
            "type":"string",
            "description":"Province of the ship-to location."
        },
        "ShipToLocationState":{
            "type":"string",
            "description":"State of the ship-to location."
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"Indicates the ship to party ID.",
            "format":"int64"
        },
        "ShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-to party."
        },
        "ShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party."
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"Indicates the ship to party site ID.",
            "format":"int64"
        },
        "ShipToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party site."
        },
        "ShipToSiteUseId":{
            "type":"integer",
            "description":"Address of the person or organization party where the goods are being sent.",
            "format":"int64"
        },
        "SkipShippingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to evaluate line level shipping-related charges. Value is either true or false (default)."
        },
        "TaxClassificationCode":{
            "type":"string",
            "description":"Indicates the tax codes or groups defined in Fusion Payables."
        },
        "TaxExemptionCertificateNumber":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Abbreviation that identifies the tax exemption reason.? You can use it with the Tax Exemption Certificate Number to handle tax exemption."
        },
        "ThirdPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Indicates the Tax Registration Number used by the third party involved in the transaction.",
            "format":"int64"
        },
        "ThirdPartyTaxRegistrationNumber":{
            "type":"string",
            "description":"Tax registration that the third-party organization uses for the transaction."
        },
        "TradingHQLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the trading headquarters location."
        },
        "TradingHQLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the trading headquarters location."
        },
        "TradingHQLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the trading headquarters location."
        },
        "TradingHQLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the trading headquarters location."
        },
        "TradingHQLocationCity":{
            "type":"string",
            "description":"City of the trading headquarters location."
        },
        "TradingHQLocationCountry":{
            "type":"string",
            "description":"Country of the trading headquarters location."
        },
        "TradingHQLocationCounty":{
            "type":"string",
            "description":"County of the trading headquarters location."
        },
        "TradingHQLocationId":{
            "type":"integer",
            "description":"indicates the trading HQ location ID.",
            "format":"int64"
        },
        "TradingHQLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the trading headquarters location."
        },
        "TradingHQLocationProvince":{
            "type":"string",
            "description":"Province of the trading headquarters location."
        },
        "TradingHQLocationState":{
            "type":"string",
            "description":"State of the trading headquarters location."
        },
        "TradingHQPartySiteId":{
            "type":"integer",
            "description":"indicates the trading HQ party site ID.",
            "format":"int64"
        },
        "TradingHQPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the site where the trading headquarters party resides."
        },
        "TransactionBusinessCategory":{
            "type":"string",
            "description":"Classifies a transaction for tax purposes, as required by a tax authority."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "UserDefinedFiscalClassificationCode":{
            "type":"string",
            "description":"Additional classification of a transaction for tax purpose, as required by a tax authority."
        }
    },
    "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
    "xml":{
        "name":"LineType"
    }
}

Nested Schema : AssessableValue

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Currency code of the assessable value."
        }
    }
}

Nested Schema : ExtendedQuantity

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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. "
        },
        "UomCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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."
        },
        "UomCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the unit quantity per root model for the lines of a configuration."
        },
        "UomCode":{
            "type":"string",
            "description":"Indicates the unit quantity per root model for the lines of a configuration."
        }
    }
}

Nested Schema : ServiceDuration

Type: object

Show Source

• UomCode: string
  UOM code of service duration.
• Value: number
  Duration for the service.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Duration for the service."
        },
        "UomCode":{
            "type":"string",
            "description":"UOM code of service duration."
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transactional item attribute.",
            "format":"int64"
        },
        "AttributeValue":{
            "type":"string",
            "description":"Attribute value. (Obsolete)."
        },
        "DataTypeCode":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Value of the transactional item attribute when the datatype is Date."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "InternalName":{
            "type":"string",
            "description":"Internal name of the transactional item attribute."
        },
        "LineAttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies line attribute.",
            "format":"int64"
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies line.",
            "format":"int64"
        },
        "NumberValue":{
            "type":"number",
            "description":"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":{
            "type":"string",
            "description":"Value of the transactional item attribute when the datatype is Timestamp."
        },
        "VarcharValue":{
            "type":"string",
            "description":"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."
        }
    },
    "description":"Values that store the transaction item attributes. This attribute is used only for input.",
    "xml":{
        "name":"LineAttributeType"
    }
}

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

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "type":"string",
            "description":"The unique code of a pricing charge definition."
        },
        "ChargeId":{
            "type":"integer",
            "description":"The source application charge ID of the charge component being validated.",
            "format":"int64"
        },
        "ConstrainingUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The unit price of the constraining value."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Currency the constraining value is in."
                }
            }
        },
        "ConstrainingValue":{
            "type":"number",
            "description":"The constraining value for percentage-based or amount-based guidelines. \n\n"
        },
        "ConstrainingValueCurrencyCode":{
            "type":"string",
            "description":"The currency code for the constraining value"
        },
        "ConstrainingValueType":{
            "type":"string",
            "description":"The type of a constraining value,such as percentage based or amount based."
        },
        "Explanation":{
            "type":"string",
            "description":"The explanation message that provides details of a validation."
        },
        "ExplanationMessageName":{
            "type":"string",
            "description":"The name of an explanation message."
        },
        "HeaderCurrencyCode":{
            "type":"string",
            "description":"Indicates the header currency"
        },
        "HeaderCurrencyConstrainingAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
                }
            }
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"The ID of a manual price adjustment associated with a parent entity.  ",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"The parent entity code to which a price validation record belongs."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"The parent entity ID to which a price validation record belongs.",
            "format":"int64"
        },
        "PricePeriodicityCode":{
            "type":"string",
            "description":"The periodicity of the Recurring  and Recurring Usage price types.\n\n"
        },
        "PriceValidationId":{
            "type":"integer",
            "description":"The primary key of the SDO record.",
            "format":"int64"
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Indicates whether a validation is for a rolled-up charge."
        },
        "ValidationComponentCode":{
            "type":"string",
            "description":"The charge component or total against which the guideline is evaluated."
        },
        "ValidationComponentEntityId":{
            "type":"integer",
            "description":"The charge component ID or total ID against which the guideline is evaluated.",
            "format":"int64"
        },
        "ValidationComponentEntityType":{
            "type":"string",
            "description":"The type of component entity against which the guideline is evaluated- Charge Component or Total"
        },
        "ValidationSourceRuleId":{
            "type":"integer",
            "description":"The ID of a source rule evaluated for a price validation record.\n\n",
            "format":"int64"
        },
        "ValidationSourceTypeCode":{
            "type":"string",
            "description":"The source type of a price validation record. Values include Charge Guideline, Total Guideline, Floor Price, and GSA Price."
        },
        "ValidationStatus":{
            "type":"string",
            "description":"Indicates whether a price validation has failed or passed."
        },
        "ViolationTypeCode":{
            "type":"string",
            "description":"The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATIONS_TYPES"
        }
    },
    "description":"This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.",
    "xml":{
        "name":"PriceValidationType"
    }
}

Nested Schema : ConstrainingUnitPrice

Type: object

Show Source

• CurrencyCode: string
  Currency the constraining value is in.
• Value: number
  The unit price of the constraining value.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The unit price of the constraining value."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Currency the constraining value is in."
        }
    }
}

Nested Schema : HeaderCurrencyConstrainingAmount

Type: object

Show Source

• CurrencyCode: string
  The constraining value calculated for the ValidationComponentCode attribute.
• Value: number
  The constraining value calculated for the ValidationComponentCode attribute.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "Explanation":{
            "type":"string",
            "description":"Explanation message for the violation"
        },
        "GuidelineRuleId":{
            "type":"integer",
            "description":"Id of the guideline that caused the violation record.\n\n",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"The parent entity type code of the record that caused the violation. Value is CHARGE_COMPONENT"
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"The Id of the SDO record that caused the violation.",
            "format":"int64"
        },
        "PriceViolationId":{
            "type":"integer",
            "description":"Id of the PriceViolation SDO entity.",
            "format":"int64"
        },
        "PriceViolationTypeCode":{
            "type":"string",
            "description":"This attribute indicates the violation type. Values include: ALERT, APPROVAL_REQUIRED, REJECTED"
        },
        "ValidationTypeCode":{
            "type":"string",
            "description":"The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATION_TYPES."
        }
    },
    "description":"This entity is an output from Pricing. It stores the guidelines violated in the pricing process.",
    "xml":{
        "name":"PriceViolationType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the error message."
        },
        "MessageSourceCode":{
            "type":"string",
            "description":"Abbreviation that indicates the source of the message."
        },
        "MessageText":{
            "type":"string",
            "description":"Text describing the nature of the error that occurred."
        },
        "MessageTypeCode":{
            "type":"string",
            "description":"Value that indicates the type of message. A list of accepted values is defined in the lookup type MESSAGE_TYPE."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Abbreviation that indicates the parent entity of the error. Values include Line, Charge, and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        },
        "PricingMessageId":{
            "type":"integer",
            "description":"The unique key of this error.",
            "format":"int64"
        }
    },
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "xml":{
        "name":"PricingMessageType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "ValidationMode":{
            "type":"string",
            "description":"Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only."
        },
        "ValidationLevel":{
            "type":"string",
            "description":"Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only."
        },
        "OutputStatus":{
            "type":"string",
            "description":"Value that indicates the output status. Values include Success or Error."
        },
        "PerformValueIdConversionsFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER."
        },
        "ProcessingMessage":{
            "type":"string",
            "description":"Message generated for the transaction when the output status is set to Error."
        }
    },
    "description":"This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.",
    "xml":{
        "name":"PricingServiceParameterType"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sales Prices Validated successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Header":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPHeaderType"
            }
        },
        "PriceViolation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPriceViolationType"
            }
        },
        "PricingMessage":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPricingMessageType"
            }
        },
        "PricingServiceParameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPricingServiceParameterType"
            }
        },
        "Line":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPLineType"
            }
        },
        "Charge":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChargeType"
            }
        },
        "LineAttribute":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPLineAttributeType"
            }
        },
        "ChargeComponent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChargeComponentType"
            }
        },
        "PriceValidation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPPriceValidationType"
            }
        },
        "ChangeSummary":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VSPChangeSummaryType"
            }
        }
    }
}

Nested Schema : ChangeSummary

Type: array

Show Source

• Array of: object ChangeSummaryType
  Values that store the summary of the changes.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChangeSummaryType"
    }
}

Nested Schema : Charge

Type: array

Show Source

• Array of: object ChargeType
  Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChargeType"
    }
}

Nested Schema : ChargeComponent

Type: array

Show Source

• Array of: object ChargeComponentType
  Stores the price elements for each charge applied within the pricing process.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPChargeComponentType"
    }
}

Nested Schema : Header

Type: array

Show Source

• Array of: object HeaderType
  Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPHeaderType"
    }
}

Nested Schema : Line

Type: array

Show Source

• Array of: object LineType
  Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPLineType"
    }
}

Nested Schema : LineAttribute

Type: array

Show Source

• Array of: object LineAttributeType
  Values that store the transaction item attributes. This attribute is used only for input.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPLineAttributeType"
    }
}

Nested Schema : PriceValidation

Type: array

Show Source

• Array of: object PriceValidationType
  This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPriceValidationType"
    }
}

Nested Schema : PriceViolation

Type: array

Show Source

• Array of: object PriceViolationType
  This entity is an output from Pricing. It stores the guidelines violated in the pricing process.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPriceViolationType"
    }
}

Nested Schema : PricingMessage

Type: array

Show Source

• Array of: object PricingMessageType
  This entity contains one instance for each pricing error found on the transaction.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPricingMessageType"
    }
}

Nested Schema : PricingServiceParameter

Type: array

Show Source

• Array of: object PricingServiceParameterType
  This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VSPPricingServiceParameterType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "CanAdjustFlag":{
            "type":"boolean",
            "description":"The flag from pricelist/shippingPolicy admin indicating whether this price can be discounted."
        },
        "ChargeAppliesTo":{
            "type":"string",
            "description":"Indicates the type of charge (Price, Return, or Shipping)"
        },
        "ChargeDefinitionCode":{
            "type":"string",
            "description":"Unique Code of the Pricing Charge Definition"
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"Id of the charge definition entity.",
            "format":"int64"
        },
        "ChargeId":{
            "type":"integer",
            "description":"Charge Id",
            "format":"int64"
        },
        "ChargeSubtypeCode":{
            "type":"string",
            "description":"Subtype of a given charge type."
        },
        "ChargeTypeCode":{
            "type":"string",
            "description":"Type of a given charge."
        },
        "CoverageDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage duration of a charge that applies to a coverage association."
                },
                "UomCode":{
                    "type":"string",
                    "description":"UOM code of the coverage duration."
                }
            }
        },
        "CoverageDurationUOMCode":{
            "type":"string",
            "description":"Indicates the coverage duration unit of measure used to calculate the coverage extended amount that applies to a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the currency used in the charge"
        },
        "EstimatedPricedQuantityFlag":{
            "type":"boolean",
            "description":"This attribute indicates whether the priced quantity is an estimated number."
        },
        "EstimatedUnitPriceFlag":{
            "type":"boolean",
            "description":"This attribute indicates whether the unit price is an estimated number."
        },
        "FloorUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
                }
            }
        },
        "GSAUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
                }
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Indicates the Line ID of the parent line of a charge.",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Parent entity of the charge. Values include Line and Line Coverage "
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Id of the parent entity of the charge.",
            "format":"int64"
        },
        "PricePeriodicityCode":{
            "type":"string",
            "description":"Indidates periodicty for both recurring  and recurring usage price types"
        },
        "PriceTypeCode":{
            "type":"string",
            "description":"Price type of a given charge."
        },
        "PricedQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
                },
                "UomCode":{
                    "type":"string",
                    "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
                }
            }
        },
        "PricedQuantityUOMCode":{
            "type":"string",
            "description":"UOM code for priced quantity, for example 'Ton'. Values for this attribute will come either from PIM or the reciprocal service QOC provides."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates whether this charge is the primary charge."
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Marks a charge as a rollup/aggregate charge."
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The value of this attribute indicates the sequence number for the charge.",
            "format":"int64"
        },
        "SourceChargeId":{
            "type":"integer",
            "description":"Indicates the ID of a source charge created by an external pricing engine.",
            "format":"int64"
        },
        "TaxIncludedFlag":{
            "type":"boolean",
            "description":"Indicates whether the charge includes tax."
        },
        "UsagePeriodCode":{
            "type":"string",
            "description":"Usage period code for the estimated usage quantity."
        },
        "UsageUOMCode":{
            "type":"string",
            "description":"Usage uom code for the estimated usage quantity."
        }
    },
    "description":"Represents a charge calculated within the pricing process or a charge that is passed to QP by consuming applications.",
    "xml":{
        "name":"ChargeType"
    }
}

Nested Schema : CoverageDuration

Type: object

Show Source

• UomCode: string
  UOM code of the coverage duration.
• Value: number
  Indicates the coverage duration of a charge that applies to a coverage association.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage duration of a charge that applies to a coverage association."
        },
        "UomCode":{
            "type":"string",
            "description":"UOM code of the coverage duration."
        }
    }
}

Nested Schema : FloorUnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Unit price amount derived from a matching floor price list on the strategy for the current transaction."
        }
    }
}

Nested Schema : GSAUnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Unit price amount derived from a matching GSA price list on the strategy for the current transaction."
        }
    }
}

Nested Schema : PricedQuantity

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf price type is not usage nor recurring usage, PricedQuantity = Line.RequestedQuantity for simple products, PricedQuantity = Estimated Usage Quantity * Line.ExtendedQuantity for CP"
        },
        "UomCode":{
            "type":"string",
            "description":"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\n-If  ?IsPerUnitUsage? = FALSE, pricedQuantity = Estimated Usage Quantity\nIf 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

{
    "type":"object",
    "properties":{
        "AggregateChargeComponentId":{
            "type":"integer",
            "description":"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.",
            "format":"int64"
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"Charge Component Id",
            "format":"int64"
        },
        "ChargeId":{
            "type":"integer",
            "description":"chargeId on which price/adjustment applied to",
            "format":"int64"
        },
        "CoverageExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
                }
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the currency used in the charge component. Needed due to service standardization."
        },
        "Explanation":{
            "type":"string",
            "description":"Message for display in a price breakdown or PWF UI."
        },
        "ExplanationMessageName":{
            "type":"string",
            "description":"The name of an explanation message."
        },
        "ExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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. "
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"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. "
                }
            }
        },
        "HeaderCurrencyCode":{
            "type":"string",
            "description":"Indicates the header currency. Needed due to service standardization."
        },
        "HeaderCurrencyCoverageExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
                }
            }
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"This attribute indicates the extended amount in header currency"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The currency of header."
                }
            }
        },
        "HeaderCurrencyUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"This attribute indicates the unit price in header currency"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"This attribute indicates the unit price in header currency"
                }
            }
        },
        "PercentOfComparisonElement":{
            "type":"number",
            "description":"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":{
            "type":"string",
            "description":"Element reference to the Price Elements setup eg. LISTPRICE, NETPRICE etc."
        },
        "PriceElementUsageCode":{
            "type":"string",
            "description":"Used by consuming applications to indicate how the charge component will be used. Values of this attribute will come from a QP lookup. "
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Marks a charge component as a rollup/aggregate value for the charge component price element code."
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int64"
        },
        "SourceChargeComponentId":{
            "type":"string",
            "description":"Indicates the ID of a source charge component created by an external pricing engine."
        },
        "SourceChargeId":{
            "type":"string",
            "description":"Indicates the ID of a source charge created by an external pricing engine."
        },
        "SourceId":{
            "type":"integer",
            "description":"Identifies the lowest level pricing source, e.g., price list line, tier rule, CP rule, formula, AP, shipping line, etc.",
            "format":"int64"
        },
        "SourceParentChargeComponentId":{
            "type":"string",
            "description":"Indicates the ID of a source parent charge component created by an external pricing engine."
        },
        "SourceTypeCode":{
            "type":"string",
            "description":"Type of the Pricing source eg. Segment Price List Line etc. The values are from the lookup QP_ENTITY_TYPES plus manual adjustment."
        },
        "TaxIncludedFlag":{
            "type":"boolean",
            "description":"Indicates whether a tax is included for a given charge component."
        },
        "UnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The price or adjustment per unit in the charge currency for the line UOM."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The price or adjustment per unit in the charge currency for the line UOM."
                }
            }
        }
    },
    "description":"Stores the price elements for each charge applied within the pricing process.",
    "xml":{
        "name":"ChargeComponentType"
    }
}

Nested Schema : CoverageExtendedAmount

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the coverage extended amount used for the entire service duration of a coverage association."
        }
    }
}

Nested Schema : ExtendedAmount

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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. "
        },
        "CurrencyCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Indicates the coverage extended amount in the header currency for the entire service duration of a coverage association."
        }
    }
}

Nested Schema : HeaderCurrencyExtendedAmount

Type: object

Show Source

• CurrencyCode: string
  The currency of header.
• Value: number
  This attribute indicates the extended amount in header currency

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"This attribute indicates the extended amount in header currency"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency of header."
        }
    }
}

Nested Schema : HeaderCurrencyUnitPrice

Type: object

Show Source

• CurrencyCode: string
  This attribute indicates the unit price in header currency
• Value: number
  This attribute indicates the unit price in header currency

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"This attribute indicates the unit price in header currency"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"This attribute indicates the unit price in header currency"
        }
    }
}

Nested Schema : UnitPrice

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The price or adjustment per unit in the charge currency for the line UOM."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "properties":{
        "AllowCurrencyOverrideFlag":{
            "type":"boolean",
            "description":"Indicate whether the currency can be overridden."
        },
        "AppliedCurrencyCode":{
            "type":"string",
            "description":"Currency code to be used as the default header currency."
        },
        "BillToCustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Indicates the bill to customer account site use ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountId":{
            "type":"integer",
            "description":"Indicates the billing third-party account ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountName":{
            "type":"string",
            "description":"Name of the third-party account that pricing uses in tax calculations for billing."
        },
        "BillingThirdPartyAccountNumber":{
            "type":"string",
            "description":"Number that identifies the third-party account that pricing uses in tax calculations for billing."
        },
        "BillingThirdPartyAccountSiteId":{
            "type":"integer",
            "description":"Indicates the billing third-party account site ID, used in tax calculations.",
            "format":"int64"
        },
        "BillingThirdPartyAccountSiteNumber":{
            "type":"string",
            "description":"Number that identifies the third-party account that pricing uses in tax calculations for billing."
        },
        "CalculatePricingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to price charges for a line item. Value is true (default) or false."
        },
        "CalculateShippingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to evaluate shipping-related charges for the document. Value is either true (default) or false."
        },
        "CalculateTaxFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"integer",
            "description":"Sold To Customer Id.",
            "format":"int64"
        },
        "CustomerName":{
            "type":"string",
            "description":"The Party Name in Customer Data Management provides this name."
        },
        "CustomerNumber":{
            "type":"string",
            "description":"The Party Number in Customer Data Management provides this number."
        },
        "CustomerTypeCode":{
            "type":"string",
            "description":"Indicates whether customer is internal or external."
        },
        "DefaultCurrencyCode":{
            "type":"string",
            "description":"The purpose of this is to retain the original currency  returned for the strategy.  "
        },
        "EndCustomerId":{
            "type":"integer",
            "description":"Id of the customer who receives the item.",
            "format":"int64"
        },
        "EndCustomerName":{
            "type":"string",
            "description":"Name of the customer who receives the item. The Party Name in Customer Data Management provides this name."
        },
        "EndCustomerNumber":{
            "type":"string",
            "description":"Number that identifies the customer who receives the item. The Party Number in Customer Data Management provides this number."
        },
        "FulfillmentGeographyId":{
            "type":"integer",
            "description":"This will be either null (initially), or specified (when selected on SO or derived from SO Shipment.Ship To Address Id).",
            "format":"int64"
        },
        "FulfillmentGeographyName":{
            "type":"string",
            "description":"Name of the fulfillment geography."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Header Id.",
            "format":"int64"
        },
        "InternalOrganizationLocationId":{
            "type":"integer",
            "description":"Indicates the internal organziation location ID.",
            "format":"int64"
        },
        "LedgerId":{
            "type":"integer",
            "description":"Indicates the ledger ID.",
            "format":"int64"
        },
        "LedgerName":{
            "type":"string",
            "description":"Name of the ledger."
        },
        "OverrideCurrencyCode":{
            "type":"string",
            "description":"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":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Price as of date."
        },
        "PriceValidFrom":{
            "type":"string",
            "description":"Price valid from date."
        },
        "PriceValidUntil":{
            "type":"string",
            "description":"Price valid until date."
        },
        "PricedOn":{
            "type":"string",
            "description":"The date when the document is priced. This attribute will be populated with the system date at the beginning of a pricing process."
        },
        "PricingSegmentCode":{
            "type":"string",
            "description":"This attribute stores either the pricing segment code passed in from the caller or the pricing segment code derived by the pricing engine."
        },
        "PricingSegmentExplanation":{
            "type":"string",
            "description":"Message to state why the Pricing Segment has been applied."
        },
        "PricingStrategyExplanation":{
            "type":"string",
            "description":"Message to state why the Pricing Strategy has been applied."
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"This attribute stores either the pricing strategy id passed in from the caller or the pricing strategy id derived by the pricing engine.",
            "format":"int64"
        },
        "PricingStrategyName":{
            "type":"string",
            "description":"The name of the pricing strategy. The caller provides the name or pricing determines the name."
        },
        "RoundingBillToPartyId":{
            "type":"integer",
            "description":"Indicates the bill to party ID used for rounding in tax calculations.",
            "format":"int64"
        },
        "RoundingBillToPartyName":{
            "type":"string",
            "description":"Name that identifies the bill-to party to use when rounding a number during a tax calculation."
        },
        "RoundingBillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party to use when rounding a number during a tax calculation. "
        },
        "RoundingBillToPartySiteId":{
            "type":"integer",
            "description":"Indicates the bill to party site ID used for rounding in tax calculations.",
            "format":"int64"
        },
        "RoundingBillToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party site to use when rounding a number during a tax calculation."
        },
        "RoundingShipToPartyId":{
            "type":"integer",
            "description":"Indicates the ship to party ID used for rounding in tax calcuations.",
            "format":"int64"
        },
        "RoundingShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-to party to use when rounding a number during a tax calculation."
        },
        "RoundingShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party to use when rounding a number during a tax calculation."
        },
        "SalesChannelCode":{
            "type":"string",
            "description":"Sales Channel code."
        },
        "SalesSubChannelCode":{
            "type":"string",
            "description":"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":{
            "type":"integer",
            "description":"Selling business unit id",
            "format":"int64"
        },
        "SellingBusinessUnitName":{
            "type":"string",
            "description":"Name of the selling business unit."
        },
        "SellingLegalEntityId":{
            "type":"integer",
            "description":"Selling legal entity id.",
            "format":"int64"
        },
        "SellingLegalEntityIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the selling legal entity that pricing uses for tax calculations."
        },
        "TotalGroupEntityCode":{
            "type":"string",
            "description":"Entities for which a Total is calculated.Values of the attribute are from the ORA_QP_TOTAL_ENTITY_TYPES lookup."
        },
        "TotalUsageCode":{
            "type":"string",
            "description":"Usage based on which a Total is calculated. Value of the attribute is from the ORA_QP_TOTAL_USAGE_TYPES lookup."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "TransactionTypeCode":{
            "type":"string",
            "description":"Indicates the transaction type of the passed in document. Transaction Types include QUOTE, ORDER, etc."
        }
    },
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "xml":{
        "name":"HeaderType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "type":"string",
            "description":"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":{
            "type":"boolean",
            "description":"Indicate whether the currency can be overridden."
        },
        "AllowPriceListUpdateFlag":{
            "type":"boolean",
            "description":"Indicate whether a previously selected price list can be changed to a different price list."
        },
        "AppliedPriceListId":{
            "type":"integer",
            "description":"Id of the price list applied.",
            "format":"int64"
        },
        "AppliedShippingChargeListId":{
            "type":"integer",
            "description":"Id of the shipping charge list applied.",
            "format":"int64"
        },
        "AssessableValue":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Currency code of the assessable value."
                }
            }
        },
        "AssessableValueCurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the currency of the assessable value."
        },
        "AssessableValueOverrideFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Address line 1 of the bill-from location."
        },
        "BillFromLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the bill-from location."
        },
        "BillFromLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the bill-from location."
        },
        "BillFromLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the bill-from location."
        },
        "BillFromLocationCity":{
            "type":"string",
            "description":"City of the bill-from location."
        },
        "BillFromLocationCountry":{
            "type":"string",
            "description":"Country of the bill-from location."
        },
        "BillFromLocationCounty":{
            "type":"string",
            "description":"County of the bill-from location."
        },
        "BillFromLocationId":{
            "type":"integer",
            "description":"Indicates the bill from location ID.",
            "format":"int64"
        },
        "BillFromLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the bill-from location."
        },
        "BillFromLocationProvince":{
            "type":"string",
            "description":"Province of the bill-from location."
        },
        "BillFromLocationState":{
            "type":"string",
            "description":"State of the bill-from location."
        },
        "BillToLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the bill-to location."
        },
        "BillToLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the bill-to location."
        },
        "BillToLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the bill-to location."
        },
        "BillToLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the bill-to location."
        },
        "BillToLocationCity":{
            "type":"string",
            "description":"City of the bill-to location."
        },
        "BillToLocationCountry":{
            "type":"string",
            "description":"Country of the bill-to location."
        },
        "BillToLocationCounty":{
            "type":"string",
            "description":"County of the bill-to location."
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Indicates the bill to location ID.",
            "format":"int64"
        },
        "BillToLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the bill-to location."
        },
        "BillToLocationProvince":{
            "type":"string",
            "description":"Province of the bill-to location."
        },
        "BillToLocationState":{
            "type":"string",
            "description":"State of the bill-to location."
        },
        "BillToPartyId":{
            "type":"integer",
            "description":"Indicates the bill to party ID.",
            "format":"int64"
        },
        "BillToPartyName":{
            "type":"string",
            "description":"Name that identifies the bill-to party."
        },
        "BillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party."
        },
        "BillToPartySiteId":{
            "type":"integer",
            "description":"indicates the bill to party site ID.",
            "format":"int64"
        },
        "BillToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the bill-to party site."
        },
        "ComponentIdPath":{
            "type":"string",
            "description":"Item ID path for component items.  Contains the Root Model Inventory Item Id to the immediate parent Inventory Item Id delimited with '>'"
        },
        "ComponentPath":{
            "type":"string",
            "description":"Item Number path for component items.  Contains the Root Model Item Number to the immediate parent Item Number delimited with '>'"
        },
        "DefaultCurrencyCode":{
            "type":"string",
            "description":"Default currency code for the line. For R11, the Default Currency is determined at the header level for the strategy. "
        },
        "DefaultPriceListId":{
            "type":"integer",
            "description":"Id of the default price list.",
            "format":"int64"
        },
        "DefaultTaxationCountry":{
            "type":"string",
            "description":"Specifies the country of taxation for tax calculation purposes."
        },
        "DocumentSubType":{
            "type":"string",
            "description":"Classification used for both tax calculation and tax reporting depending upon the requirements of different countries."
        },
        "ExemptionControlCode":{
            "type":"string",
            "description":"Controls the application of exemptions to the transaction line during tax lines calculation."
        },
        "ExtendedQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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. "
                },
                "UomCode":{
                    "type":"string",
                    "description":"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. "
                }
            }
        },
        "FinalDischargeLocationId":{
            "type":"integer",
            "description":"Indicates the location of the final destination for purchases made by a customer, and is applicable to all transactions at line level.",
            "format":"int64"
        },
        "FirstPartyTaxRegistration":{
            "type":"string",
            "description":"Tax registration that the first-party organization uses for the transaction."
        },
        "FirstPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Indicates the tax registration that the first party organization used for a transaction.",
            "format":"int64"
        },
        "FOBCode":{
            "type":"string",
            "description":"Code that indicates freight on board."
        },
        "FulfillmentGeographyId":{
            "type":"integer",
            "description":"This attribute represents the geography ID of the fulfillment.",
            "format":"int64"
        },
        "HeaderId":{
            "type":"integer",
            "description":"HeaderId reference for the Line",
            "format":"int64"
        },
        "IntendedUseClassificationId":{
            "type":"integer",
            "description":"Indicates the classification purpose for which a product is used in a business by the purchaser. ",
            "format":"int64"
        },
        "IntendedUseClassificationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the classification that describes how the purchaser intends to use the item."
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Item to be Priced.",
            "format":"int64"
        },
        "InventoryItemNumber":{
            "type":"string",
            "description":"The number of the item that pricing must price."
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"The Inventory Org Id for this Inventory Item. ",
            "format":"int64"
        },
        "InventoryOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that the Inventory Item Number references."
        },
        "LineCategoryCode":{
            "type":"string",
            "description":"Identifies the category of the line. "
        },
        "LineId":{
            "type":"integer",
            "description":"Line Id.",
            "format":"int64"
        },
        "LineQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"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."
                },
                "UomCode":{
                    "type":"string",
                    "description":"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."
                }
            }
        },
        "LineQuantityUOMCode":{
            "type":"string",
            "description":"The requested UOM."
        },
        "LineTypeCode":{
            "type":"string",
            "description":"This identifies the action performed when the order line is fulfilled. "
        },
        "OverrideCurrencyCode":{
            "type":"string",
            "description":"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":{
            "type":"integer",
            "description":"If allowed by pricing, this is the price list that  user selects to override the price to for a particular line item.",
            "format":"int64"
        },
        "OverridePriceListName":{
            "type":"string",
            "description":"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.\n"
        },
        "PerModelUnitQuantity":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Indicates the unit quantity per root model for the lines of a configuration."
                },
                "UomCode":{
                    "type":"string",
                    "description":"Indicates the unit quantity per root model for the lines of a configuration."
                }
            }
        },
        "PooLocationId":{
            "type":"integer",
            "description":"Indicates the location that initiates or negotiates a sales order for products and services.? This ID represents the Point of Order Origin location.",
            "format":"int64"
        },
        "PooPartyId":{
            "type":"integer",
            "description":"Indicates the party that initiates or negotiates a sales order for products and services. This ID represents the Point of Order Origin party identifier.",
            "format":"int64"
        },
        "PooPartyName":{
            "type":"string",
            "description":"Name that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item."
        },
        "PooPartyNumber":{
            "type":"string",
            "description":"Number that identifies the Point of Order Origin party. This party starts or negotiates a sales order for an item. "
        },
        "PriceAsOf":{
            "type":"string",
            "description":"This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines."
        },
        "PriceValidFrom":{
            "type":"string",
            "description":"Price valid from date."
        },
        "PriceValidUntil":{
            "type":"string",
            "description":"Price valid until date."
        },
        "PricedOn":{
            "type":"string",
            "description":"The date when the line is priced. This attribute will be populated with the system date at the beginning of a pricing process."
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"Id of the pricing strategy applied on this line",
            "format":"int64"
        },
        "PricingStrategyName":{
            "type":"string",
            "description":"Name of the pricing strategy that pricing applied on this line."
        },
        "ProductCategory":{
            "type":"string",
            "description":"Classification of products as product categories for tax purposes.  "
        },
        "ProductFiscalClassificationId":{
            "type":"integer",
            "description":"Classification of products based on the inventory item category for tax purposes.",
            "format":"int64"
        },
        "ProductType":{
            "type":"string",
            "description":"Classification of products as product types for tax purposes."
        },
        "ReferenceLineId":{
            "type":"integer",
            "description":"Indicates the order line to be used as reference in returns pricing processing.",
            "format":"int64"
        },
        "ReturnReasonCode":{
            "type":"string",
            "description":"Indicates the return reason code."
        },
        "RootCoverageLineId":{
            "type":"integer",
            "description":"Indicates the root coverage line in the hierarchy.",
            "format":"int64"
        },
        "RootLineId":{
            "type":"integer",
            "description":"Top most root line Id. ",
            "format":"int64"
        },
        "RoundingBillToPartyId":{
            "type":"integer",
            "description":"Indicates the rounding bill to party ID.",
            "format":"int64"
        },
        "RoundingBillToPartyName":{
            "type":"string",
            "description":"Name that identifies the rounding bill-to party."
        },
        "RoundingBillToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the rounding bill-to party."
        },
        "RoundingShipToPartyId":{
            "type":"integer",
            "description":"Indicates the rounding ship to party ID.",
            "format":"int64"
        },
        "RoundingShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the rounding ship-to party."
        },
        "RoundingShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the rounding ship-to party."
        },
        "ServiceEndDate":{
            "type":"string",
            "description":"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."
        },
        "ServiceDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"Duration for the service."
                },
                "UomCode":{
                    "type":"string",
                    "description":"UOM code of service duration."
                }
            }
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "ServiceStartDate":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Address line 1 of the ship-from location."
        },
        "ShipFromLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the ship-from location."
        },
        "ShipFromLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the ship-from location."
        },
        "ShipFromLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the ship-from location."
        },
        "ShipFromLocationCity":{
            "type":"string",
            "description":"City of the ship-from location."
        },
        "ShipFromLocationCountry":{
            "type":"string",
            "description":"Country of the ship-from location."
        },
        "ShipFromLocationCounty":{
            "type":"string",
            "description":"County of the ship-from location."
        },
        "ShipFromLocationId":{
            "type":"integer",
            "description":"Indicates the ship from location ID.",
            "format":"int64"
        },
        "ShipFromLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the ship-from location."
        },
        "ShipFromLocationProvince":{
            "type":"string",
            "description":"Province of the ship-from location."
        },
        "ShipFromLocationState":{
            "type":"string",
            "description":"State of the ship-from location."
        },
        "ShipFromOrganizationId":{
            "type":"integer",
            "description":"Organization from where the goods are shipped.",
            "format":"int64"
        },
        "ShipFromOrganizationCode":{
            "type":"string",
            "description":"Organization from where logistics ships the goods."
        },
        "ShipFromPartyId":{
            "type":"integer",
            "description":"Indicates the ship from party ID.",
            "format":"int64"
        },
        "ShipFromPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-from party."
        },
        "ShipFromPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-from party."
        },
        "ShipFromPartySiteId":{
            "type":"integer",
            "description":"Indicates the ship from party site ID.",
            "format":"int64"
        },
        "ShipFromPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the ship-from party site."
        },
        "ShipMethodId":{
            "type":"integer",
            "description":"The shipping method such as UPS-Parcel-Ground used for transfer of goods from one destination to another.",
            "format":"int64"
        },
        "ShipMethodCode":{
            "type":"string",
            "description":"Abbreviation that identifies the \nshipping method, such as overnight. Logistics uses this method to transfer goods from one destination to another destination."
        },
        "ShipSetName":{
            "type":"string",
            "description":"Group of sales order lines that need to ship together from their common origin to a common destination."
        },
        "ShipToLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the ship-to location."
        },
        "ShipToLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the ship-to location."
        },
        "ShipToLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the ship-to location."
        },
        "ShipToLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the ship-to location."
        },
        "ShipToLocationCity":{
            "type":"string",
            "description":"City of the ship-to location."
        },
        "ShipToLocationCountry":{
            "type":"string",
            "description":"Country of the ship-to location."
        },
        "ShipToLocationCounty":{
            "type":"string",
            "description":"County of the ship-to location."
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"indicates the ship to location ID.",
            "format":"int64"
        },
        "ShipToLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the ship-to location."
        },
        "ShipToLocationProvince":{
            "type":"string",
            "description":"Province of the ship-to location."
        },
        "ShipToLocationState":{
            "type":"string",
            "description":"State of the ship-to location."
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"Indicates the ship to party ID.",
            "format":"int64"
        },
        "ShipToPartyName":{
            "type":"string",
            "description":"Name that identifies the ship-to party."
        },
        "ShipToPartyNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party."
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"Indicates the ship to party site ID.",
            "format":"int64"
        },
        "ShipToPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the ship-to party site."
        },
        "ShipToSiteUseId":{
            "type":"integer",
            "description":"Address of the person or organization party where the goods are being sent.",
            "format":"int64"
        },
        "SkipShippingChargesFlag":{
            "type":"boolean",
            "description":"Determines whether or not to evaluate line level shipping-related charges. Value is either true or false (default)."
        },
        "TaxClassificationCode":{
            "type":"string",
            "description":"Indicates the tax codes or groups defined in Fusion Payables."
        },
        "TaxExemptionCertificateNumber":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Abbreviation that identifies the tax exemption reason.? You can use it with the Tax Exemption Certificate Number to handle tax exemption."
        },
        "ThirdPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Indicates the Tax Registration Number used by the third party involved in the transaction.",
            "format":"int64"
        },
        "ThirdPartyTaxRegistrationNumber":{
            "type":"string",
            "description":"Tax registration that the third-party organization uses for the transaction."
        },
        "TradingHQLocationAddress1":{
            "type":"string",
            "description":"Address line 1 of the trading headquarters location."
        },
        "TradingHQLocationAddress2":{
            "type":"string",
            "description":"Address line 2 of the trading headquarters location."
        },
        "TradingHQLocationAddress3":{
            "type":"string",
            "description":"Address line 3 of the trading headquarters location."
        },
        "TradingHQLocationAddress4":{
            "type":"string",
            "description":"Address line 4 of the trading headquarters location."
        },
        "TradingHQLocationCity":{
            "type":"string",
            "description":"City of the trading headquarters location."
        },
        "TradingHQLocationCountry":{
            "type":"string",
            "description":"Country of the trading headquarters location."
        },
        "TradingHQLocationCounty":{
            "type":"string",
            "description":"County of the trading headquarters location."
        },
        "TradingHQLocationId":{
            "type":"integer",
            "description":"indicates the trading HQ location ID.",
            "format":"int64"
        },
        "TradingHQLocationPostalCode":{
            "type":"string",
            "description":"Postal code of the trading headquarters location."
        },
        "TradingHQLocationProvince":{
            "type":"string",
            "description":"Province of the trading headquarters location."
        },
        "TradingHQLocationState":{
            "type":"string",
            "description":"State of the trading headquarters location."
        },
        "TradingHQPartySiteId":{
            "type":"integer",
            "description":"indicates the trading HQ party site ID.",
            "format":"int64"
        },
        "TradingHQPartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the site where the trading headquarters party resides."
        },
        "TransactionBusinessCategory":{
            "type":"string",
            "description":"Classifies a transaction for tax purposes, as required by a tax authority."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "UserDefinedFiscalClassificationCode":{
            "type":"string",
            "description":"Additional classification of a transaction for tax purpose, as required by a tax authority."
        }
    },
    "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
    "xml":{
        "name":"LineType"
    }
}

Nested Schema : AssessableValue

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Currency code of the assessable value."
        }
    }
}

Nested Schema : ExtendedQuantity

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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. "
        },
        "UomCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"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."
        },
        "UomCode":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Indicates the unit quantity per root model for the lines of a configuration."
        },
        "UomCode":{
            "type":"string",
            "description":"Indicates the unit quantity per root model for the lines of a configuration."
        }
    }
}

Nested Schema : ServiceDuration

Type: object

Show Source

• UomCode: string
  UOM code of service duration.
• Value: number
  Duration for the service.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"Duration for the service."
        },
        "UomCode":{
            "type":"string",
            "description":"UOM code of service duration."
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transactional item attribute.",
            "format":"int64"
        },
        "AttributeValue":{
            "type":"string",
            "description":"Attribute value. (Obsolete)."
        },
        "DataTypeCode":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Value of the transactional item attribute when the datatype is Date."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "InternalName":{
            "type":"string",
            "description":"Internal name of the transactional item attribute."
        },
        "LineAttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies line attribute.",
            "format":"int64"
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies line.",
            "format":"int64"
        },
        "NumberValue":{
            "type":"number",
            "description":"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":{
            "type":"string",
            "description":"Value of the transactional item attribute when the datatype is Timestamp."
        },
        "VarcharValue":{
            "type":"string",
            "description":"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."
        }
    },
    "description":"Values that store the transaction item attributes. This attribute is used only for input.",
    "xml":{
        "name":"LineAttributeType"
    }
}

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

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "type":"string",
            "description":"The unique code of a pricing charge definition."
        },
        "ChargeId":{
            "type":"integer",
            "description":"The source application charge ID of the charge component being validated.",
            "format":"int64"
        },
        "ConstrainingUnitPrice":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The unit price of the constraining value."
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"Currency the constraining value is in."
                }
            }
        },
        "ConstrainingValue":{
            "type":"number",
            "description":"The constraining value for percentage-based or amount-based guidelines. \n\n"
        },
        "ConstrainingValueCurrencyCode":{
            "type":"string",
            "description":"The currency code for the constraining value"
        },
        "ConstrainingValueType":{
            "type":"string",
            "description":"The type of a constraining value,such as percentage based or amount based."
        },
        "Explanation":{
            "type":"string",
            "description":"The explanation message that provides details of a validation."
        },
        "ExplanationMessageName":{
            "type":"string",
            "description":"The name of an explanation message."
        },
        "HeaderCurrencyCode":{
            "type":"string",
            "description":"Indicates the header currency"
        },
        "HeaderCurrencyConstrainingAmount":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
                }
            }
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"The ID of a manual price adjustment associated with a parent entity.  ",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"The parent entity code to which a price validation record belongs."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"The parent entity ID to which a price validation record belongs.",
            "format":"int64"
        },
        "PricePeriodicityCode":{
            "type":"string",
            "description":"The periodicity of the Recurring  and Recurring Usage price types.\n\n"
        },
        "PriceValidationId":{
            "type":"integer",
            "description":"The primary key of the SDO record.",
            "format":"int64"
        },
        "RollupFlag":{
            "type":"boolean",
            "description":"Indicates whether a validation is for a rolled-up charge."
        },
        "ValidationComponentCode":{
            "type":"string",
            "description":"The charge component or total against which the guideline is evaluated."
        },
        "ValidationComponentEntityId":{
            "type":"integer",
            "description":"The charge component ID or total ID against which the guideline is evaluated.",
            "format":"int64"
        },
        "ValidationComponentEntityType":{
            "type":"string",
            "description":"The type of component entity against which the guideline is evaluated- Charge Component or Total"
        },
        "ValidationSourceRuleId":{
            "type":"integer",
            "description":"The ID of a source rule evaluated for a price validation record.\n\n",
            "format":"int64"
        },
        "ValidationSourceTypeCode":{
            "type":"string",
            "description":"The source type of a price validation record. Values include Charge Guideline, Total Guideline, Floor Price, and GSA Price."
        },
        "ValidationStatus":{
            "type":"string",
            "description":"Indicates whether a price validation has failed or passed."
        },
        "ViolationTypeCode":{
            "type":"string",
            "description":"The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATIONS_TYPES"
        }
    },
    "description":"This entity provides the output of Pricing Validations.In R13, only violations will be returned for each charge component.",
    "xml":{
        "name":"PriceValidationType"
    }
}

Nested Schema : ConstrainingUnitPrice

Type: object

Show Source

• CurrencyCode: string
  Currency the constraining value is in.
• Value: number
  The unit price of the constraining value.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The unit price of the constraining value."
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Currency the constraining value is in."
        }
    }
}

Nested Schema : HeaderCurrencyConstrainingAmount

Type: object

Show Source

• CurrencyCode: string
  The constraining value calculated for the ValidationComponentCode attribute.
• Value: number
  The constraining value calculated for the ValidationComponentCode attribute.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The constraining value calculated  for the ValidationComponentCode attribute.\n"
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "Explanation":{
            "type":"string",
            "description":"Explanation message for the violation"
        },
        "GuidelineRuleId":{
            "type":"integer",
            "description":"Id of the guideline that caused the violation record.\n\n",
            "format":"int64"
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"The parent entity type code of the record that caused the violation. Value is CHARGE_COMPONENT"
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"The Id of the SDO record that caused the violation.",
            "format":"int64"
        },
        "PriceViolationId":{
            "type":"integer",
            "description":"Id of the PriceViolation SDO entity.",
            "format":"int64"
        },
        "PriceViolationTypeCode":{
            "type":"string",
            "description":"This attribute indicates the violation type. Values include: ALERT, APPROVAL_REQUIRED, REJECTED"
        },
        "ValidationTypeCode":{
            "type":"string",
            "description":"The violation type code, which is derived from the extensible lookup type ORA_QP_GUIDE_VIOLATION_TYPES."
        }
    },
    "description":"This entity is an output from Pricing. It stores the guidelines violated in the pricing process.",
    "xml":{
        "name":"PriceViolationType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the error message."
        },
        "MessageSourceCode":{
            "type":"string",
            "description":"Abbreviation that indicates the source of the message."
        },
        "MessageText":{
            "type":"string",
            "description":"Text describing the nature of the error that occurred."
        },
        "MessageTypeCode":{
            "type":"string",
            "description":"Value that indicates the type of message. A list of accepted values is defined in the lookup type MESSAGE_TYPE."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Abbreviation that indicates the parent entity of the error. Values include Line, Charge, and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        },
        "PricingMessageId":{
            "type":"integer",
            "description":"The unique key of this error.",
            "format":"int64"
        }
    },
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "xml":{
        "name":"PricingMessageType"
    }
}

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.

{
    "type":"object",
    "properties":{
        "ValidationMode":{
            "type":"string",
            "description":"Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only."
        },
        "ValidationLevel":{
            "type":"string",
            "description":"Indicates whether a full evaluation is carried out or evaluation is for violations only. The default value is Violations Only."
        },
        "OutputStatus":{
            "type":"string",
            "description":"Value that indicates the output status. Values include Success or Error."
        },
        "PerformValueIdConversionsFlag":{
            "type":"boolean",
            "description":"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":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER."
        },
        "ProcessingMessage":{
            "type":"string",
            "description":"Message generated for the transaction when the output status is set to Error."
        }
    },
    "description":"This entity holds the parameters that calling application pass in as well as the output status parameter Pricing sets.",
    "xml":{
        "name":"PricingServiceParameterType"
    }
}

400 Response

Invalid input request.

Back to Top