Objects

Update a quotation

Updates an existing quotation (partial update). Line items and tags replace the full set when provided. Custom field values use cf_* keys and are merged with existing values.

patch/quotations/{id}

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/quotations/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Quotation ID

Request body

clientIdstring

Contact or company ID (clt_ prefix)

contactIdstring

Optional contact person ID (clt_ prefix) when clientId is a company

dealIdstring

Deal ID (dl_ prefix)

templateIdstring

Document template ID (tpl_ prefix)

datestring date-time

Quotation date

expiryDatestring date-time

Expiry date

subjectstring

Subject

titlestring

Internal title

status'DRAFT' | 'SENT' | 'ACCEPTED' | 'REJECTED'

Initial status (defaults to DRAFT)

isInclusiveTaxboolean

Whether prices include tax

contentHtmlstring

Document HTML (defaults from template when omitted)

internalNotesstring

Internal notes

salesPersonIdstring

Sales person user ID (usr_ prefix)

currencystring

ISO 4217 currency code

conversionRatenumber

Quotation currency to team currency rate

tagsstring[]

Tag IDs (tag_ prefix)

Response

OK

idstring required

Quotation ID (qtn_ prefix)

numberstring required

Auto-generated quotation number

datestring date-time required

Quotation date

status'DRAFT' | 'SENT' | 'ACCEPTED' | 'REJECTED' required

Quotation status

subjectstring nullable

Subject

expiryDatestring date-time nullable

Expiry date

currencystring required

ISO 4217 currency code

conversionRatenumber

Quotation currency to team currency rate

isInclusiveTaxboolean

Whether prices include tax

clientIdstring nullable

Contact or company ID (clt_ prefix)

contactIdstring nullable

Optional contact person ID (clt_ prefix) when clientId is a company

dealIdstring nullable

Deal ID (dl_ prefix)

salesPersonIdstring nullable

Sales person user ID (usr_ prefix)

templateIdstring nullable

Document template ID (tpl_ prefix)

contentHtmlstring nullable

Rendered document HTML

internalNotesstring nullable

Internal notes

totalAmountnumber

Total including tax

subtotalAmountnumber

Subtotal before tax

totalTaxAmountnumber

Total tax amount

totalDiscountAmountnumber

Total discount amount

tagIdsstring[]

Tag IDs (tag_ prefix)

markedAcceptedOnstring date-time nullable

When the quotation was accepted

markedRejectedOnstring date-time nullable

When the quotation was rejected

createdAtstring date-time required
updatedAtstring date-time nullable

Changes

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