For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quotes

List Quotes

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · int32 · min: 1Optional
perPageinteger · int32 · min: 1 · max: 100Optional
querystringOptional
sortstringOptional
sortDirstring · enumOptionalPossible values:
workOrderbooleanOptional
Responses
200

List of quotes

application/json
totalRowsnumberOptional
get/quotes

Create Quote

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptional

A unique ID for the Quote. Ignored when creating & updating quotes

numbernumberOptional

The Number of the Quote

statusstring · nullableOptional

The status of this quote

hourlyRatenumberOptional

The Hourly Rate of the Quote

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead.

parentQuoteIdstring · nullableOptional

The unique ID of the parent quote if this quote was created from another quote

parentQuoteNumbernumberOptional

The quote number of the parent quote if this quote was created from another quote

childInvoiceIdstring · nullableOptional

The unique ID of the invoice created from this quote if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this quote

leadSourcestring · nullableOptional

The lead source of this quote

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this quote

estimatorNotesstring · nullableOptional

The estimator notes associated with this quote

clientNotestring · nullableOptional

The client note associated with this quote

crewNotestring · nullableOptional

The crew note associated with this quote

tagsstring[]Optional

Tags associated with this Quote

Responses
200

Details about the new Quote

application/json
idstringOptional

A unique ID for the Quote. Ignored when creating & updating quotes

numbernumberOptional

The Number of the Quote

statusstring · nullableOptional

The status of this quote

hourlyRatenumberOptional

The Hourly Rate of the Quote

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead.

parentQuoteIdstring · nullableOptional

The unique ID of the parent quote if this quote was created from another quote

parentQuoteNumbernumberOptional

The quote number of the parent quote if this quote was created from another quote

childInvoiceIdstring · nullableOptional

The unique ID of the invoice created from this quote if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this quote

leadSourcestring · nullableOptional

The lead source of this quote

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this quote

estimatorNotesstring · nullableOptional

The estimator notes associated with this quote

clientNotestring · nullableOptional

The client note associated with this quote

crewNotestring · nullableOptional

The crew note associated with this quote

tagsstring[]Optional

Tags associated with this Quote

post/quotes

Retrieve Quote

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

Query parameters
displaystring · enumOptional

Display as either a Quote or Work Order.

Default: quotePossible values:
langstring · enumOptional

Language used to locale-format Work Order values (only applies when display=work-order).

Default: enPossible values:
Responses
200

Details about the quote

application/json
idstringOptional

A unique ID for the Quote. Ignored when creating & updating quotes

numbernumberOptional

The Number of the Quote

statusstring · nullableOptional

The status of this quote

hourlyRatenumberOptional

The Hourly Rate of the Quote

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead.

parentQuoteIdstring · nullableOptional

The unique ID of the parent quote if this quote was created from another quote

parentQuoteNumbernumberOptional

The quote number of the parent quote if this quote was created from another quote

childInvoiceIdstring · nullableOptional

The unique ID of the invoice created from this quote if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this quote

leadSourcestring · nullableOptional

The lead source of this quote

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this quote

estimatorNotesstring · nullableOptional

The estimator notes associated with this quote

clientNotestring · nullableOptional

The client note associated with this quote

crewNotestring · nullableOptional

The crew note associated with this quote

tagsstring[]Optional

Tags associated with this Quote

get/quotes/{id}

Update Quote

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

Body
idstringOptional

A unique ID for the Quote. Ignored when creating & updating quotes

numbernumberOptional

The Number of the Quote

statusstring · nullableOptional

The status of this quote

hourlyRatenumberOptional

The Hourly Rate of the Quote

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead.

parentQuoteIdstring · nullableOptional

The unique ID of the parent quote if this quote was created from another quote

parentQuoteNumbernumberOptional

The quote number of the parent quote if this quote was created from another quote

childInvoiceIdstring · nullableOptional

The unique ID of the invoice created from this quote if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this quote

leadSourcestring · nullableOptional

The lead source of this quote

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this quote

estimatorNotesstring · nullableOptional

The estimator notes associated with this quote

clientNotestring · nullableOptional

The client note associated with this quote

crewNotestring · nullableOptional

The crew note associated with this quote

tagsstring[]Optional

Tags associated with this Quote

Responses
200

The updated quote

application/json
idstringOptional

A unique ID for the Quote. Ignored when creating & updating quotes

numbernumberOptional

The Number of the Quote

statusstring · nullableOptional

The status of this quote

hourlyRatenumberOptional

The Hourly Rate of the Quote

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead.

parentQuoteIdstring · nullableOptional

The unique ID of the parent quote if this quote was created from another quote

parentQuoteNumbernumberOptional

The quote number of the parent quote if this quote was created from another quote

childInvoiceIdstring · nullableOptional

The unique ID of the invoice created from this quote if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this quote

leadSourcestring · nullableOptional

The lead source of this quote

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this quote

estimatorNotesstring · nullableOptional

The estimator notes associated with this quote

clientNotestring · nullableOptional

The client note associated with this quote

crewNotestring · nullableOptional

The crew note associated with this quote

tagsstring[]Optional

Tags associated with this Quote

put/quotes/{id}

Delete Quote

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

Responses
204

No Content

No content

delete/quotes/{id}

No content

List Quote Items

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

Responses
200

List of quote items

application/json
get/quotes/{id}/items

Create Quote Item

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

Body
namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

calculateBystring · enumOptional

How price/hours are computed

Possible values:
sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:
Responses
200

Details about the new Quote Item

application/json
idstringOptional

Unique identifier for the quote item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

calculateBystring · enumOptional

How price/hours are computed for this item

Possible values:
sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:
post/quotes/{id}/items

Get Quote Item

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

itemIdstringRequired

ID of the Quote Item

Responses
200

Details about the quote item

application/json
idstringOptional

Unique identifier for the quote item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

calculateBystring · enumOptional

How price/hours are computed for this item

Possible values:
sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:
get/quotes/{id}/items/{itemId}

Update Quote Item

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

itemIdstringRequired

ID of the Quote Item

Body

Updates a quote item. The {itemId} path parameter may refer to either a line item or an area (both are returned by GET /v2/quotes/{id}/items). Fields like price, hours, quantity, pricePerUnit, and calculateBy apply only to line items; for areas, those fields are ignored (areas calculate from their substrates).

namestringOptional

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item (preferred over description when both are sent)

pricenumberOptional

The total price for this item (line items only)

hoursnumberOptional

The estimated hours for this item (line items only)

quantitynumberOptional

The quantity of this item (line items only)

pricePerUnitnumberOptional

The price per unit if quantity-based pricing (line items only)

calculateBystring · enumOptional

How price/hours are computed (line items only)

Possible values:
sectionstring · enumOptional

The section this item belongs to. Setting this moves the item.

Possible values:
Responses
200

Updated quote item details

application/json
idstringOptional

Unique identifier for the quote item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

calculateBystring · enumOptional

How price/hours are computed for this item

Possible values:
sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:
put/quotes/{id}/items/{itemId}

Delete Quote Item

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID of the Quote

itemIdstringRequired

ID of the Quote Item

Responses
204

Quote item successfully deleted

No content

delete/quotes/{id}/items/{itemId}

No content

Last updated

Was this helpful?