Breadcrumbs

Quote Search

The quote_search tool finds Quotes by Customer, Product, Status, Dates, Label, Creator, or Margin. For each matching Quote, the tool returns identification details, a link to the Quote, and, when available, the calculated header values.

Tool Name – quote_search

Title – Quote Search

Type – Private

Access Profile – Operator

Permissions

The quote_search tool uses your Pricefx permissions when searching for Quotes. You can only access Quote information that your assigned permissions allow you to view.

Quotes restricted by User Group (View Details) can appear in search results even if you are not a member of the assigned user group. In this case, quote_search does not return the calculated values for the restricted Quote.

Parameters

Quote and Customer Filters

Parameter

Required

Description

customer

No

Customer Id or part of the customer name. The value must match exactly one customer. If it matches none or several customers, the tool returns an error.

product

No

Product SKU or label. The tool returns only Quotes that contain this product. This filter makes the search slower.

quote_status

No

Quote status to filter by:

  • Draft

  • Offer

  • Deal

  • Revoked

  • Superseded

  • Invalidated

  • Lost

  • Partial Deal

quote_status_operator

No

How the tool compares quote_status:

  • equal (default)

  • notEqual

workflow_status

No

Approval workflow status to filter by:

  • Draft

  • Submitted

  • Denied

  • Approved

  • No Approval Required

  • Withdrawn

  • Invalidated

workflow_status_operator

No

How the tool compares workflow_status:

  • equal (default)

  • notEqual

label

No

Text that the Quote label contains. The search is not case-sensitive.

created_by

No

Exact name of the user who created the Quote. For a request like "my Quotes", the AI assistant looks up your user name first and then passes it to the tool.

max_quotes

No

Maximum number of Quotes the tool returns.

Default: 5 and the maximum is 50.

Date and Margin Filters

Parameter

Required

Description

start_date

No

Date the tool compares with the Quote creation date: a day (yyyy-MM-dd) or an exact time (yyyy-MM-dd'T'HH:mm:ss).

start_date_operator

Yes, if start_date is given

How the tool compares start_date:

  • equal

  • notEqual

  • greaterThan

  • greaterOrEqual

  • lessThan

  • lessOrEqual

end_date

No

A second date the tool compares with the Quote creation date, which closes a date range. The format is the same as start_date.

end_date_operator

Yes, if end_date is given

How the tool compares end_date. The operators are the same as for start_date_operator.

effective_date

No

Date the tool compares with the Quote effective date, as a day (yyyy-MM-dd).

effective_date_operator

Yes, if effective_date is given

How the tool compares effective_date. The operators are the same as for start_date_operator.

expiry_date

No

Date the tool compares with the Quote expiry date, as a day (yyyy-MM-dd).

expiry_date_operator

Yes, if expiry_date is given

How the tool compares expiry_date. The operators are the same as for start_date_operator.

margin_operator

No

Turns on the margin filter:

  • equal

  • greaterThan

  • greaterOrEqual

  • lessThan

  • lessOrEqual

info This filter makes the search slower.

margin_field

Yes, if margin_operator is given

Name of the Quote header margin output to compare, for example Margin or MarginPct.

margin

No

Value the tool compares the margin output with. The default is 0, so lessThan alone finds negative margins. Enter a percentage as a fraction (12% = 0.12). If you give this value, margin_operator and margin_field are also required.

Output

The quote_search tool returns a list of matching Quotes, newest first, plus a count of matches and a message with notes about the search.

Field

Description

Typed Id

Quote ID with its type suffix, for example 1493.Q.

Unique Name

Quote unique name, for example P-1493.

Label

Quote label.

Customer Id / Customer Name

Customer on the Quote.

Quote Status

Quote status, for example DRAFT or DEAL.

Workflow Status

Approval workflow status, for example SUBMITTED or APPROVED.

Create Date / Created By

When the Quote was created and by which user.

Link

Link that opens the Quote in Pricefx.

Number of Line Items

Number of line items in the Quote, not counting folders.

Currency, Quantity, Margin, Margin %, Net Price

Calculated header values of the Quote. These values are missing when the Quote is restricted, is still calculating, or cannot be read.

Found Quotes Count

Total number of Quotes that match the filters. If this number is larger than the number of returned Quotes, the list was cut short.

Message

Notes about the search, for example that only the 50 newest Quotes were checked, or which margin output was compared.

Behavior and Limitations

  • All filters are optional and must all match together (AND).

  • Results are sorted by creation date, newest first.

  • Product and margin searches check only the 50 newest matching Quotes. The Message field in the output reports when more Quotes are matched.

  • When the margin_field value matches several margin outputs, the tool uses the closest match and lists the other margin fields it found.

  • Calculated values are available only if the Quote type defines outputs named Currency, Quantity, Margin, MarginPct and NetPrice.

See Also