Skip to main content

CreateQuoteItemInput

A line on a quote being created.

input CreateQuoteItemInput {
  acceptAlternativeIfUnavailable: Boolean
  description: String
  discount: Float!
  discountAmount: Float
  discountType: String!
  overrideReason: String
  priceOverride: Boolean
  productId: String!
  productName: String!
  productSku: String
  quantity: Float!
  salePrice: Float
  taxAmount: Float!
  taxBreakdown: JSON
  taxCalculationMethod: String
  taxRate: Float!
  totalPrice: Float
  unitPrice: Float!
  uomId: String
  uomName: String
  variantId: String!
  warehouseId: String
}

Fields

`CreateQuoteItemInput.acceptAlternativeIfUnavailable` ● `Boolean` scalar

Whether the buyer accepts a substitute if this item is unavailable. Carried to the sales order line on conversion.

`CreateQuoteItemInput.description` ● `String` scalar

Free-text note shown on the quote line.

`CreateQuoteItemInput.discount` ● `Float!` non-null scalar

Line discount, read as a percentage or an amount according to discountType. Must not be negative; a percentage cannot exceed 100.

`CreateQuoteItemInput.discountAmount` ● `Float` scalar

Line discount as an amount. Must not be negative.

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

How discount is read: PERCENTAGE or AMOUNT.

`CreateQuoteItemInput.overrideReason` ● `String` scalar

Why the price was overridden. Up to 500 characters.

`CreateQuoteItemInput.priceOverride` ● `Boolean` scalar

Set to true to keep a negotiated unitPrice instead of the catalogue price. The caller needs the quote price-override permission.

`CreateQuoteItemInput.productId` ● `String!` non-null scalar

The ID of the product being quoted.

`CreateQuoteItemInput.productName` ● `String!` non-null scalar

Product name shown on the quote line.

`CreateQuoteItemInput.productSku` ● `String` scalar

SKU shown on the quote line.

`CreateQuoteItemInput.quantity` ● `Float!` non-null scalar

Quantity quoted, in the unit given by uomId. Must be greater than zero.

`CreateQuoteItemInput.salePrice` ● `Float` scalar

Pre-negotiated sale price from variant

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

Tax amount for the line.

`CreateQuoteItemInput.taxBreakdown` ● `JSON` scalar

Tax split by component, as JSON.

`CreateQuoteItemInput.taxCalculationMethod` ● `String` scalar

Whether the line price includes or excludes tax: INCLUSIVE or EXCLUSIVE.

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

Tax rate applied to the line.

`CreateQuoteItemInput.totalPrice` ● `Float` scalar

Total for the line.

`CreateQuoteItemInput.unitPrice` ● `Float!` non-null scalar

Price per unit in the quote currency. Must not be negative.

`CreateQuoteItemInput.uomId` ● `String` scalar

The ID of the unit of measure for the quantity.

`CreateQuoteItemInput.uomName` ● `String` scalar

Name of the unit of measure, shown on the line.

`CreateQuoteItemInput.variantId` ● `String!` non-null scalar

The ID of the product variant being quoted.

`CreateQuoteItemInput.warehouseId` ● `String` scalar

The ID of the warehouse that supplies this line.

Member Of

CreateQuoteInput input

Fields
Member Of