Skip to main content

CreateQuoteInput

Input to create a quote for a customer.

input CreateQuoteInput {
  billingAddress: String
  convertMissingCurrencyPrices: Boolean
  currency: String!
  customerEmail: String
  customerId: String!
  customerMobile: String
  customerName: String
  deliveryInstructions: String
  discountAmount: Float!
  discountType: String!
  discountValue: Float!
  exchangeRate: Float
  idempotencyKey: String
  internalNotes: String
  items: [CreateQuoteItemInput!]!
  notes: String
  ownership: DocumentOwnershipInput
  paymentTerms: String
  priority: String
  quoteDate: String
  reference: String
  shippingAddress: String
  shippingCost: Float!
  status: String
  subtotal: Float!
  taxAmount: Float!
  taxCalculationMethod: String
  taxRate: Float!
  terms: String
  totalAmount: Float!
  validUntil: String
  warehouseId: String
}

Fields

`CreateQuoteInput.billingAddress` ● `String` scalar

Billing address shown on the quote.

`CreateQuoteInput.convertMissingCurrencyPrices` ● `Boolean` scalar

Opt in to pricing a foreign-currency line with no price in the quote currency by converting its base price at exchangeRate. Without it such a line is refused. A price in the quote currency always wins.

`CreateQuoteInput.currency` ● `String!` non-null scalar

ISO 4217 currency code of the quote.

`CreateQuoteInput.customerEmail` ● `String` scalar

Email address the quote is addressed to. It can differ from the customer's main email.

`CreateQuoteInput.customerId` ● `String!` non-null scalar

The ID of the customer the quote is for.

`CreateQuoteInput.customerMobile` ● `String` scalar

Customer mobile number shown on the quote.

`CreateQuoteInput.customerName` ● `String` scalar

Customer name shown on the quote.

`CreateQuoteInput.deliveryInstructions` ● `String` scalar

Delivery instructions for this quote.

`CreateQuoteInput.discountAmount` ● `Float!` non-null scalar

Quote-level discount as an amount. Must not be negative.

`CreateQuoteInput.discountType` ● `String!` non-null scalar

How the quote-level discount is read: PERCENTAGE or AMOUNT.

`CreateQuoteInput.discountValue` ● `Float!` non-null scalar

Quote-level discount, read as a percentage or an amount according to discountType. Must not be negative.

`CreateQuoteInput.exchangeRate` ● `Float` scalar

Exchange rate between the quote currency and the organization's base currency. Must be greater than zero.

`CreateQuoteInput.idempotencyKey` ● `String` scalar

Idempotency key: retries with the same key + identical payload replay the original quote.

`CreateQuoteInput.internalNotes` ● `String` scalar

Notes for your team only, not shown to the customer.

`CreateQuoteInput.items` ● `[CreateQuoteItemInput!]!` non-null input

The quote lines. At least one line is required.

`CreateQuoteInput.notes` ● `String` scalar

Notes for the customer.

`CreateQuoteInput.ownership` ● `DocumentOwnershipInput` input

The user who owns the quote.

`CreateQuoteInput.paymentTerms` ● `String` scalar

Payment terms code. It must be a valid payment term code.

`CreateQuoteInput.priority` ● `String` scalar

Priority of the quote: LOW, NORMAL, HIGH or URGENT.

`CreateQuoteInput.quoteDate` ● `String` scalar

The quote's date, as an ISO 8601 date. Empty means today. Any other date needs the backdate permission and is recorded in the audit trail.

`CreateQuoteInput.reference` ● `String` scalar

Reference shown on the quote, such as a customer enquiry number.

`CreateQuoteInput.shippingAddress` ● `String` scalar

Shipping address shown on the quote.

`CreateQuoteInput.shippingCost` ● `Float!` non-null scalar

Shipping cost for the quote. Must not be negative.

`CreateQuoteInput.status` ● `String` scalar

Initial status. A quote cannot be created already decided, so ACCEPTED, REJECTED, EXPIRED, CONVERTED and CANCELLED are refused. Defaults to DRAFT.

`CreateQuoteInput.subtotal` ● `Float!` non-null scalar

Sum of the line values before quote-level discount, tax and shipping.

`CreateQuoteInput.taxAmount` ● `Float!` non-null scalar

Total tax on the quote.

`CreateQuoteInput.taxCalculationMethod` ● `String` scalar

Tax method for the whole quote: INCLUSIVE or EXCLUSIVE.

`CreateQuoteInput.taxRate` ● `Float!` non-null scalar

Quote-level tax rate.

`CreateQuoteInput.terms` ● `String` scalar

Terms and conditions text for the quote.

`CreateQuoteInput.totalAmount` ● `Float!` non-null scalar

Total amount of the quote.

`CreateQuoteInput.validUntil` ● `String` scalar

Date the quote stops being valid, as an ISO 8601 date.

`CreateQuoteInput.warehouseId` ● `String` scalar

The ID of the default warehouse for the quote.

Member Of

createQuote mutation

Fields
Member Of