Quote Get Line Item Detail | Pricefx Knowledge Base

The quote_get_line_item_detail tool returns the pricing breakdown of one line item in a Quote: its prices, costs, margins, and, on request, discounts and surcharges. The response always includes the approval alerts and review status of the line item.

Tool Name – quote_get_line_item_detail

Title – Quote Get Line Item Detail

Type – Private

Permissions

The quote_get_line_item_detail tool uses your Pricefx permissions. You can retrieve line-item details only for Quotes that you have permission to view.

For a Quote restricted by User Group (View Details), the quote_get_line_item_detail tool returns an error if you are not a member of the assigned user group. The error message starts with The backend refused the request: and includes the reasoning message, for example Quote restricted by user group.

Parameters

Parameter	Required	Description
`id`	Yes, if `unique_name` and `label` are not given	Quote Id, as a number (1493) or a typed Id (1493.Q).
`unique_name`	Yes, if `id` and `label` are not given	Quote unique name, for example P-1493.
`label`	Yes, if `id` and `unique_name` are not given	Text that the Quote label contains. The search is not case-sensitive. If the text matches several Quotes, the tool returns an error that lists their unique names.
`line_id`	Yes, if the Quote has several line items with the same product	Line Id of the line item. This is the most reliable way to select a line item. The `quote_line_items_list` tool returns the line IDs.
`product`	Yes, if the Quote has several line items and `line_id` is not given	Product SKU or product label of the line item. The match is exact and case-sensitive.
`detail_level`	No	How much of the line item pricing the tool returns: minimum, summary, or full. The default is summary.
`search_term`	No	Extra keyword that adds matching inputs and outputs to the result, for example incoterm or rebate. The search is not case-sensitive.

Detail Levels

The tool returns only the inputs and outputs whose name or label contains one of the keywords of the selected detail level.

Detail Level	Keywords
minimum	price, margin, quantity, qty, volume
summary (default)	Everything in minimum, plus cost, unit of measure, uom
full	Everything in summary, plus discount, surcharge, charge, approval, currency, ccy

Output

Quote Fields

Field	Description
Id	Quote ID, for example 1493.
Name	Quote unique name, for example P-1493.
Label	Quote label.
Customer Id / Customer Name	Customer on the Quote.
Link	Link that opens the Quote in Pricefx.

Line Item Fields

Field	Description
SKU / Label	Product on the line item.
Inputs	Line item inputs that match the detail level and search term, named by their labels.
Outputs	Calculated line item outputs that match the detail level and search term, named by their labels.
Alerts	Approval and warning alerts raised by the line item outputs. Each alert has the output name, the alert type (for example CRITICAL), and the alert message. The tool returns all alerts at every detail level.
Review Status	Review status of the line item, when the Quote is in review.

Behavior and Limitations

The tool looks up the Quote in this order: id, then unique_name, then label. It uses the first value that finds a Quote.
The tool selects the line item by line_id first. When line_id is given, the tool ignores product.
If the Quote has only one line item, you do not need line_id or product.
The detail level matches inputs and outputs by name. The result depends on how the outputs are named in the Quote type. For example, an output named Price Discount appears at the minimum level because its name contains "price".
Hidden inputs are never returned.
Outputs with structured results, such as matrices or charts, are never returned.
The tool has no validity date parameter and does not return the Quote header prices. For header prices, use the quote_get_calculated_price tool.
Folders in the Quote are not counted or returned as line items.