quotes

Create Quote

Create a new quote on an opportunity (project/deal/account record).

  • opportunityId: Required — record ID used by the payment service.
  • sections or lineItems: At least one item required
  • discountType / discountValue: Optional discount
  • taxId: Optional tax
  • issueDate / status: issueDate only allowed with status of SENT or APPROVED

To add or replace line items on a work order, use PUT /work-orders/{work_order_id}/line-items instead.

post/quotes

Request

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

Request body

opportunityIdinteger required

Opportunity / project / account record ID

discountType'PERCENTAGE' | 'FIXED'

Discount type

discountValuenumber double

Discount amount or percentage

taxIdinteger

Tax configuration ID

issueDatestring date-time

Issue date. Requires status to be SENT or APPROVED.

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

Initial status (defaults to DRAFT)

descriptionstring nullable
titlestring

Quote title (defaults to "Quote")

servicePlanInstanceIdinteger
siteIdinteger

Response

Quote created 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.