Estimates Mutations

CreateEstimate

Creates a new estimate (quote) document record from scratch.

Parameters:

Parameter	Type	Description
input	EstimateInput!	All estimate data.

Example Query:

GraphQL

mutation CreateEstimate($input: EstimateInput!) {
  CreateEstimate(input: $input) {
    id
    label
    status
    total
  }
}

---

UpdateEstimate

Updates an existing estimate record.

Parameters:

Parameter	Type	Description
id	Int!	ID of the estimate document.
input	EstimateInput!	Fields to update.

---

DeleteEstimate / DeleteEstimates

Deletes one or multiple estimates.

---

GenerateEstimateNumber

Generates the next available sequence label for a new estimate.

Parameter	Type	Description
location_id	ID	Optional location to use for sequence prefix.

---

GenerateEstimatePublicId / DisableEstimatePublicId

Manages the public URL token for customer viewing.

---

TransformIntoOrder

Converts the estimate into a Sales Order document.

---

TransformIntoInvoice

Converts the estimate into an Invoice document.

---

DuplicateEstimate

Creates a full copy of an existing estimate.

---

GenerateEstimatesPdfs

Generates PDF documents for multiple estimates.

---

Input Data Types

EstimateInput

Field	Type	Description
id	Int	ID for updates.
label	String	Estimate number.
status	EstimateStatus	Initial or updated status.
expire_at	Date	Expiration date.
dated_at	Date	Document date.
shipping_at	Date	Target shipping date.
currency	CurrencyInput	Currency link data.
tax_type	TaxType	"exclusive" or "inclusive".
discount_type	DiscountType	"percentage" or "amount".
default_discount	Float	Global discount value.
exchange_rate	Float	Currency exchange rate.
notes	String	Public notes for PDF.
internal_notes	String	Private office notes.
for_the_attention_of	String	Recipient contact name.
external_reference	String	Internal reference.
line_items	[LineItemEstimateInput]	List of items quoted.
customer	CustomerInput	Linked customer link.
price_level	PriceLevelInput	Price list link.
account_representative	AccountRepresentativeInput	Assigned representative.
season	SeasonInput	Business season data.
payment_information	PaymentInformationInput	Bank details link.
billing_address	AddressInput	Billing address link.
shipping_address	AddressInput	Shipping address link.
pdf_template	PdfTemplateInput	PDF design link.
files	[FileInput]	Attachments.
custom_fields	[EntityCustomFieldInput]	Custom fields for this entity.

---

UpdateEstimatesStatus

Updates the status of multiple estimates at once.

Parameters:

Parameter	Type	Description
ids	[ID!]!	List of estimate IDs.
status	EstimateStatus!	New status to apply.

Example Query:

GraphQL

mutation UpdateEstimatesStatus($ids: [ID!]!, $status: EstimateStatus!) {
  UpdateEstimatesStatus(ids: $ids, status: $status)
}

Example Variables:

JSON

{
  "ids": [1001, 1002],
  "status": "accepted"
}

Return Type	Description
Boolean	true if successful.

---

Enums

EstimateStatus

Value	Description
unpublished	Draft status (hidden).
pending	Document sent/awaiting response.
accepted	Offer accepted by customer.
rejected	Offer declined by customer.
cancelled	Document voided.

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.