Jump to

• Request
• Response

Get Rate Plans

post

/fscmRestApi/serviceMappings/contextServices/Sales/GetRatePlans

Get Rate Plans

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Get Rate Plans defined in Fusion Pricing.

Show Source

• Header: array Header
  Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
• Line: array Line
  Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
• PricingMessage: array PricingMessage
  This entity contains one instance for each pricing error found on the transaction.
• PricingServiceParameter: array PricingServiceParameter
  Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.
• PricingTerm: array PricingTerm
  Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.
• RatePlan: array RatePlan
  Values that stores the output details of the valid rate plans for an item.

{
    "type":"object",
    "properties":{
        "Header":{
            "type":"array",
            "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
            "items":{
                "$ref":"#/components/schemas/GRPHeaderType"
            }
        },
        "Line":{
            "type":"array",
            "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
            "items":{
                "$ref":"#/components/schemas/GRPLineType"
            }
        },
        "PricingMessage":{
            "type":"array",
            "description":"This entity contains one instance for each pricing error found on the transaction.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingMessageType"
            }
        },
        "PricingServiceParameter":{
            "type":"array",
            "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingServiceParameterType"
            }
        },
        "PricingTerm":{
            "type":"array",
            "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingTermType"
            }
        },
        "RatePlan":{
            "type":"array",
            "description":"Values that stores the output details of the valid rate plans for an item.",
            "items":{
                "$ref":"#/components/schemas/GRPRatePlanType"
            }
        }
    },
    "description":"Get Rate Plans defined in Fusion Pricing.",
    "xml":{
        "name":"getRatePlans"
    }
}

Nested Schema : Header

Type: array

Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

Show Source

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

{
    "type":"array",
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "items":{
        "$ref":"#/components/schemas/GRPHeaderType"
    }
}

Nested Schema : Line

Type: array

Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.

Show Source

• Array of: object GRPLineType
  Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.

{
    "type":"array",
    "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
    "items":{
        "$ref":"#/components/schemas/GRPLineType"
    }
}

Nested Schema : PricingMessage

Type: array

This entity contains one instance for each pricing error found on the transaction.

Show Source

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

{
    "type":"array",
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingMessageType"
    }
}

Nested Schema : PricingServiceParameter

Type: array

Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

Show Source

• Array of: object GRPPricingServiceParameterType
  Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

{
    "type":"array",
    "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingServiceParameterType"
    }
}

Nested Schema : PricingTerm

Type: array

Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

Show Source

• Array of: object GRPPricingTermType
  Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

{
    "type":"array",
    "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingTermType"
    }
}

Nested Schema : RatePlan

Type: array

Values that stores the output details of the valid rate plans for an item.

Show Source

• Array of: object GRPRatePlanType
  Values that stores the output details of the valid rate plans for an item.

{
    "type":"array",
    "description":"Values that stores the output details of the valid rate plans for an item.",
    "items":{
        "$ref":"#/components/schemas/GRPRatePlanType"
    }
}

Nested Schema : GRPHeaderType

Type: object

Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the Header.
• PriceAsOf: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  Price as of 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.
• 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.
• SalesChannelCode : string
  Sales Channel code.
• SalesSubChannelCode: string
  The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site.
• SellingBusinessUnitId: integer (int64)
  Selling business unit id
• SellingBusinessUnitName: string
  Name of the selling business unit.
• TransactionOn: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute stores the date of the transaction.
• TransactionSubTypeCode: string
  Abbreviation that indicates the transaction subtype.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Header.",
            "format":"int64"
        },
        "PriceAsOf":{
            "type":"string",
            "description":"Price as of date.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "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."
        },
        "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. "
        },
        "SalesChannelCode ":{
            "type":"string",
            "description":"Sales Channel code."
        },
        "SalesSubChannelCode":{
            "type":"string",
            "description":"The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site."
        },
        "SellingBusinessUnitId":{
            "type":"integer",
            "description":"Selling business unit id",
            "format":"int64"
        },
        "SellingBusinessUnitName":{
            "type":"string",
            "description":"Name of the selling business unit."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "TransactionSubTypeCode":{
            "type":"string",
            "description":"Abbreviation that indicates the transaction subtype."
        }
    },
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "xml":{
        "name":"GRPHeaderType"
    }
}

Nested Schema : GRPLineType

Type: object

Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.

Show Source

