Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Quotes > Templates

Get quote template

Retrieve the details of an existing quote template.

get/v1/quotes/templates/{id}

Path parameters

idstring required

Response

idstring required

Quote template ID.

namestring required

Quote template name.

descriptionstring nullable required

Quote template description.

commentsstring nullable required

Default comments displayed on quotes created from the template.

termsstring nullable required

Default terms displayed on quotes created from the template.

expiration_daysinteger required

Number of days after creation before quotes created from the template expire.

collect_payment_detailsboolean required

Whether quotes created from the template collect customer payment method details during signature.

collect_shipping_detailsboolean required

Whether quotes created from the template collect customer shipping details during signature.

collect_custom_property_idsstring[] required

IDs of customer custom properties required during quote signature.

require_tax_idboolean required

Whether quotes created from the template require the customer to provide a tax ID during signature.

require_billing_detailsboolean required

Whether quotes created from the template require customer billing details during signature.

display_taxesboolean required

Whether quotes created from the template display taxes.

display_price_tiers'all' | 'matching' | 'none' required

Controls which price tiers are displayed on the quote.

  • all: Display all pricing tiers.
  • matching: Only display the tiers used to compute the price based on quantity.
  • none: Hide all pricing tiers.
display_phase_valueboolean required

Whether quotes created from the template display per-phase value breakdown.

display_quote_valueboolean required

Whether quotes created from the template display total quote value.

display_first_invoice_amountboolean required

Whether quotes created from the template display the first invoice amount.

display_documents_in_previewboolean required

Whether quotes created from the template display attached documents in the quote preview.

display_subscription_on_updateboolean required

Whether subscription update quotes created from the template display subscription details.

display_organisation_detailsboolean required

Whether quotes created from the template display organisation details.

generate_draft_invoicesboolean required

Whether invoices issued after quote signature stay in draft status instead of being emitted for payment.

subscription_template_idstring nullable required

ID of the subscription template used by the quote template.

contract_template_idsstring[] required

IDs of contract templates used by the quote template.

contract_clause_idsstring[] required

IDs of contract clauses used by the quote template.

created_atstring date-time required

Quote template creation date. UTC date time string in the ISO 8601 format.

updated_atstring date-time required

Quote template last edition date. UTC date time string in the ISO 8601 format.

Example response

{
  "id": "quot_9hNWq4c84Z146W",
  "name": "Enterprise template",
  "description": "Reusable template for enterprise quotes.",
  "comments": "Please find the contract and subscription details we discussed.",
  "terms": "By signing this quote, you accept our conditions of use for the use of our products and services.",
  "expiration_days": 30,
  "collect_payment_details": true,
  "collect_custom_property_ids": [],
  "display_taxes": true,
  "display_price_tiers": "matching",
  "display_quote_value": true,
  "display_organisation_details": true,
  "subscription_template_id": "subt_7gdusOkqr5L0B8",
  "contract_template_ids": [
    "ctpl_QalW2vTAdkR6IY"
  ],
  "contract_clause_ids": [
    "ccl_QalW2vTAdkR6IY"
  ],
  "attachments": [
    {
      "id": "quota_5GYXy8P3QCdaXh",
      "name": "General Conditions of Sale",
      "mimetype": "application/pdf"
    }
  ],
  "created_at": "2024-04-23T09:10:00.220Z",
  "updated_at": "2024-04-23T10:22:08.100Z"
}