API ReferenceQuotes

Update Quote

Update an existing quote. Supports partial updates. **`isArchived`**: pass `true` to archive or `false` to unarchive. When setting **`status`** to anything other than **`DRAFT`**, you must supply **`issueDate`** unless the quote already has one. **`sharedWithPortal`**: pass `true` or `false` to show or hide the quote on the client portal.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

quoteIdstringRequired

Request

This endpoint expects an object.
sectionslist of objectsOptional
lineItemslist of objectsOptional
discountTypeenumOptional
Allowed values:
discountValuedoubleOptional>=0
taxIdinteger or nullOptional
issueDatestringOptionalformat: "date-time"
statusenumOptional
Allowed values:
descriptionstring or nullOptional
sharedWithPortalbooleanOptional

When true, the quote is visible on the client portal; when false, it is hidden.

isArchivedbooleanOptional

Set true to archive or false to unarchive (maps to payment service archive/unarchive routes)

Response

Quote updated successfully
idinteger
Quote identifier
statusenum
Quote status
Allowed values:
amountdouble

Total quote amount (dollars)

createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
quoteNumberinteger or null

Unique quote number (uid)

descriptionstring or null
Quote description
discountTypeenum or null
Discount type
Allowed values:
discountValuedouble or null
Discount amount or percentage value
taxIdinteger or null
Tax configuration ID
issueDatestring or nullformat: "date-time"
Issue date when the quote has been issued
subtotaldouble or null

Subtotal in dollars (before tax)

taxRatedouble or null
Applied tax rate
isArchivedboolean
Whether the quote is archived
sharedWithPortalboolean
Whether the quote is shared with the client portal
accountobject or null
recordobject or null
lineItemslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error