UpdateQuoteInput
Changes to a quote. Only the fields you send change.
input UpdateQuoteInput {
billingAddress: String
convertMissingCurrencyPrices: Boolean
currency: String
customerEmail: String
customerId: String
customerMobile: String
customerName: String
deliveryInstructions: String
discountAmount: Float
discountType: String
discountValue: Float
exchangeRate: Float
expectedVersion: Int
id: ID!
internalNotes: String
items: [UpdateQuoteItemInput!]
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
UpdateQuoteInput.billingAddress ● String scalar
Billing address shown on the quote.
UpdateQuoteInput.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.
UpdateQuoteInput.currency ● String scalar
ISO 4217 currency code of the quote.
UpdateQuoteInput.customerEmail ● String scalar
Email address the quote is addressed to. It can differ from the customer's main email.
UpdateQuoteInput.customerId ● String scalar
The ID of the customer the quote is for.
UpdateQuoteInput.customerMobile ● String scalar
Customer mobile number shown on the quote.
UpdateQuoteInput.customerName ● String scalar
Customer name shown on the quote.
UpdateQuoteInput.deliveryInstructions ● String scalar
Delivery instructions for this quote.
UpdateQuoteInput.discountAmount ● Float scalar
Quote-level discount as an amount. Must not be negative.
UpdateQuoteInput.discountType ● String scalar
How the quote-level discount is read: PERCENTAGE or AMOUNT.
UpdateQuoteInput.discountValue ● Float scalar
Quote-level discount, read as a percentage or an amount according to discountType. Must not be negative.
UpdateQuoteInput.exchangeRate ● Float scalar
Exchange rate between the quote currency and the organization's base currency. Must be greater than zero.
UpdateQuoteInput.expectedVersion ● Int scalar
Optimistic-concurrency check: the version this client read. Stale → typed VERSION_CONFLICT under COMMAND_CAS=enforce.
UpdateQuoteInput.id ● ID! non-null scalar
The ID of the quote to change.
UpdateQuoteInput.internalNotes ● String scalar
Notes for your team only, not shown to the customer.
UpdateQuoteInput.items ● [UpdateQuoteItemInput!] list input
The quote lines.
UpdateQuoteInput.notes ● String scalar
Notes for the customer.
UpdateQuoteInput.ownership ● DocumentOwnershipInput input
The user who owns the quote.
UpdateQuoteInput.paymentTerms ● String scalar
Payment terms code. It must be a valid payment term code.
UpdateQuoteInput.priority ● String scalar
Priority of the quote: LOW, NORMAL, HIGH or URGENT.
UpdateQuoteInput.quoteDate ● String scalar
The quote's date, as an ISO 8601 date. A date other than today needs the backdate permission and is recorded in the audit trail.
UpdateQuoteInput.reference ● String scalar
Reference shown on the quote, such as a customer enquiry number.
UpdateQuoteInput.shippingAddress ● String scalar
Shipping address shown on the quote.
UpdateQuoteInput.shippingCost ● Float scalar
Shipping cost for the quote. Must not be negative.
UpdateQuoteInput.status ● String scalar
Move the quote to this status. Only transitions the quote status rules allow are accepted.
UpdateQuoteInput.subtotal ● Float scalar
Sum of the line values before quote-level discount, tax and shipping.
UpdateQuoteInput.taxAmount ● Float scalar
Total tax on the quote.
UpdateQuoteInput.taxCalculationMethod ● String scalar
Tax method for the whole quote: INCLUSIVE or EXCLUSIVE.
UpdateQuoteInput.taxRate ● Float scalar
Quote-level tax rate.
UpdateQuoteInput.terms ● String scalar
Terms and conditions text for the quote.
UpdateQuoteInput.totalAmount ● Float scalar
Total amount of the quote.
UpdateQuoteInput.validUntil ● String scalar
Date the quote stops being valid, as an ISO 8601 date.
UpdateQuoteInput.warehouseId ● String scalar
The ID of the default warehouse for the quote.
Member Of
updateQuote mutation