• AppliedPriceListId: integer (int64)
  Id of the price list applied.
• BillToAccountName: string
  Name that identifies the customer account name for the line. The Account Name is customer data management provides this name. This is used to derive the BillToCustomerId when BillToCustomerId is not passed.
• BillToAccountNumber: string
  Value that identifies the customer account number for the line. The Account Number in customer data management provides this number. This is used to derive the BillToCustomerId when BillToCustomerId is not passed.
• BillToCustomerId: integer (int64)
  Value that uniquely identifies the bill-to account for the line.
• 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.
• HeaderId: integer (int64)
  HeaderId reference for the Line
• 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)
  Value that uniquely identifies the Line.
• LineQuantityUOMCode: string
  The requested UOM.
• LineTypeCode: string
  This identifies the action performed when the order line is fulfilled.
• 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.
• PriceAsOf: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
• ServiceDuration: string
  Duration for the service.
• ServiceDurationPeriodCode: string
  Service duration period code.
• TransactionOn: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute stores the date of the transaction.

{
    "type":"object",
    "properties":{
        "AppliedPriceListId":{
            "type":"integer",
            "description":"Id of the price list applied.",
            "format":"int64"
        },
        "BillToAccountName":{
            "type":"string",
            "description":"Name that identifies the customer account name for the line. The Account Name is customer data management provides this name. This is used to derive the BillToCustomerId when BillToCustomerId is not passed."
        },
        "BillToAccountNumber":{
            "type":"string",
            "description":"Value that identifies the customer account number for the line. The Account Number in customer data management provides this number. This is used to derive the BillToCustomerId when BillToCustomerId is not passed."
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to account for the line.",
            "format":"int64"
        },
        "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."
        },
        "HeaderId":{
            "type":"integer",
            "description":"HeaderId reference for the Line",
            "format":"int64"
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Item to be Priced.",
            "format":"int64"
        },
        "InventoryItemNumber":{
            "type":"string",
            "description":"The number of the item that pricing must price."
        },
        "InventoryOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that the Inventory Item Number references."
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"The Inventory Org Id for this Inventory Item.",
            "format":"int64"
        },
        "LineCategoryCode":{
            "type":"string",
            "description":"Identifies the category of the line."
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Line.",
            "format":"int64"
        },
        "LineQuantityUOMCode":{
            "type":"string",
            "description":"The requested UOM."
        },
        "LineTypeCode":{
            "type":"string",
            "description":"This identifies the action performed when the order line is fulfilled."
        },
        "OverridePriceListId\t":{
            "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."
        },
        "PriceAsOf":{
            "type":"string",
            "description":"This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "ServiceDuration":{
            "type":"string",
            "description":"Duration for the service."
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        }
    },
    "description":"Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.",
    "xml":{
        "name":"GRPLineType"
    }
}

Nested Schema : GRPPricingMessageType

Type: object

This entity contains one instance for each pricing error found on the transaction.

Show Source

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

{
    "type":"object",
    "properties":{
        "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, Charge, and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        },
        "PricingMessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the error.",
            "format":"int64"
        }
    },
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "xml":{
        "name":"GRPPricingMessageType"
    }
}

Nested Schema : GRPPricingServiceParameterType

Type: object

Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

Show Source

• OutputStatus: string
  Value that indicates the output status. Values include Success or Error.
• PricingContext: string
  Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.

{
    "type":"object",
    "properties":{
        "OutputStatus":{
            "type":"string",
            "description":"Value that indicates the output status. Values include Success or Error."
        },
        "PricingContext":{
            "type":"string",
            "description":"Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER."
        }
    },
    "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
    "xml":{
        "name":"GRPPricingServiceParameterType"
    }
}

Nested Schema : GRPPricingTermType

Type: object

Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

Show Source

• ApplyToEntityCode: string
  Value that identifies the entity to which the pricing term will be applied. Valid value is LINE.
• ApplyToEntityId: integer (int64)
  Value that uniquely identifies the entity to which the term will be applied.
• PricingTermId: integer (int64)
  Value that uniquely identifies the PricingTerm entity. This is a primary key.
• SourceIdentifierId1: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement header identifier or promotion header identifier.
• SourceIdentifierId2: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement line identifier or promotion line identifier.
• SourceIdentifierId3: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement major version identifier.
• SourceIdentifierId4: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement status.
• SourceIdentifierId5: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, a sales agreement header identifier to support a key that includes more than one part.
• SourceName: string
  Name of the source of an entity for a pricing term. For example, Sales Agreement or Promotion.
