Jump to

• Request
• Response

Program Eligibility

post

/fscmRestApi/serviceMappings/contextServices/Sales/ProgramEligibility

Program Eligibility

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
• ChannelProgram: array ChannelProgram
• EligibilityServiceParameter: array EligibilityServiceParameter
• Header: array Header
• Line: array Line
• Message: array Message

{
    "type":"object",
    "properties":{
        "ChannelProgram":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEChannelProgramType"
            }
        },
        "EligibilityServiceParameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEEligibilityServiceParameterType"
            }
        },
        "Message":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEMessageType"
            }
        },
        "Header":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEHeaderType"
            }
        },
        "Line":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PELineType"
            }
        },
        "ChangeSummary":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEChangeSummaryType"
            }
        }
    }
}

Nested Schema : ChangeSummary

Type: array

Show Source

• Array of: object ChangeSummaryType

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

Nested Schema : ChannelProgram

Type: array

Show Source

• Array of: object ChannelProgramType
  Entity for the channel program.

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

Nested Schema : EligibilityServiceParameter

Type: array

Show Source

• Array of: object EligibilityServiceParameterType
  Input parameters and output status of the eligibility service.

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

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/PEHeaderType"
    }
}

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/PELineType"
    }
}

Nested Schema : Message

Type: array

Show Source

• Array of: object MessageType

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

Nested Schema : ChangeSummaryType

Type: object

Nested Schema : ChannelProgramType

Type: object

Entity for the channel program.

Show Source

• ChannelProgramId: integer (int64)
  Unique identifier for the Channel Program.
• DeclinableFlag: boolean
  Indicates if the user can remove the channel program applied to the order.
• DeclinedFlag: boolean
  Indicates if the channel program was declined by the user.
• EligibilityStatusCode: string
  Indicates if the Channel Program is eligible for the order line.
• EntitySubtypeCode: string
  Indicates the entity subtype code for the transaction.
• EntityTypeCode: string
  The entity source code for the?transaction.
• Explanation: string
  Descriptive text that clarifies why the Channel Program was applied or not applied.
• HeaderId: integer (int64)
  Unique identifier for the Order.
• LineId: integer (int64)
  Unique identifier for the Order Line.
• ManuallyAppliedFlag: boolean
  Indicates if the channel program was manually applied to the order.
• ProgramCode: string
  Unique identifier for the Channel Program.
• ProgramDescription: string
  The description of the Channel Program.
• ProgramId: integer (int64)
  Unique identifier for the Channel Program.
• ProgramLineId: integer (int64)
  Unique identifier for the Channel Program Line.
• ProgramName: string
  The name of the Channel Program.
• ProgramTypeId: integer (int64)
  Unique identifier for the Program Type associated with the Channel Program.
• ProgramTypeName: string
  The Program Type Name associated with the Channel Program.
• RequestOnlyFlag: boolean
  Additional classification of a transaction for tax purpose, as required by a tax authority.

{
    "type":"object",
    "properties":{
        "ChannelProgramId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program.",
            "format":"int64"
        },
        "DeclinableFlag":{
            "type":"boolean",
            "description":"Indicates if the user can remove the channel program applied to the order."
        },
        "DeclinedFlag":{
            "type":"boolean",
            "description":"Indicates if the channel program was declined by the user."
        },
        "EligibilityStatusCode":{
            "type":"string",
            "description":"Indicates if the Channel Program is eligible for the order line."
        },
        "EntityTypeCode":{
            "type":"string",
            "description":"The entity source code for the?transaction."
        },
        "EntitySubtypeCode":{
            "type":"string",
            "description":"Indicates the entity subtype code for the transaction."
        },
        "Explanation":{
            "type":"string",
            "description":"Descriptive text that clarifies why the Channel Program was applied or not applied."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the Order.",
            "format":"int64"
        },
        "LineId":{
            "type":"integer",
            "description":"Unique identifier for the Order Line.",
            "format":"int64"
        },
        "ManuallyAppliedFlag":{
            "type":"boolean",
            "description":"Indicates if the channel program was manually applied to the order."
        },
        "ProgramCode":{
            "type":"string",
            "description":"Unique identifier for the Channel Program."
        },
        "ProgramDescription":{
            "type":"string",
            "description":"The description of the Channel Program."
        },
        "ProgramId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program.",
            "format":"int64"
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program Line.",
            "format":"int64"
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of the Channel Program."
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Unique identifier for the Program Type associated with the Channel Program.",
            "format":"int64"
        },
        "ProgramTypeName":{
            "type":"string",
            "description":"The Program Type Name associated with the Channel Program."
        },
        "RequestOnlyFlag":{
            "type":"boolean",
            "description":"Additional classification of a transaction for tax purpose, as required by a tax authority."
        }
    },
    "description":"Entity for the channel program.",
    "xml":{
        "name":"ChannelProgramType"
    }
}

