Estimates Queries

Query estimates/quotes with line items, validity, and conversion status.

Estimate — Returns a single estimate by id

GraphQL

query GetEstimate($id: ID!) {
  Estimate(id: $id) {
    id
    label
    status
    total
    dated_at
    customer { id label }
    line_items {
      id
      variant { id label }
      quantity
      price
    }
  }
}

Estimates — Returns a paginated list of estimates with sorting and filters

GraphQL

query Estimates(
  $where: QueryEstimatesWhereWhereConditions,
  $orderBy: [QueryEstimatesOrderByOrderByClause!],
  $search: String,
  $first: Int,
  $page: Int
) {
  Estimates(
    where: $where,
    orderBy: $orderBy,
    search: $search,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      total
      currentPage
    }
    data {
      id
      label
      status
      dated_at
      total
      customer { id label }
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier.
label	String	Estimate number.
status	EstimateStatus	Current workflow state.
dated_at	Date	Document date.
expire_at	Date	Expiration date of the offer.
shipping_at	Date	Target delivery date.
tax_type	TaxType	"Exclusive" or "Inclusive".
default_discount	Float	Global discount value.
discount_type	DiscountType	"percentage" or "amount".
total_units	Float	Total quantity across all lines.
subtotal	Float	Net before taxes and global discount.
total_without_tax	Float	Total amount excluding tax.
total_ecotax	Float	Environmental tax sum.
total	Float	Grand total including taxes.
notes	String	Public notes for the PDF.
internal_notes	String	Hidden internal comments.
for_the_attention_of	String	Primary contact person.
external_reference	String	Internal reference.
exchange_rate	Float	Currency conversion rate.
location_label	String	Origin warehouse name.
ordered_status	OrderedStatus	Progress of transformation into Sales Orders.
billing_status	BillingStatus	Progress of transformation into Invoices.
payment_status	PaymentStatus	Estimated payment progress.
transformed_quantity	Float	Quantity already ordered or invoiced.
ordered_quantity	Float	Quantity documented in sales orders.
unordered_quantity	Float	Quantity still pending order.
billed_quantity	Float	Quantity already invoiced.
unbilled_quantity	Float	Quantity still pending invoice.
paid_quantity	Float	Quantity paid for.
unpaid_quantity	Float	Quantity pending payment.
currency	Currency	Estimate currency.
customer	Customer	Linked customer.
price_level	PriceLevel	Applied price list.
account_representative	AccountRepresentative	Linked sales rep.
season	Season	Business season.
payment_information	PaymentInformation	Bank details for payment.
billing_address	Address	Customer billing address.
shipping_address	Address	Customer shipping address.
line_items	[LineItemEstimate]	Detailed item lines.
total_taxes	[DocumentTaxRate]	Summary of taxes.
invoices_count	Int	Number of linked invoices.
invoices	[Invoice]	Resulting invoices history.
orders_count	Int	Number of linked sales orders.
orders	[Order]	Resulting orders history.
public_id	String	Token for public web viewing.
public_view_count	Int	Web view statistics.
public_last_accessed_at	JSON	Last web view timestamp.
email_histories	[EmailHistory]	Communication logs.
files	[File]	Attached files.
pdf_template	PdfTemplate	Design used for PDF generation.
created_at	DateTime	Creation time.
updated_at	DateTime	Last update time.
custom_fields	[EntityCustomField]	Custom fields for this entity.

---

Filters

The following fields can be used in the where parameter:

id, label, status, expire_at, shipping_at, currency, tax_type, default_discount, total_units, subtotal, total_without_tax, total_ecotax, total, billed_quantity, unbilled_quantity, paid_quantity, unpaid_quantity, ordered_quantity, unordered_quantity, orders_count, invoices_count, transformed_quantity, notes, internal_notes, for_the_attention_of, external_reference, dated_at, created_at, updated_at, customer_id, price_level_id, account_representative_id, season_id, variant_id, variant_label, variant_sku, location_id, batch_number_id, product_tag_id, customer_tag_id, is_sent, payment_status, billing_status, ordered_status.

Example Filters:

Field	Example
status	{ "column": "STATUS", "operator": "EQ", "value": "pending" }
customer_id	{ "column": "CUSTOMER_ID", "operator": "EQ", "value": 100050 }
expire_at	{ "column": "EXPIRE_AT", "operator": "LT", "value": "2025-12-31" }

---

Sorting

You can sort results using the orderBy parameter:

• id
• label
• status
• expire_at
• shipping_at
• currency
• total
• dated_at
• customer_label

---

Grouping Options

You can group estimates using the groupBy parameter for reports:

Field	Description
id	Group by internal ID.
year	Group by year of dated_at.
month	Group by month of dated_at.
day	Group by day of dated_at.

---

Enums

EstimateStatus

Value	Description
unpublished	Draft status (hidden).
pending	Document sent/awaiting customer decision.
accepted	Customer agreed to the offer.
rejected	Customer declined the offer.
cancelled	Document voided.

OrderedStatus

Value	Description
not_ordered	No sales order created from this estimate.
partially_ordered	Some items included in sales orders.
ordered	Full value reached in sales orders.

BillingStatus

Value	Description
not_billed	No invoice generated.
partially_billed	Partial invoices created.
billed	Full value reached in invoices.

PaymentStatus

Value	Description
unpaid	No payment recorded.
partially_paid	Partial payment received.
paid	Fully paid.

DiscountType

Value	Description
amount	Fixed discount amount.
percentage	Percentage-based discount.

TaxType

Value	Description
exclusive	Tax calculated on top of the net price.
inclusive	Tax included in the displayed price.