見積もりツールはプロスペクトに価格情報を提供するために使用します。見積もりエンドポイントを使用することにより、見積もりデータを取得したり、HubSpotと他のシステムとの間で同期したりできます。
/crm/v3/objects/quotes
にPOST
リクエストを送信して、基本的な情報を設定します。その後、見積もりを他のオブジェクト(見積もりテンプレート、商品項目、取引など)に関連付けるために、別の呼び出しを行います。
パラメーター | タイプ | 説明 |
---|---|---|
hs_title | 文字列 | 見積もりの名前。 |
hs_expiration_date | 文字列 | 見積もりの有効期限。 |
crm/v3/properties/quotes
にGET
リクエストを送信します。詳しくはプロパティーAPIをご参照ください。
レスポンスにはid
が含まれ、これを使用して見積もりの設定を続けることができます。PATCH
リクエストを/crm/v3/objects/quotes/{quoteId}
に送信することで、見積もりプロパティーをいつでも更新できます。
hubspot_owner_id
プロパティーは計算プロパティーであるため、手動で設定することはできません。値があれば、全ての値がオーバーライドされます。見積もりを使用する場合、プロパティーは次のように機能します。
hubspot_owner_id
プロパティーにはhs_associated_deal_owner_id
プロパティーが反映されます(hs_associated_deal_owner_id
は計算プロパティーです)。hubspot_owner_id
プロパティーにはhs_quote_owner_id
プロパティーが反映されます。true
の値を持つhs_esign_enabled
ブール値プロパティーをリクエスト本文に含めます。APIを使用して副署名者を追加することはできないため、見積もりを公開する前にHubSpotで副署名者を追加する必要があります。また、毎月の電子署名数の制限を超えた場合は、電子署名を有効にして見積もりを公開することはできません。
hs_payment_enabled
ブール値プロパティーを含めて、その値をtrue
に設定します。また、決済代行事業者と受け入れ可能な支払い方法によっては、hs_payment_type
とhs_allowed_payment_methods
も設定する必要があります。
パラメーター | タイプ | 説明 |
---|---|---|
hs_payment_enabled | ブール値 | true に設定すると、見積もりでHubSpot決済機能またはStripe決済処理のいずれかを使用して支払いを回収できるようになります。デフォルトの値はfalse です。 |
hs_payment_type | 列挙 | 使用する決済代行事業者を決定します。値はHUBSPOT またはBYO_STRIPE のいずれかです。 |
hs_allowed_payment_methods | 列挙 | 使用する支払い方法(クレジットカードなど)。 |
hs_collect_billing_address | ブール値 | true に設定すると、購入者は注文の確認時に請求先住所を入力できます。 |
hs_collect_shipping_address | ブール値 | true に設定すると、購入者は注文の確認時に発送先住所を入力できます。 |
hs_payment_status
プロパティーとhs_payment_date
プロパティーを自動的に更新します。
hs_payment_status
プロパティーをPENDING
に設定します。hs_payment_status
プロパティーをPROCESSING
に設定します。hs_payment_status
プロパティーをPAID
に設定します。hs_payment_date
を支払い確認日時に設定します。オブジェクトタイプ | 必須 | 説明 |
---|---|---|
商品項目 | はい | 見積もりを通して販売されている商品またはサービス。製品ライブラリー内の製品から商品項目を作成したり、カスタムのスタンドアロン商品項目を作成したりすることができます。 |
見積もりテンプレート | はい | 見積もりを表示するテンプレート。見積もりのデフォルト設定(言語など)が含まれます。見積もりごとに1つのテンプレートを関連付けることができます。 |
取引 | はい | 収益と営業ライフサイクルを追跡するために使用される取引レコード。見積もりには、関連付けられた取引からの値(担当者、通貨など)が継承されます。見積もりごとに1つの取引を関連付けることができます。 |
コンタクト | いいえ | 見積もりの対象となる特定の顧客。 |
会社 | いいえ | 見積もりの対象となる特定の会社。見積もりごとに1つの会社を関連付けることができます。 |
割引、手数料、税金 | いいえ | 決済時に適用される任意の割引、手数料、税金。合計見積もり金額を算定する際、HubSpotはまず割引を適用し、次に手数料、そして税金を適用します。hs_sort_order フィールドを使用すると、同じタイプのオブジェクトを並べ替えることができます。hs_type の値をFIXED またはPERCENT に設定することで、固定値またはパーセンテージを指定できます。 |
GET
リクエストを送信します。各CRMオブジェクトで同様の処理を行います。また、各リクエストを送信するときには、必要に応じてproperties
クエリーパラメーターを含めることで、特定のプロパティーを返すことができます。以下は、各タイプのオブジェクトに対するGET
リクエストの例です。
200
レスポンスが返されます。次のステップでは、id
フィールドの値を使用して関連付けを設定します。
PUT
リクエストを送信することで、個別の呼び出しを行う必要があります。
/crm/v4/objects/quotes/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
パラメーター | 説明 |
---|---|
fromObjectId | 見積もりのID。 |
toObjectType | 関連付けているオブジェクトのタイプ。例えば、line_items 、deals 、quote_template などです。 |
toObjectId | 見積もりに関連付けているオブジェクトのID。 |
PUT
リクエストの例です。
123456
である場合、見積もりを関連付けるリクエストは次のような内容になります。
55555
、66666
):
/crm/v4/objects/quotes/123456/associations/default/line_items/55555
/crm/v4/objects/quotes/123456/associations/default/line_items/66666
987654
): /crm/v4/objects/quotes/123456/associations/default/quote_template/987654
345345
): /crm/v4/objects/quotes/123456/associations/default/deals/345345
200
レスポンスが返されます。上記の呼び出しは、オブジェクトを両方向に関連付け、各方向に独自のIDがあります。例えば、見積もりを見積もりテンプレートに関連付けると、レスポンスには両方からの関連付けが記述されます。以下のレスポンスの例で、286
は見積もりと見積もりテンプレートの関連付けタイプID、285
は見積もりテンプレートと見積もりの関連付けタイプIDです。
PUT
リクエストを送信する必要があります。
/crm/v4/objects/quote/{quoteId}/associations/contact/{contactId}
リクエスト本文で、次のようにassociationCategory
とassociationTypeId
を指定する必要があります。
associations
フィールドのオブジェクトIDを更新する必要があります。さらに詳しいガイダンスについては、関連付けのIDの取得セクションを参照してください。POST
/crm/v3/objects/quote
パラメーター | タイプ | 説明 |
---|---|---|
properties | オブジェクト | 見積もりの詳細を定義するプロパティー値。hs_title とhs_expiration_date のプロパティーは必須です。
|
associations | 配列 | 見積もりに関連付けられているその他のCRMレコードとオブジェクト。見積もりを公開可能にするには、取引と見積もりテンプレートが関連付けられている必要があります。見積もりに関連付けられた商品項目は、見積もりの取引に関連付けられた商品項目とは異なる必要があります(つまり、商品項目のコピーを作成する必要があります)。 それぞれの関連付けを設定するには、以下のフィールドを持つ個別のオブジェクトを配列に含めます。
|
/crm/v3/objects/quote/{quoteId}
にPATCH
リクエストを送信します。
見積もりのステータスはhs_status
フィールドに基づきます。特定の見積もりのステータスで、ユーザーは見積もり承認ワークフローで見積もりを編集、公開、使用できます。以下の見積もりのステータスを利用できます。
hs_status
フィールドに値が指定されていない場合、見積もりには最小限のステータスが適用されます。この場合、見積もりは見積もりツールのインデックスページに表示されますが、直接編集することはできません。このステータスの見積もりも、シーケンスツールなどの自動化やレポートツール内での分析に使用できます。DRAFT
:HubSpotで見積もりを編集できます。このステータスは、見積もりが完全に設定されていない場合や、HubSpotでの見積もり設定プロセスを営業担当者によって完了できるようにしたい場合に役立ちます。APPROVAL_NOT_NEEDED
:承認を必要とせずに、誰でもアクセス可能なURL(hs_quote_link
)で見積もりを公開します。PENDING_APPROVAL
:見積もりが公開される前の承認待ち状態であることを示します。APPROVED
:見積もりが既に承認され、誰でもアクセス可能なURL(hs_quote_link
)に公開されました。REJECTED
:見積もりが設定されたものの、まだ公開が承認されておらず、編集してから承認用に再送信する必要があることを示します。hs_template_type
プロパティーがCUSTOMIZABLE_QUOTE_TEMPLATE
に設定されます。このテンプレートタイプはv3 APIでサポートされていますが、次のテンプレートタイプは従来のテンプレートであり、サポートが終了しています。QUOTE
PROPOSAL
hs_quote_amount
:関連付けられている商品項目、税金、割引、手数料に基づいて計算されます。hs_domain
:関連付けられている見積もりテンプレートから設定されます。hs_slug
:指定されていない場合は、無作為に生成されます。hs_quote_total_preference
:ご使用のアカウントの設定に基づいて設定されます。この設定が指定されていない場合には、デフォルト値としてtotal_first_paymentフィールドの値が使用されます。hs_timezone
:デフォルト値としてHubSpotアカウントのタイムゾーンが使用されます。hs_locale
:関連付けられている見積もりテンプレートから設定されます。hs_quote_number
:指定されていない場合、現在の日付と時刻に基づいて設定されます。hs_language
:関連付けられている見積もりテンプレートから設定されます。hs_currency
:関連付けられている取引に基づいて設定されます。見積もりに取引を関連付けていない場合、HubSpotアカウントのデフォルトの通貨がデフォルト値として使用されます。hs_pdf_download_link
:見積もりのPDFのURLが取り込まれます。hs_locked
:true
に設定されます。見積もりを公開した後にいずれかのプロパティーを変更するには、まず見積もりのhs_status
をDRAFT
、PENDING_APPROVAL
、またはREJECTED
に更新する必要があります。hs_quote_link
:見積もりの一般公開URL。これは読み取り専用プロパティーで、公開後にAPIを介して設定することはできません。hs_esign_num_signers_required
:電子署名を有効にしている場合、必要な署名の数が表示されます。hs_payment_status
:支払いを有効にしている場合の支払い回収のステータス。支払いを有効にして公開すると、このプロパティーはPENDINGに設定されます。購入者が見積もりを通じて支払いを送信すると、ステータスはそれに応じて自動的に更新されます。詳しくは支払いを有効にする方法をご確認ください。/crm/v3/objects/quotes/{quoteID}
にGET
リクエストを送信します。/crm/v3/objects/quotes
にGET
リクエストを送信します。properties
| レスポンスで返されるプロパティーのカンマ区切りリスト。リクエスト対象の見積もりで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
| propertiesWithHistory
| レスポンスで返される現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象の見積もりで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
| associations
| 関連付けられたIDを取得する対象のオブジェクトのカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPI | をご参照ください。 |
IDを指定して特定の複数の見積もりを一括取得するには、POST
リクエストをcrm/v3/objects/quotes/batch/read
に送信し、そのリクエスト本文に取得する見積もりのIDを含めます。また、返すプロパティーを指定するproperties
配列を含めることもできます。このバッチエンドポイントは関連付けを取得できません。詳しくは、関連付けAPIを使用して関連付けを一括読み取りする方法をご参照ください。
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