quotes

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.

patch/quotes/{quote_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/quotes/{quote_id}
  • Auth: API key in header x-api-key

Path parameters

quote_idstring required

Request body

discountType'PERCENTAGE' | 'FIXED'
discountValuenumber double
taxIdinteger nullable
issueDatestring date-time
status'DRAFT' | 'SENT' | 'APPROVED' | 'CHANGES_REQUESTED' | 'DECLINED'
descriptionstring nullable
sharedWithPortalboolean

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

isArchivedboolean

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

Response

Quote updated successfully

idinteger required

Quote identifier

quoteNumberinteger nullable

Unique quote number (uid)

descriptionstring nullable

Quote description

status'DRAFT' | 'SENT' | 'APPROVED' | 'CHANGES_REQUESTED' | 'DECLINED' required

Quote status

amountnumber double required

Total quote amount (dollars)

discountType'PERCENTAGE' | 'FIXED'

Discount type

discountValuenumber double nullable

Discount amount or percentage value

taxIdinteger nullable

Tax configuration ID

issueDatestring date-time nullable

Issue date when the quote has been issued

subtotalnumber double nullable

Subtotal in dollars (before tax)

taxRatenumber double nullable

Applied tax rate

isArchivedboolean

Whether the quote is archived

sharedWithPortalboolean

Whether the quote is shared with the client portal

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.