• SourceTypeCode: string
  Value that uniquely identifies the source code of an entity for a pricing term. For example, SALES_AGREEMENT or PROMOTION.
• TermId: integer (int64)
  Value that uniquely identifies the term defined in the promotion or sales agreement.

{
    "type":"object",
    "properties":{
        "ApplyToEntityCode":{
            "type":"string",
            "description":"Value that identifies the entity to which the pricing term will be applied. Valid value is LINE."
        },
        "ApplyToEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity to which the term will be applied.",
            "format":"int64"
        },
        "PricingTermId":{
            "type":"integer",
            "description":"Value that uniquely identifies the PricingTerm entity. This is a primary key.",
            "format":"int64"
        },
        "SourceIdentifierId1":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement header identifier or promotion header identifier."
        },
        "SourceIdentifierId2":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement line identifier or promotion line identifier."
        },
        "SourceIdentifierId3":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement major version identifier."
        },
        "SourceIdentifierId4":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement status."
        },
        "SourceIdentifierId5":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, a sales agreement header identifier to support a key that includes more than one part."
        },
        "SourceName":{
            "type":"string",
            "description":"Name of the source of an entity for a pricing term. For example, Sales Agreement or Promotion."
        },
        "SourceTypeCode":{
            "type":"string",
            "description":"Value that uniquely identifies the source code of an entity for a pricing term. For example, SALES_AGREEMENT or PROMOTION."
        },
        "TermId":{
            "type":"integer",
            "description":"Value that uniquely identifies the term defined in the promotion or sales agreement.",
            "format":"int64"
        }
    },
    "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
    "xml":{
        "name":"GRPPricingTermType"
    }
}

Nested Schema : GRPRatePlanType

Type: object

Values that stores the output details of the valid rate plans for an item.

Show Source

• DefaultRatePlanFlag: boolean
  Indicates the rate plan that would be applied for the line as part of the rate plan determination process by Oracle Fusion Pricing.
• ParentEntityCode: string
  Identifies the parent entity type code for the transaction. Valid value is LINE.
• ParentEntityId: integer (int64)
  Value that uniquely identifies the parent entity.
• PlanDescription: string
  Description of the plan.
• PlanId: integer (int64)
  Value that uniquely identifies the plan applicable for the parent entity code and parent entity ID.
• PlanName: string
  Name that identifies the plan.
• PlanNumber: string
  Number that uniquely identifies the plan.
• RatePlanId: integer (int64)
  Value that uniquely identifies the RatePlan entity. This is a primary key.

{
    "type":"object",
    "properties":{
        "DefaultRatePlanFlag":{
            "type":"boolean",
            "description":"Indicates the rate plan that would be applied for the line as part of the rate plan determination process by Oracle Fusion Pricing."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Identifies the parent entity type code for the transaction. Valid value is LINE."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity.",
            "format":"int64"
        },
        "PlanDescription":{
            "type":"string",
            "description":"Description of the plan."
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan applicable for the parent entity code and parent entity ID.",
            "format":"int64"
        },
        "PlanName":{
            "type":"string",
            "description":"Name that identifies the plan."
        },
        "PlanNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the plan."
        },
        "RatePlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the RatePlan entity. This is a primary key.",
            "format":"int64"
        }
    },
    "description":"Values that stores the output details of the valid rate plans for an item.",
    "xml":{
        "name":"GRPRatePlanType"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Rate Plans retrieved successfully.

Body ()

Root Schema : schema

Type: object

Get Rate Plans defined in Fusion Pricing.

Show Source

• Header: array Header
  Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.
• Line: array Line
  Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.
• PricingMessage: array PricingMessage
  This entity contains one instance for each pricing error found on the transaction.
• PricingServiceParameter: array PricingServiceParameter
  Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.
• PricingTerm: array PricingTerm
  Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.
• RatePlan: array RatePlan
  Values that stores the output details of the valid rate plans for an item.

{
    "type":"object",
    "properties":{
        "Header":{
            "type":"array",
            "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
            "items":{
                "$ref":"#/components/schemas/GRPHeaderType"
            }
        },
        "Line":{
            "type":"array",
            "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
            "items":{
                "$ref":"#/components/schemas/GRPLineType"
            }
        },
        "PricingMessage":{
            "type":"array",
            "description":"This entity contains one instance for each pricing error found on the transaction.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingMessageType"
            }
        },
        "PricingServiceParameter":{
            "type":"array",
            "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingServiceParameterType"
            }
        },
        "PricingTerm":{
            "type":"array",
            "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
            "items":{
                "$ref":"#/components/schemas/GRPPricingTermType"
            }
        },
        "RatePlan":{
            "type":"array",
            "description":"Values that stores the output details of the valid rate plans for an item.",
            "items":{
                "$ref":"#/components/schemas/GRPRatePlanType"
            }
        }
    },
    "description":"Get Rate Plans defined in Fusion Pricing.",
    "xml":{
        "name":"getRatePlans"
    }
}

