Breadcrumbs

Quote Get Calculated Price

The quote_get_calculated_price tool returns calculated prices and attributes for a specific Quote. By default, the response also includes the calculated prices of up to 5 line items.

Tool Name – quote_get_calculated_price

Title – Quote Get Calculated Price

Type – Private

Access Profile – Operator

Permissions

The quote_get_calculated_price tool uses your Pricefx permissions. You can retrieve calculated pricing information only for Quotes that you have permission to view.

For a Quote restricted by User Group (View Details), the quote_get_calculated_price 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.

date

No

Date (yyyy-MM-dd) on which the Quote must be valid. The effective date must be on or before this date, and the expiry date on or after it.

include_line_items

No

Whether the response includes calculated line items.

Default: true.

max_line_items

No

Maximum number of line items the tool returns.

Default: 5.

line_id

No

Returns only the line item with this line Id.

product

No

Returns only line items with this product. The value must be the product SKU or product label. The match is exact and case-sensitive.

quantity_filter_operator

No

Turns on the quantity filter:

  • equal

  • greaterThan

  • greaterOrEqual

  • lessThan

  • lessOrEqual.

quantity_filter

No

Whole number the tool compares the line item quantity with. The default is 0. If you give this value, quantity_filter_operator is also required.

price_filter_operator

No

Turns on the price filter. The operators are the same as for quantity_filter_operator.

price_filter_price_type

Yes, if price_filter_operator is given

Price to compare, written without the word "Price", for example Invoice, Net, or Stretch.

price_filter

No

Value the tool compares the line item price with.

Default: 0.

If you give this value, price_filter_operator and price_filter_price_type are also required.

Output

  • Quote summary prices – The calculated header-level prices. Each price is named by its label as configured in the Quote type, for example List Price or Net Price.

  • Quote summary attributes – Id, unique name, label, Customer Id and Name, Currency, Valid From (effective date), Valid To (expiry date), Quote Status, Workflow Status, Link to the Quote in Pricefx, and the as-of date when you give date.

  • Number of line items – The total number of line items in the Quote, not counting folders. If this number is larger than the number of returned line items, the list was filtered or cut short.

  • Line items – For each line item, its calculated prices by Label, Line Id, Product Id, Product Label, Quantity, and Unit of Measure.

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.

  • If a line item filter matches nothing, the tool returns an empty list of line items, not an error.

  • All line item filters must match together (AND).

  • The tool returns the first matching line items, in the order they appear in the Quote.

  • The tool skips folders.

  • The quantity and price filters do not support notEqual.

  • When the price filter is on, line items without a price of the given type are left out.

See Also