Nested Schema : EligibilityServiceParameterType

Type: object

Input parameters and output status of the eligibility service.

Show Source

• EligibilityMode: string
  Determines whether an entity is eligible for evaluation. Specify automatically, manually, or automatically and manually.
• OutputStatus: string

{
    "type":"object",
    "properties":{
        "EligibilityMode":{
            "type":"string",
            "description":"Determines whether an entity is eligible for evaluation. Specify automatically, manually, or automatically and manually."
        },
        "OutputStatus":{
            "type":"string",
            "description":""
        }
    },
    "description":"Input parameters and output status of the eligibility service.",
    "xml":{
        "name":"EligibilityServiceParameterType"
    }
}

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.
• EligibilityAsOf: string
  Date on the header that pricing uses when it determines eligibility.
• 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
• 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.
• RequestShipDate: string
  Date that the header requests to ship the order.
• 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
• SalespersonId: integer (int64)
• 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
• TotalUsageCode: string
• TransactionOn: string
  This attribute stores the date of the transaction.
• TransactionSubtypeCode: string
  Subtype for the transaction. For example, if the transaction type is Sales Order, then TransactionSubtypeCode specifies what type of sales order.
• TransactionTypeCode: string
  Indicates the transaction type, whether it is a quote, an order, etc. This information is used in determining which pricing process to invoke.

{
    "type":"object",
    "properties":{
        "EligibilityAsOf":{
            "type":"string",
            "description":"Date on the header that pricing uses when it determines eligibility."
        },
        "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":""
        },
        "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."
        },
        "RequestShipDate":{
            "type":"string",
            "description":"Date that the header requests to ship the order."
        },
        "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":""
        },
        "SalespersonId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "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":""
        },
        "TotalUsageCode":{
            "type":"string",
            "description":""
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "TransactionSubtypeCode":{
            "type":"string",
            "description":"Subtype for the transaction. For example, if the transaction type is Sales Order, then TransactionSubtypeCode specifies what type of sales order."
        },
        "TransactionTypeCode":{
            "type":"string",
            "description":"Indicates the transaction type, whether it is a quote, an order, etc. This information is  used in determining which pricing process to invoke. "
        }
    },
    "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.
• ActualShipDate: string
  Date that the item on the line ships.
• 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)
• AssessableValue: object AssessableValue
• AssessableValueCurrencyCode: string
• AssessableValueOverrideFlag: boolean
• 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.
• BillToCustomerId: integer (int64)
  Value that uniquely identifies the bill-to account for the line.
• 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.
• BillToSiteUseId: integer (int64)
  Value that uniquely identifies the bill-to address for the line.
• 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
• 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)
• 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
• 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.
• RequestShipDate: string
  Date that the line requests to ship the item.
• ReturnReasonCode: string
  Indicates the return reason code.
• RootCoverageLineId: integer (int64)
• 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.
• SalespersonId: integer (int64)
• ServiceDuration: object ServiceDuration
• ServiceDurationPeriodCode: string
  Service duration period code.