Nested Schema : Header

Type: array

Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

Show Source

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

{
    "type":"array",
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "items":{
        "$ref":"#/components/schemas/GRPHeaderType"
    }
}

Nested Schema : Line

Type: array

Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.

Show Source

• Array of: object GRPLineType
  Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.

{
    "type":"array",
    "description":"Represents the Sales Order/Quote Line, Sales Agreement Line or Contract Line.",
    "items":{
        "$ref":"#/components/schemas/GRPLineType"
    }
}

Nested Schema : PricingMessage

Type: array

This entity contains one instance for each pricing error found on the transaction.

Show Source

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

{
    "type":"array",
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingMessageType"
    }
}

Nested Schema : PricingServiceParameter

Type: array

Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

Show Source

• Array of: object GRPPricingServiceParameterType
  Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

{
    "type":"array",
    "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingServiceParameterType"
    }
}

Nested Schema : PricingTerm

Type: array

Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

Show Source

• Array of: object GRPPricingTermType
  Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

{
    "type":"array",
    "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
    "items":{
        "$ref":"#/components/schemas/GRPPricingTermType"
    }
}

Nested Schema : RatePlan

Type: array

Values that stores the output details of the valid rate plans for an item.

Show Source

• Array of: object GRPRatePlanType
  Values that stores the output details of the valid rate plans for an item.

{
    "type":"array",
    "description":"Values that stores the output details of the valid rate plans for an item.",
    "items":{
        "$ref":"#/components/schemas/GRPRatePlanType"
    }
}

Nested Schema : GRPHeaderType

Type: object

Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the Header.
• PriceAsOf: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  Price as of 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.
• 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.
• SalesChannelCode : string
  Sales Channel code.
• SalesSubChannelCode: string
  The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site.
• SellingBusinessUnitId: integer (int64)
  Selling business unit id
• SellingBusinessUnitName: string
  Name of the selling business unit.
• TransactionOn: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute stores the date of the transaction.
• TransactionSubTypeCode: string
  Abbreviation that indicates the transaction subtype.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Header.",
            "format":"int64"
        },
        "PriceAsOf":{
            "type":"string",
            "description":"Price as of date.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "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."
        },
        "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. "
        },
        "SalesChannelCode ":{
            "type":"string",
            "description":"Sales Channel code."
        },
        "SalesSubChannelCode":{
            "type":"string",
            "description":"The sub-group within a channel that intiated the order. For example, for the Web channel this attribute contains the name of the web-site."
        },
        "SellingBusinessUnitId":{
            "type":"integer",
            "description":"Selling business unit id",
            "format":"int64"
        },
        "SellingBusinessUnitName":{
            "type":"string",
            "description":"Name of the selling business unit."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "TransactionSubTypeCode":{
            "type":"string",
            "description":"Abbreviation that indicates the transaction subtype."
        }
    },
    "description":"Represents the Sales Order/Quote Header, Sales Agreement Header or Contract Header.",
    "xml":{
        "name":"GRPHeaderType"
    }
}

Nested Schema : GRPLineType

Type: object

Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.

Show Source

• AppliedPriceListId: integer (int64)
  Id of the price list applied.
• BillToAccountName: string
  Name that identifies the customer account name for the line. The Account Name is customer data management provides this name. This is used to derive the BillToCustomerId when BillToCustomerId is not passed.
• BillToAccountNumber: string
  Value that identifies the customer account number for the line. The Account Number in customer data management provides this number. This is used to derive the BillToCustomerId when BillToCustomerId is not passed.
• BillToCustomerId: integer (int64)
  Value that uniquely identifies the bill-to account for the line.
