> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. --- id: 1d884944-f0e3-4d8c-ad78-75124a408e8f --- # Legacy quotes > The legacy quotes API endpoints allow you to create and manage HubSpot quotes and sync quote data to other systems. export const PostmanCard = ({title, collectionId}) => { return
} />
; }; export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; Use the quotes API to create, manage, and retrieve sales quotes for sharing pricing information with potential buyers. Once configured, a quote can be shared with a buyer either at a specified URL or through PDF. Users can also [manage quotes in HubSpot](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes-legacy#manage-quotes) to add details, update associations, and more. If you’ve set up either [HubSpot payments](https://knowledge.hubspot.com/payment-processing/set-up-payments) or [Stripe payment processing](https://knowledge.hubspot.com/payment-processing/connect-your-stripe-account-as-a-payment-processor-in-hubspot), you can configure a quote to be payable through this API. Learn more about [payable quotes](/api-reference/legacy/crm/objects/quotes/guide#enable-payments). example-quote-api **Example use case:** You need to create a contract proposal for a customer who is interested in purchasing one of your annual SEO auditing service packages. Below, learn how to create a quote through the API and configure its various properties, associations, states, and more. ## Overview The quote creation process can be broken up into the following steps: 1. **Create a quote:** create a quote with a few details, such as name and expiration date. You can also configure the quote to [enable e-signatures](/api-reference/legacy/crm/objects/quotes/guide#enable-e-signatures) and [payments](/api-reference/legacy/crm/objects/quotes/guide#enable-payments)[](https://knowledge.hubspot.com/quotes/use-e-signatures-with-quotes). 2. **Set up associations:** associate the quote with other types of CRM objects, such as line items, a quote template, a deal, and more. During the next step, the quote will inherit property values from some of these associated records as well as the account's settings. 3. **Set the quote state:** set the quote's state to reflect its readiness to be shared with buyers. When you set the quote's state, such as making it an editable draft or fully published and publicly accessible quote, it will [inherit certain properties](#properties-set-by-quote-state) from its associated CRM records and account settings. 4. **Share the quote:** once a quote has been published, you can share it with your buyers. ## Create a quote To create a quote, you'll first configure its basic details by making a `POST` request to `/crm/v3/objects/quotes`. Later, you'll make a separate call to associate the quote with other objects, such as the quote template, line items, or a deal. Depending on your preferred workflow, you can instead [create a quote with associations through one POST request](#create-a-quote-with-associations-single-request). In the post body, include the following required properties to configure its basic details. ```json theme={null} { "properties": { "hs_title": "CustomerName - annual SEO audit", "hs_expiration_date": "2023-12-10" } } ``` | Parameter | Type | Description | | -------------------- | ------ | -------------------------------- | | `hs_title` | String | The name of the quote. | | `hs_expiration_date` | String | The date that the quote expires. | The above are just the minimum required properties to get a quote started, but [other properties](/api-reference/legacy/crm/objects/quotes/guide#adding-associations) are required to publish a quote. To see all available quote properties, make a `GET` request to `crm/v3/properties/quotes`. Learn more about the [properties API](/api-reference/legacy/crm/properties/guide). The response will include an `id`, which you'll use to continue configuring the quote. You can update quote properties at any time by making a `PATCH` request to `/crm/v3/objects/quotes/{quoteId}`. ### Quote owner Setting the `hubspot_owner_id` property manually isn't possible due to it being a calculated property, and any values will be overridden. When using quotes, the property works as follows: * If a [deal is associated with the quote](#adding-associations), the `hubspot_owner_id` property will reflect the `hs_associated_deal_owner_id` property (`hs_associated_deal_owner_id` is a calculated property). * If a deal isn't associated with the quote, the `hubspot_owner_id` property will reflect the `hs_quote_owner_id` property. ### Enable e-signatures To enable e-signatures on the quote, include the `hs_esign_enabled` boolean property in your request body with a value of `true`. Note that you will not be able to add countersigners through the API, so those will need to be added in HubSpot before publishing the quote. You also cannot publish a quote with e-sign enabled if you've [exceeded your monthly e-signature limit](https://knowledge.hubspot.com/quotes/use-e-signatures-with-quotes#monitor-e-signature-usage). ```json theme={null} { "properties": { "hs_title": "CustomerName - annual SEO audit", "hs_expiration_date": "2023-12-10", "hs_esign_enabled": "true" } } ``` Later, you'll need to associate the quote with the quote signers. While the contacts signing the quote exist as contacts in HubSpot, they're stored as a separate association type from contacts. Learn more about [associating quotes with quote signers](#associating-quote-signers). ### Enable payments To turn on payments on a quote, include the `hs_payment_enabled` boolean property in your request body with a value of `true`. Depending on your payment processor and accepted payment methods, you’ll also need to set `hs_payment_type` and `hs_allowed_payment_methods`. **Please note:** The HubSpot account must have either [HubSpot payments](https://knowledge.hubspot.com/payment-processing/set-up-payments) or [Stripe payment processing](https://knowledge.hubspot.com/payment-processing/connect-your-stripe-account-as-a-payment-processor-in-hubspot) set up before using this capability. | Parameter | Type | Description | | ----------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `hs_payment_enabled` | Boolean | When set to `true`, enables the quote to collect payment using either HubSpot payments or Stripe payment processing. Default is `false`. | | `hs_payment_type` | Enumeration | Determines which payment processor to use. Value can be either `HUBSPOT` or `BYO_STRIPE`. | | `hs_allowed_payment_methods` | Enumeration | The payment methods to be used (e.g., credit card). | | `hs_collect_billing_address` | Boolean | When set to `true`, allows the buyer to enter their billing address during checkout. | | `hs_collect_shipping_address` | Boolean | When set to `true`, allows the buyer to enter their shipping address during checkout. | For example, to create a quote and enable HubSpot payments via credit/debit card or ACH, your request would look like: ```json theme={null} { "properties": { "hs_title": "CustomerName - annual SEO audit", "hs_expiration_date": "2023-12-10", "hs_payment_enabled": "true", "hs_payment_type": "HUBSPOT", "hs_allowed_payment_methods": "CREDIT_OR_DEBIT_CARD;ACH" } } ``` To track payment, HubSpot will automatically update the `hs_payment_status` and `hs_payment_date` properties: * When you publish a quote with payments enabled, HubSpot will automatically set the `hs_payment_status` property to `PENDING`. * If using ACH, when the payment is processed, HubSpot will automatically set the `hs_payment_status` property to `PROCESSING`. * When the payment is confirmed, HubSpot will automatically set the `hs_payment_status` property to `PAID`. * Once the quote is paid, HubSpot will automatically set `hs_payment_date` to the date and time that the payment was confirmed. * Once payment is confirmed, the payment is automatically associated to the quote. If you would like to retrieve more information about the payment, refer to the [Payments API](/api-reference/legacy/crm/objects/commerce-payments/guide). ## Adding associations To create a complete quote, you'll need to associate it with other CRM records, such as line items, using the [associations API](/api-reference/legacy/crm/associations/associate-records/guide). The table below shows which CRM record associations are required for a complete quote, and which are optional. Continue reading to learn more about retrieving IDs and using them to create the needed associations. | Object type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Line items](/api-reference/legacy/crm/objects/line-items/guide) | Yes | The goods and/or services being sold through the quote. You can create line items from [products in your product library](/api-reference/legacy/crm/objects/products/guide) or create custom standalone line items. | | [Quote template](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes-legacy) | Yes | The template that renders the quote, along with providing some default configuration settings for the quote, such as language. Each quote can be associated with one template. | | [Deal](/api-reference/legacy/crm/objects/deals/guide) | Yes | The deal record for tracking revenue and sales lifecycle. A quote inherits values from the associated deal, including the owner and currency. Each quote can be associated with one deal. | | [Contact](/api-reference/legacy/crm/objects/contacts/guide) | No | Specific buyers that you're addressing in the quote. | | [Company](/api-reference/legacy/crm/objects/companies/guide) | No | A specific company that you're addressing in the quote. Each quote can be associated with one company. | | [Discounts](/api-reference/legacy/crm/objects/discounts/guide), [fees](/api-reference/legacy/crm/objects/fees/guide), and [taxes](/api-reference/legacy/crm/objects/taxes/guide) | No | Any discounts, fees, and taxes to be applied at checkout. When determining the total quote amount, HubSpot first applies discounts, followed by fees, then taxes. You can use the `hs_sort_order` field to reorder objects of the same type. Can be set to fixed values or percentages by setting `hs_type` to either `FIXED` or `PERCENT`. | ### Retrieving IDs for associations To make each association, you'll first need to retrieve the ID of each object you want to associate. To retrieve each ID, you'll make a `GET` request to the relevant object endpoint, which follows the same pattern across each CRM object. When making each request, you can also include a `properties` query parameter to return specific properties when needed. Below are example `GET` requests for each type of object. ```text hubl.txt theme={null} GET request for line items /crm/v3/objects/line_items?properties=name GET request for quote templates /crm/v3/objects/quote_template?properties=hs_name GET request for deals /crm/v3/objects/deals?properties=dealname GET request for contacts /crm/v3/objects/contacts?properties=email GET request for companies /crm/v3/objects/companies?properties=name GET request for discounts crm/v3/objects/discounts?properties=hs_type,hs_value GET request for fees crm/v3/objects/fees?properties=hs_type,hs_value GET request for taxes crm/v3/objects/taxes?properties=hs_type,hs_value ``` ```bash example.sh theme={null} #GET request for line items curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/line_items?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for quote templates curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/quote_templates?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for deals curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/deals?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for contacts curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/contacts?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for companies curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/companies?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for discounts curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/discounts?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for fees curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/fees?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #GET request for taxes curl --request GET \ --url 'https://api.hubapi.com/crm/v3/properties/taxes?archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' ``` Each successful call will return a `200` response with details for each fetched object type. You'll use the value in the `id` field to set associations in the next step. ```json theme={null} { "results": [ { "id": "235425923863", "properties": { "hs_createdate": "2023-06-12T16:27:32.794Z", "hs_lastmodifieddate": "2023-06-12T16:27:32.794Z", "hs_name": "Default Basic", "hs_object_id": "235425923863" }, "createdAt": "2023-06-12T16:27:32.794Z", "updatedAt": "2023-06-12T16:27:32.794Z", "archived": false }, { "id": "235425923864", "properties": { "hs_createdate": "2023-06-12T16:27:32.794Z", "hs_lastmodifieddate": "2023-06-12T16:27:32.794Z", "hs_name": "Default Modern", "hs_object_id": "235425923864" }, "createdAt": "2023-06-12T16:27:32.794Z", "updatedAt": "2023-06-12T16:27:32.794Z", "archived": false }, { "id": "235425923865", "properties": { "hs_createdate": "2023-06-12T16:27:32.794Z", "hs_lastmodifieddate": "2023-06-12T16:27:32.794Z", "hs_name": "Default Original", "hs_object_id": "235425923865" }, "createdAt": "2023-06-12T16:27:32.794Z", "updatedAt": "2023-06-12T16:27:32.794Z", "archived": false } ] } ``` ### Creating associations With your IDs retrieved, you can now make calls to the [associations API](/api-reference/legacy/crm/associations/associate-records/guide) to create associations. For each type of object you want to associate with a quote, you'll need to make a separate call by making a `PUT` request using the URL structure below: `/crm/v4/objects/quotes/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}` | Parameter | Description | | -------------- | ----------------------------------------------------------------------------------------------------- | | `fromObjectId` | The ID of the quote. | | `toObjectType` | The type of object you're associating with. For example, `line_items`, `deals`, and `quote_template`. | | `toObjectId` | The ID of the object you're associating the quote with. | Below are example `PUT` requests for each type of object. ```text hubl.txt theme={null} PUT request to associate a line item /crm/v4/objects/quotes/{quoteId}/associations/default/line_items/{lineItemId} PUT request to associate a quote template /crm/v4/objects/quotes/{quoteId}/associations/default/quote_template/{quoteTemplateId} PUT request to associate a deal /crm/v4/objects/quotes/{quoteId}/associations/default/deals/{dealId} PUT request to associate contacts /crm/v4/objects/quotes/{quoteId}/associations/default/contacts/{contactId} PUT request to associate companies /crm/v4/objects/quotes/{quoteId}/associations/default/companies/{companyId} PUT request to associate discounts /crm/v4/objects/quotes/{quoteId}/associations/default/discounts/{discountId} PUT request to associate fees /crm/v4/objects/quotes/{quoteId}/associations/default/fees/{feeId} PUT request to associate taxes /crm/v4/objects/quotes/{quoteId}/associations/default/taxes/{taxId} ``` ```bash example.sh theme={null} #PUT request to associate line items curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/line_items/{lineItemId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate a quote template curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quote_ID}/associations/default/quote_template/{quoteTemplateId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate a deal curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/deals/{dealId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate contacts curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/contacts/{contactId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate a company curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/companies/{companyId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate discounts curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/discounts/{discountId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate fees curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/fees/{feeId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' #PUT request to associate taxes curl --request PUT \ --url https://api.hubapi.com/crm/v4/objects/quotes/{quoteId}/associations/default/line_items/{taxId} \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN' ``` As an example, if your quote has an ID of `123456`, the requests to associate the quote might include the following: * **Line items (IDs: `55555`, `66666`):** * `/crm/v4/objects/quotes/123456/associations/default/line_items/55555` * `/crm/v4/objects/quotes/123456/associations/default/line_items/66666` * **Quote template (ID:** `987654`**):** `/crm/v4/objects/quotes/123456/associations/default/quote_template/987654` * **Deal (ID: `345345`):** `/crm/v4/objects/quotes/123456/associations/default/deals/345345` Each successful association will return a `200` response with details about the association. The above calls will associate the objects in both directions, with each direction have its own ID. For example, if you associate the quote with a quote template, the response will describe the association from both ends. In the example response below, `286` is the quote-to-quote-template association type ID, and `285` is the quote-template-to-quote association type ID. ```json theme={null} { "status": "COMPLETE", "results": [ { "from": { "id": "115045534742" }, "to": { "id": "102848290" }, "associationSpec": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 285 } }, { "from": { "id": "102848290" }, "to": { "id": "115045534742" }, "associationSpec": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 286 } } ], "startedAt": "2023-10-12T16:48:40.624Z", "completedAt": "2023-10-12T16:48:40.712Z" } ``` **Please note:** When associating a quote with a quote template: * Quote templates must be [created](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes-legacy) before they can be associated with a quote. * A quote can only be associated with on quote template. * This API does not support legacy or proposal quotes. Only the `CUSTOMIZABLE_QUOTE_TEMPLATE` template type can be used. ### Associating quote signers If you're [enabling the quote for e-signatures](#enable-e-signatures), you'll also need to create an association between the quote and the contacts who are signing by using a specific quote-to-contact [association label](/api-reference/legacy/crm/associations/associate-records/guide#associate-records-with-a-label). Rather than using the default association endpoints shown above, you'll need to make a `PUT` request to the following URL: `/crm/v4/objects/quote/{quoteId}/associations/contact/{contactId}` In the request body, you'll need to specify the `associationCategory` and `associationTypeId`, as shown below: ```json theme={null} [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 702 } ] ``` ## Create a quote with associations (single request) The following request body will create a new quote with associations to a quote template, a deal, two line items, and a contact. In order for the request body below to successfully create a quote in your account, you'll need to update the object IDs in the `associations` field to match existing data in your CRM. Review the [Retrieving IDs for associations section](#retrieving-ids-for-associations) for additional guidance. `POST` `/crm/v3/objects/quote` ```json theme={null} { "properties": { "hs_title": "CustomerName - annual SEO audit", "hs_expiration_date": "2023-09-30" }, "associations": [ { "to": { "id": 115045534742 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 286 } ] }, { "to": { "id": 14795354663 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 64 } ] }, { "to": { "id": 75895447 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 67 } ] }, { "to": { "id": 256143985 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 67 } ] } ] } ``` | Parameter | Type | Description | | -------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `properties` | Object | Property values to define the quote details. Required properties are `hs_title` and `hs_expiration_date`: | | `associations` | Array | The other CRM records and objects associated with the quote. For a quote to be publishable, it must have an associated deal and quote template. Line items associated with a quote should be distinct from the line items associated with the quote's deal (i.e., you should create copies of the line items).

To set each association, include a separate object in this array with the following fields: | **Please note:** These line items should be different to line items on other objects, even if they are associated (e.g., associating a quote to a deal). See the [line items API documentation](/api-reference/legacy/crm/objects/line-items/guide) for more information. ## Update quote state A quote's state describes how far along it is in the creation process, from initial set up to being published and publicly accessible. Quote state can also reflect the [quote approval process](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes), if quote approvals are enabled for the account. When setting a quote's state, HubSpot will [automatically fill in certain properties](#properties-set-by-quote-state). You can update a quote's state by making a `PATCH` request to `/crm/v3/objects/quote/{quoteId}`. A quote's state is based on the `hs_status` field. Certain quote states allow users to edit, publish, and use the quote in quote approval workflows. Below are the available quote states. * **No state:** if no value is provided for the `hs_status` field, the quote will be in a *Minimal* state. The quote will appear on the index page of the quotes tool, but cannot be edited directly. Quotes in this state can still be used in automation, such as the sequences tool, and are also available to analyze within the reporting tool. * `DRAFT`: enables the quote to be edited in HubSpot. This state can be useful for when the quote isn't fully configured or if you'd rather enable sales reps to complete the quote configuration process in HubSpot. * `APPROVAL_NOT_NEEDED`: publishes the quote at a publicly accessible URL (`hs_quote_link`) without needing to be [approved](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes). * `PENDING_APPROVAL`: indicates that the quote is [waiting to be approved](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes) before it can be published. * `APPROVED`: the quote has been [approved](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes) and is now published at a publicly accessible URL (`hs_quote_link`). * `REJECTED`: indicates that the quote has been set up but has not been [approved](https://knowledge.hubspot.com/quotes/set-up-legacy-quotes) for publishing, and must be edited before it can be submitted for approval again. **Please note:** If you're [enabling e-signatures](#enabling-e-signatures) on the quote, you won't be able to publish the quote if you've exceeded your [monthly e-signature limit](https://knowledge.hubspot.com/quotes/use-e-signatures-with-quotes#monitor-e-signature-usage). For example, the following request would publish the quote at a publicly accessible URL. ```json theme={null} { "properties": { "hs_status": "APPROVAL_NOT_NEEDED" } } ``` **Please note:** By default, HubSpot will set the quote's `hs_template_type` property to `CUSTOMIZABLE_QUOTE_TEMPLATE` after you [update the quote's state](/api-reference/legacy/crm/objects/quotes/guide#update-quote-state). This template type is supported by the v3 API, whereas the following template types are legacy templates that are no longer supported: * `QUOTE` * `PROPOSAL` ### Properties set by quote state Updating the quote's state will update the following properties: * `hs_quote_amount`: calculated based on any associated line items, taxes, discounts, and fees. * `hs_domain`: set from the associated quote template. * `hs_slug`: randomly generated if one is not explicitly provided. * `hs_quote_total_preference`: set based on your account settings. If you haven't configured this setting, it will default to the value of the total\_first\_payment field. * `hs_timezone`: defaults to your HubSpot account's timezone. * `hs_locale`: set from the associated quote template. * `hs_quote_number`: set based on the current date and time, unless one is provided. * `hs_language`: set from the associated quote template. * `hs_currency`: set based on the associated deal. If you haven't associated a deal with the quote, it will default to your HubSpot account's default currency. Additionally, the properties below will be calculated when the quote is set to a published state: * `hs_pdf_download_link`: populated with a URL of a PDF for the quote. * `hs_locked`: set to `true`. To modify any properties after you've published a quote, you must first update the `hs_status` of the quote back to `DRAFT`, `PENDING_APPROVAL`, or `REJECTED`. * `hs_quote_link`: the quote's publicly accessible URL. This is a read-only property and cannot be set through the API after publishing. * `hs_esign_num_signers_required`: if you've [enabled e-signatures](#enable-e-signatures), displays the number of signatures required. * `hs_payment_status`: the status of payment collection, if you’ve enabled payments. Upon publishing with payments enabled, this property will be set to PENDING. Once the buyer submits payment through the quote, the status will automatically update accordingly. Learn more about [enabling payments](/api-reference/legacy/crm/objects/quotes/guide#enable-payments). ## Retrieve quotes You can retrieve quotes individually or in batches. * To retrieve an individual quote, make a `GET` request to `/crm/v3/objects/quotes/{quoteID}`. * To request a list of all quotes, make a `GET` request to `/crm/v3/objects/quotes`. For these endpoints, you can include the following query parameters in the request URL: | Parameter | Description | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `properties` | A comma separated list of the properties to be returned in the response. If a requested property isn't defined, it won't be included in the response. If a requested property is defined but a quote doesn't have a value, it will be returned as `null`. | | `propertiesWithHistory` | A comma separated list of the current and historical properties to be returned in the response. If a requested property isn't defined, it won't be included in the response. If a requested property is defined but a quote doesn't have a value, it will be returned as `null`. | | `associations` | A comma separated list of objects to retrieve associated IDs for. Any specified associations that don't exist will not be returned in the response. Learn more about the [associations API.](/api-reference/legacy/crm/associations/associate-records/guide) | To retrieve a batch of specific quotes by their IDs, make a `POST` request to `crm/v3/objects/quotes/batch/read` and include the IDs in the request body. You can also include a `properties` array to specify which properties to return. The batch endpoint cannot retrieve associations. Learn how to batch read associations with the [associations API](/api-reference/legacy/crm/associations/associate-records/guide). ```json theme={null} { "inputs": [ { "id": "342007287" }, { "id": "81204505203" } ], "properties": ["hs_content", "hs_sentiment", "hs_submission_timestamp"] } ``` ## Scopes The following scopes are required for an app to create a valid publishable quote: * `crm.objects.quotes.write`, `crm.objects.quotes.read`, `crm.objects.line_items.write`, `crm.objects.line_items.read`, `crm.objects.owners.read`, `crm.objects.contacts.write`, `crm.objects.contacts.read`, `crm.objects.deals.write`, `crm.objects.deals.read`, `crm.objects.companies.write`, `crm.objects.companies.read` * `crm.schemas.quote.read`, `crm.schemas.line_items.read`, `crm.schemas.contacts.read`, `crm.schemas.deals.read`, `crm.schemas.companies.read`