• ServiceEndDate: string
• ServiceStartDate: string
• 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."
        },
        "ActualShipDate":{
            "type":"string",
            "description":"Date that the item on the line ships."
        },
        "BillToSiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to address for the line.",
            "format":"int64"
        },
        "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":"",
            "format":"int64"
        },
        "AssessableValue":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":""
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":""
                }
            }
        },
        "AssessableValueCurrencyCode":{
            "type":"string",
            "description":""
        },
        "AssessableValueOverrideFlag":{
            "type":"boolean",
            "description":""
        },
        "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."
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to account for the line.",
            "format":"int64"
        },
        "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":""
        },
        "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":"",
            "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":""
        },
        "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."
        },
        "RequestShipDate":{
            "type":"string",
            "description":"Date that the line requests to ship the item."
        },
        "RootCoverageLineId":{
            "type":"integer",
            "description":"",
            "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."
        },
        "SalespersonId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "ServiceEndDate":{
            "type":"string",
            "description":""
        },
        "ServiceDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":""
                },
                "UomCode":{
                    "type":"string",
                    "description":""
                }
            }
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "ServiceStartDate":{
            "type":"string",
            "description":""
        },
        "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
• Value: number

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":""
        },
        "CurrencyCode":{
            "type":"string",
            "description":""
        }
    }
}

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
• Value: number

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":""
        },
        "UomCode":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : MessageType

Type: object

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the header.
• MessageId: integer (int64)
• MessageName: string
  Name of the error message.
• MessageText: string
  Text describing the nature of the error that occurred.
• MessageTypeCode: string
  Value that indicates the type of message. A list of accepted values is defined in the lookup type FND.
• ParentEntityCode: string
  Abbreviation that indicates the parent entity of the error. Values include Line, Header and so on.
• ParentEntityId: integer (int64)
  Value that uniquely identifies the parent entity on which the error occurred.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "MessageId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the error 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 FND."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Abbreviation that indicates the parent entity of the error. Values include Line, Header and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        }
    },
    "description":"",
    "xml":{
        "name":"MessageType"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Eligibility Request Completed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• ChangeSummary: array ChangeSummary
• ChannelProgram: array ChannelProgram
• EligibilityServiceParameter: array EligibilityServiceParameter
• Header: array Header
• Line: array Line
• Message: array Message

{
    "type":"object",
    "properties":{
        "ChannelProgram":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEChannelProgramType"
            }
        },
        "EligibilityServiceParameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEEligibilityServiceParameterType"
            }
        },
        "Message":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEMessageType"
            }
        },
        "Header":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEHeaderType"
            }
        },
        "Line":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PELineType"
            }
        },
        "ChangeSummary":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PEChangeSummaryType"
            }
        }
    }
}

Nested Schema : ChangeSummary

Type: array

Show Source

• Array of: object ChangeSummaryType

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

Nested Schema : ChannelProgram

Type: array

Show Source

• Array of: object ChannelProgramType
  Entity for the channel program.

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

Nested Schema : EligibilityServiceParameter

Type: array

Show Source

• Array of: object EligibilityServiceParameterType
  Input parameters and output status of the eligibility service.

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

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/PEHeaderType"
    }
}

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/PELineType"
    }
}

Nested Schema : Message

Type: array

Show Source

• Array of: object MessageType

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

Nested Schema : ChangeSummaryType

Type: object

Nested Schema : ChannelProgramType

Type: object

Entity for the channel program.

Show Source

• ChannelProgramId: integer (int64)
  Unique identifier for the Channel Program.
• DeclinableFlag: boolean
  Indicates if the user can remove the channel program applied to the order.
• DeclinedFlag: boolean
  Indicates if the channel program was declined by the user.
• EligibilityStatusCode: string
  Indicates if the Channel Program is eligible for the order line.
• EntitySubtypeCode: string
  Indicates the entity subtype code for the transaction.
• EntityTypeCode: string
  The entity source code for the?transaction.
• Explanation: string
  Descriptive text that clarifies why the Channel Program was applied or not applied.
• HeaderId: integer (int64)
  Unique identifier for the Order.
• LineId: integer (int64)
  Unique identifier for the Order Line.
• ManuallyAppliedFlag: boolean
  Indicates if the channel program was manually applied to the order.