• 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.
• HeaderId: integer (int64)
  HeaderId reference for the Line
• 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)
  Value that uniquely identifies the Line.
• LineQuantityUOMCode: string
  The requested UOM.
• LineTypeCode: string
  This identifies the action performed when the order line is fulfilled.
• 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.
• PriceAsOf: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.
• ServiceDuration: string
  Duration for the service.
• ServiceDurationPeriodCode: string
  Service duration period code.
• TransactionOn: string (YYYY-MM-DD T HH24: MN: SS FF TZH: TZM)
  This attribute stores the date of the transaction.

{
    "type":"object",
    "properties":{
        "AppliedPriceListId":{
            "type":"integer",
            "description":"Id of the price list applied.",
            "format":"int64"
        },
        "BillToAccountName":{
            "type":"string",
            "description":"Name that identifies the customer account name for the line. The Account Name is customer data management provides this name. This is used to derive the BillToCustomerId when BillToCustomerId is not passed."
        },
        "BillToAccountNumber":{
            "type":"string",
            "description":"Value that identifies the customer account number for the line. The Account Number in customer data management provides this number. This is used to derive the BillToCustomerId when BillToCustomerId is not passed."
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to account for the line.",
            "format":"int64"
        },
        "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."
        },
        "HeaderId":{
            "type":"integer",
            "description":"HeaderId reference for the Line",
            "format":"int64"
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Item to be Priced.",
            "format":"int64"
        },
        "InventoryItemNumber":{
            "type":"string",
            "description":"The number of the item that pricing must price."
        },
        "InventoryOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that the Inventory Item Number references."
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"The Inventory Org Id for this Inventory Item.",
            "format":"int64"
        },
        "LineCategoryCode":{
            "type":"string",
            "description":"Identifies the category of the line."
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Line.",
            "format":"int64"
        },
        "LineQuantityUOMCode":{
            "type":"string",
            "description":"The requested UOM."
        },
        "LineTypeCode":{
            "type":"string",
            "description":"This identifies the action performed when the order line is fulfilled."
        },
        "OverridePriceListId\t":{
            "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."
        },
        "PriceAsOf":{
            "type":"string",
            "description":"This attribute is used to compare effectivities on pricing setups. The caller can default header priceAsOf to lines.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        },
        "ServiceDuration":{
            "type":"string",
            "description":"Duration for the service."
        },
        "ServiceDurationPeriodCode":{
            "type":"string",
            "description":"Service duration period code."
        },
        "TransactionOn":{
            "type":"string",
            "description":"This attribute stores the date of the transaction.",
            "format":"YYYY-MM-DD T HH24: MN: SS FF TZH: TZM"
        }
    },
    "description":"Values that describe the manual price adjustments that your transactional application applies during pricing. These adjustments apply for charges and for charge rules.",
    "xml":{
        "name":"GRPLineType"
    }
}

Nested Schema : GRPPricingMessageType

Type: object

This entity contains one instance for each pricing error found on the transaction.

Show Source

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

{
    "type":"object",
    "properties":{
        "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, Charge, and so on."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity on which the error occurred.",
            "format":"int64"
        },
        "PricingMessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the error.",
            "format":"int64"
        }
    },
    "description":"This entity contains one instance for each pricing error found on the transaction.",
    "xml":{
        "name":"GRPPricingMessageType"
    }
}

Nested Schema : GRPPricingServiceParameterType

Type: object

Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.

Show Source

• OutputStatus: string
  Value that indicates the output status. Values include Success or Error.
• PricingContext: string
  Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER.

{
    "type":"object",
    "properties":{
        "OutputStatus":{
            "type":"string",
            "description":"Value that indicates the output status. Values include Success or Error."
        },
        "PricingContext":{
            "type":"string",
            "description":"Value that identifies the calling application. Valid values are SALES and MATERIAL_TRANSFER."
        }
    },
    "description":"Stores the parameters that calling applications pass in to QP; also stores an output status of the pricing process.",
    "xml":{
        "name":"GRPPricingServiceParameterType"
    }
}

Nested Schema : GRPPricingTermType

Type: object

Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.

Show Source

• ApplyToEntityCode: string
  Value that identifies the entity to which the pricing term will be applied. Valid value is LINE.
• ApplyToEntityId: integer (int64)
  Value that uniquely identifies the entity to which the term will be applied.
