Skip to main content

Quote

A priced offer to a customer, valid until a set date. Converts to a sales order or invoice when accepted.

type Quote {
  billingAddress: String
  competitorName: String
  convertedToInvoice: Invoice
  convertedToInvoiceAt: DateTime
  convertedToInvoiceId: String
  convertedToSalesOrder: SalesOrder
  convertedToSalesOrderAt: DateTime
  convertedToSalesOrderId: String
  createdAt: DateTime!
  currency: String!
  customer: Partner!
  customerEmail: String
  customerId: String!
  customerMobile: String
  customerName: String
  deletedAt: DateTime
  deletedBy: String
  deliveryInstructions: String
  discountAmount: Float!
  discountType: String!
  discountValue: Float!
  enteredBy: String!
  enterer: User!
  exchangeRate: Float
  id: ID!
  internalNotes: String
  items: [QuoteItem!]!
  lossNotes: String
  lossReason: String
  lostAt: DateTime
  notes: String
  organization: Organization!
  organizationId: String!
  ownership: DocumentOwnershipOutput
  paymentTerms: String
  priority: String
  quoteDate: DateTime!
  quoteNumber: String!
  reference: String
  shippingAddress: String
  shippingCost: Float!
  status: String!
  subtotal: Float!
  taxAmount: Float!
  taxCalculationMethod: String
  taxRate: Float!
  terms: String
  totalAmount: Float!
  updatedAt: DateTime!
  updatedBy: String!
  validUntil: DateTime
  version: Int!
  warehouse: Warehouse
  warehouseId: String
  winReason: String
  wonAt: DateTime
}

Fields​

Quote.billingAddress ● String scalar​

The billing address, as text.

Quote.competitorName ● String scalar​

Competitor the quote was lost to, when known.

Quote.convertedToInvoice ● Invoice object​

The invoice this quote was converted to, if any.

Quote.convertedToInvoiceAt ● DateTime scalar​

When the quote was converted to an invoice.

Quote.convertedToInvoiceId ● String scalar​

The ID of the invoice this quote was converted to. Null until converted.

Quote.convertedToSalesOrder ● SalesOrder object​

The sales order this quote was converted to, if any.

Quote.convertedToSalesOrderAt ● DateTime scalar​

When the quote was converted to a sales order.

Quote.convertedToSalesOrderId ● String scalar​

The ID of the sales order this quote was converted to. Null until converted.

Quote.createdAt ● DateTime! non-null scalar​

When the record was created.

Quote.currency ● String! non-null scalar​

Currency code of the document's amounts.

Quote.customer ● Partner! non-null object​

The customer the quote is for.

Quote.customerEmail ● String scalar​

The customer's email address, as stored on the quote.

Quote.customerId ● String! non-null scalar​

The ID of the customer the quote is for.

Quote.customerMobile ● String scalar​

The customer's mobile number, as stored on the quote.

Quote.customerName ● String scalar​

The customer's name, as stored on the quote.

Quote.deletedAt ● DateTime scalar​

When the record was deleted. Null while it is active.

Quote.deletedBy ● String scalar​

The ID of the user who deleted the record.

Quote.deliveryInstructions ● String scalar​

Delivery instructions for the shipment.

Quote.discountAmount ● Float! non-null scalar​

Total discount amount on the quote.

Quote.discountType ● String! non-null scalar​

How the document-level discount is expressed: PERCENTAGE or AMOUNT.

Quote.discountValue ● Float! non-null scalar​

The document-level discount, as a percentage or an amount according to discountType.

Quote.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Quote.enterer ● User! non-null object​

The user who created the quote.

Quote.exchangeRate ● Float scalar​

Exchange rate between the document currency and the organization's base currency, when they differ.

Quote.id ● ID! non-null scalar​

Unique identifier of the record.

Quote.internalNotes ● String scalar​

Notes for your team only; never shown to the customer.

Quote.items ● [QuoteItem!]! non-null object​

The line items on the quote.

Quote.lossNotes ● String scalar​

Free-text detail recorded with a LOST close.

Quote.lossReason ● String scalar​

Why the quote was lost (closeQuote LOST) — tenant-defined label.

Quote.lostAt ● DateTime scalar​

When the quote was marked lost. Null otherwise.

Quote.notes ● String scalar​

Notes on the document, visible to the customer.

Quote.organization ● Organization! non-null object​

The organization that owns the quote.

Quote.organizationId ● String! non-null scalar​

The ID of the organization (tenant) that owns the record.

Quote.ownership ● DocumentOwnershipOutput object​

The user who owns the quote.

Quote.paymentTerms ● String scalar​

The payment terms agreed for the quote.

Quote.priority ● String scalar​

How urgent the quote is: LOW, NORMAL, HIGH or URGENT.

Quote.quoteDate ● DateTime! non-null scalar​

The date the quote was issued.

Quote.quoteNumber ● String! non-null scalar​

The human-readable quote number, unique within the organization.

Quote.reference ● String scalar​

Your own reference for the quote, such as a customer enquiry number.

Quote.shippingAddress ● String scalar​

The shipping address, as text.

Quote.shippingCost ● Float! non-null scalar​

Shipping charge on the quote.

Quote.status ● String! non-null scalar​

Where the quote is in its lifecycle: DRAFT, SENT, ACCEPTED, REJECTED, EXPIRED or CONVERTED.

Quote.subtotal ● Float! non-null scalar​

Subtotal of the quote lines, as calculated by the server.

Quote.taxAmount ● Float! non-null scalar​

Total tax on the quote.

Quote.taxCalculationMethod ● String scalar​

Whether line prices include tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

Quote.taxRate ● Float! non-null scalar​

The document-level tax rate, as a percentage.

Quote.terms ● String scalar​

Terms and conditions printed on the quote.

Quote.totalAmount ● Float! non-null scalar​

The quote total in the quote currency, as calculated and stored by the server.

Quote.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Quote.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Quote.validUntil ● DateTime scalar​

The date until which the quote can be accepted. Null when it does not expire.

Quote.version ● Int! non-null scalar​

Optimistic-concurrency counter — pass back as expectedVersion on the next mutation.

Quote.warehouse ● Warehouse object​

The warehouse the quote is fulfilled from.

Quote.warehouseId ● String scalar​

The ID of the warehouse the quote is fulfilled from.

Quote.winReason ● String scalar​

Why the quote was won (closeQuote WON) — tenant-defined label.

Quote.wonAt ● DateTime scalar​

When the quote was marked won. Null otherwise.

Returned By​

closeQuote mutation ● createQuote mutation ● duplicateQuote mutation ● quote query ● quotes query ● quotesSync query ● removeQuote mutation ● updateQuote mutation

Member Of​

QuotesPaginatedResponse object