• ProgramCode: string
  Unique identifier for the Channel Program.
• ProgramDescription: string
  The description of the Channel Program.
• ProgramId: integer (int64)
  Unique identifier for the Channel Program.
• ProgramLineId: integer (int64)
  Unique identifier for the Channel Program Line.
• ProgramName: string
  The name of the Channel Program.
• ProgramTypeId: integer (int64)
  Unique identifier for the Program Type associated with the Channel Program.
• ProgramTypeName: string
  The Program Type Name associated with the Channel Program.
• RequestOnlyFlag: boolean
  Additional classification of a transaction for tax purpose, as required by a tax authority.

{
    "type":"object",
    "properties":{
        "ChannelProgramId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program.",
            "format":"int64"
        },
        "DeclinableFlag":{
            "type":"boolean",
            "description":"Indicates if the user can remove the channel program applied to the order."
        },
        "DeclinedFlag":{
            "type":"boolean",
            "description":"Indicates if the channel program was declined by the user."
        },
        "EligibilityStatusCode":{
            "type":"string",
            "description":"Indicates if the Channel Program is eligible for the order line."
        },
        "EntityTypeCode":{
            "type":"string",
            "description":"The entity source code for the?transaction."
        },
        "EntitySubtypeCode":{
            "type":"string",
            "description":"Indicates the entity subtype code for the transaction."
        },
        "Explanation":{
            "type":"string",
            "description":"Descriptive text that clarifies why the Channel Program was applied or not applied."
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the Order.",
            "format":"int64"
        },
        "LineId":{
            "type":"integer",
            "description":"Unique identifier for the Order Line.",
            "format":"int64"
        },
        "ManuallyAppliedFlag":{
            "type":"boolean",
            "description":"Indicates if the channel program was manually applied to the order."
        },
        "ProgramCode":{
            "type":"string",
            "description":"Unique identifier for the Channel Program."
        },
        "ProgramDescription":{
            "type":"string",
            "description":"The description of the Channel Program."
        },
        "ProgramId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program.",
            "format":"int64"
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Unique identifier for the Channel Program Line.",
            "format":"int64"
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of the Channel Program."
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Unique identifier for the Program Type associated with the Channel Program.",
            "format":"int64"
        },
        "ProgramTypeName":{
            "type":"string",
            "description":"The Program Type Name associated with the Channel Program."
        },
        "RequestOnlyFlag":{
            "type":"boolean",
            "description":"Additional classification of a transaction for tax purpose, as required by a tax authority."
        }
    },
    "description":"Entity for the channel program.",
    "xml":{
        "name":"ChannelProgramType"
    }
}

Nested Schema : EligibilityServiceParameterType

Type: object

Input parameters and output status of the eligibility service.

Show Source

• EligibilityMode: string
  Determines whether an entity is eligible for evaluation. Specify automatically, manually, or automatically and manually.
• OutputStatus: string

{
    "type":"object",
    "properties":{
        "EligibilityMode":{
            "type":"string",
            "description":"Determines whether an entity is eligible for evaluation. Specify automatically, manually, or automatically and manually."
        },
        "OutputStatus":{
            "type":"string",
            "description":""
        }
    },
    "description":"Input parameters and output status of the eligibility service.",
    "xml":{
        "name":"EligibilityServiceParameterType"
    }
}

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.
• EligibilityAsOf: string
  Date on the header that pricing uses when it determines eligibility.
• 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
• 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.
• RequestShipDate: string
  Date that the header requests to ship the order.
• 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
• SalespersonId: integer (int64)
• 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
• TotalUsageCode: string
• TransactionOn: string
  This attribute stores the date of the transaction.
• TransactionSubtypeCode: string
  Subtype for the transaction. For example, if the transaction type is Sales Order, then TransactionSubtypeCode specifies what type of sales order.
• TransactionTypeCode: string
  Indicates the transaction type, whether it is a quote, an order, etc. This information is used in determining which pricing process to invoke.