• PricingTermId: integer (int64)
  Value that uniquely identifies the PricingTerm entity. This is a primary key.
• SourceIdentifierId1: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement header identifier or promotion header identifier.
• SourceIdentifierId2: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement line identifier or promotion line identifier.
• SourceIdentifierId3: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement major version identifier.
• SourceIdentifierId4: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement status.
• SourceIdentifierId5: string
  Optional. Value that uniquely identifies the entity for a pricing term. For example, a sales agreement header identifier to support a key that includes more than one part.
• SourceName: string
  Name of the source of an entity for a pricing term. For example, Sales Agreement or Promotion.
• SourceTypeCode: string
  Value that uniquely identifies the source code of an entity for a pricing term. For example, SALES_AGREEMENT or PROMOTION.
• TermId: integer (int64)
  Value that uniquely identifies the term defined in the promotion or sales agreement.

{
    "type":"object",
    "properties":{
        "ApplyToEntityCode":{
            "type":"string",
            "description":"Value that identifies the entity to which the pricing term will be applied. Valid value is LINE."
        },
        "ApplyToEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity to which the term will be applied.",
            "format":"int64"
        },
        "PricingTermId":{
            "type":"integer",
            "description":"Value that uniquely identifies the PricingTerm entity. This is a primary key.",
            "format":"int64"
        },
        "SourceIdentifierId1":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement header identifier or promotion header identifier."
        },
        "SourceIdentifierId2":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement line identifier or promotion line identifier."
        },
        "SourceIdentifierId3":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement major version identifier."
        },
        "SourceIdentifierId4":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, sales agreement status."
        },
        "SourceIdentifierId5":{
            "type":"string",
            "description":"Optional. Value that uniquely identifies the entity for a pricing term. For example, a sales agreement header identifier to support a key that includes more than one part."
        },
        "SourceName":{
            "type":"string",
            "description":"Name of the source of an entity for a pricing term. For example, Sales Agreement or Promotion."
        },
        "SourceTypeCode":{
            "type":"string",
            "description":"Value that uniquely identifies the source code of an entity for a pricing term. For example, SALES_AGREEMENT or PROMOTION."
        },
        "TermId":{
            "type":"integer",
            "description":"Value that uniquely identifies the term defined in the promotion or sales agreement.",
            "format":"int64"
        }
    },
    "description":"Values that represent the various promotions or contracts, or other terms applied to the transaction. These attributes are only for input.",
    "xml":{
        "name":"GRPPricingTermType"
    }
}

Nested Schema : GRPRatePlanType

Type: object

Values that stores the output details of the valid rate plans for an item.

Show Source

• DefaultRatePlanFlag: boolean
  Indicates the rate plan that would be applied for the line as part of the rate plan determination process by Oracle Fusion Pricing.
• ParentEntityCode: string
  Identifies the parent entity type code for the transaction. Valid value is LINE.
• ParentEntityId: integer (int64)
  Value that uniquely identifies the parent entity.
• PlanDescription: string
  Description of the plan.
• PlanId: integer (int64)
  Value that uniquely identifies the plan applicable for the parent entity code and parent entity ID.
• PlanName: string
  Name that identifies the plan.
• PlanNumber: string
  Number that uniquely identifies the plan.
• RatePlanId: integer (int64)
  Value that uniquely identifies the RatePlan entity. This is a primary key.

{
    "type":"object",
    "properties":{
        "DefaultRatePlanFlag":{
            "type":"boolean",
            "description":"Indicates the rate plan that would be applied for the line as part of the rate plan determination process by Oracle Fusion Pricing."
        },
        "ParentEntityCode":{
            "type":"string",
            "description":"Identifies the parent entity type code for the transaction. Valid value is LINE."
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity.",
            "format":"int64"
        },
        "PlanDescription":{
            "type":"string",
            "description":"Description of the plan."
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan applicable for the parent entity code and parent entity ID.",
            "format":"int64"
        },
        "PlanName":{
            "type":"string",
            "description":"Name that identifies the plan."
        },
        "PlanNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the plan."
        },
        "RatePlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the RatePlan entity. This is a primary key.",
            "format":"int64"
        }
    },
    "description":"Values that stores the output details of the valid rate plans for an item.",
    "xml":{
        "name":"GRPRatePlanType"
    }
}

400 Response

Invalid input request.

Back to Top