{
    "type":"object",
    "properties":{
        "EligibilityAsOf":{
            "type":"string",
            "description":"Date on the header that pricing uses when it determines eligibility."
        },
        "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":""
        },
        "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."
        },
        "RequestShipDate":{
            "type":"string",
            "description":"Date that the header requests to ship the order."
        },
        "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":""
        },
        "SalespersonId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "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":""
        },
        "TotalUsageCode":{
            "type":"string",
            "description":""
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction."
        },
        "TransactionSubtypeCode":{
            "type":"string",
            "description":"Subtype for the transaction. For example, if the transaction type is Sales Order, then TransactionSubtypeCode specifies what type of sales order."
        },
        "TransactionTypeCode":{
            "type":"string",
            "description":"Indicates the transaction type, whether it is a quote, an order, etc. This information is  used in determining which pricing process to invoke. "
        }
    },
    "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.
• ActualShipDate: string
  Date that the item on the line ships.
• 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)
• AssessableValue: object AssessableValue
• AssessableValueCurrencyCode: string
• AssessableValueOverrideFlag: boolean
• 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.
• BillToCustomerId: integer (int64)
  Value that uniquely identifies the bill-to account for the line.
• 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.
• BillToSiteUseId: integer (int64)
  Value that uniquely identifies the bill-to address for the line.
• 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
• 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)
• 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
• 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.
• RequestShipDate: string
  Date that the line requests to ship the item.
• ReturnReasonCode: string
  Indicates the return reason code.
• RootCoverageLineId: integer (int64)
• 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.
• SalespersonId: integer (int64)
• ServiceDuration: object ServiceDuration
• ServiceDurationPeriodCode: string
  Service duration period code.
• ServiceEndDate: string
• ServiceStartDate: string
• 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."
        },
        "ActualShipDate":{
            "type":"string",
            "description":"Date that the item on the line ships."
        },
        "BillToSiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to address for the line.",
            "format":"int64"
        },
        "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":"",
            "format":"int64"
        },
        "AssessableValue":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":""
                },
                "CurrencyCode":{
                    "type":"string",
                    "description":""
                }
            }
        },
        "AssessableValueCurrencyCode":{
            "type":"string",
            "description":""
        },
        "AssessableValueOverrideFlag":{
            "type":"boolean",
            "description":""
        },
        "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."
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to account for the line.",
            "format":"int64"
        },
        "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":""
        },
        "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":"",
            "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":""
        },
        "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."
        },
        "RequestShipDate":{
            "type":"string",
            "description":"Date that the line requests to ship the item."
        },
        "RootCoverageLineId":{
            "type":"integer",
            "description":"",
            "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."
        },
        "SalespersonId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "ServiceEndDate":{
            "type":"string",
            "description":""
        },
        "ServiceDuration":{
            "type":"object",
            "properties":{
                "Value":{
                    "type":"number",
                    "description":""
                },
                "UomCode":{
                    "type":"string",
                    "description":""
                }
            }
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "ServiceStartDate":{
            "type":"string",
            "description":""
        },
        "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
• Value: number

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":""
        },
        "CurrencyCode":{
            "type":"string",
            "description":""
        }
    }
}

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
• Value: number

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"number",
            "description":""
        },
        "UomCode":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : MessageType

Type: object

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the header.
• MessageId: integer (int64)
• MessageName: string
  Name of the error message.
• MessageText: string
  Text describing the nature of the error that occurred.
• MessageTypeCode: string
  Value that indicates the type of message. A list of accepted values is defined in the lookup type FND.
• ParentEntityCode: string
  Abbreviation that indicates the parent entity of the error. Values include Line, Header and so on.
• ParentEntityId: integer (int64)
  Value that uniquely identifies the parent entity on which the error occurred.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header.",
            "format":"int64"
        },
        "MessageId":{
            "type":"integer",
            "description":"",
            "format":"int64"
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the error 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 FND."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Abbreviation that indicates the parent entity of the error. Values include Line, Header and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        }
    },
    "description":"",
    "xml":{
        "name":"MessageType"
    }
}

400 Response

Invalid input request.

Back to Top