API du CRM | Devis - HubSpot docs

Exigences de portée

Utilisez l’API Devis pour créer, gérer et récupérer des devis afin de partager des informations sur les prix avec des acheteurs potentiels. Une fois configuré, un devis peut être partagé avec un acheteur via une URL spécifiée ou un PDF. Les utilisateurs peuvent également gérer les devis dans HubSpot pour ajouter des détails, mettre à jour les associations, etc. Si vous avez configuré les paiements HubSpot ou le traitement des paiements Stripe, vous pouvez configurer un devis à payer via cette API. En savoir plus sur les devis payables.

Exemple de cas d’utilisation : vous devez créer une proposition de contrat pour un client qui souhaite acheter l’un de vos forfaits annuels de services d’audit SEO. Découvrez ci-dessous comment créer un devis via l’API et configurer ses différentes propriétés, associations, états, etc.

Présentation

Le processus de création de devis peut être divisé en plusieurs étapes :

Créer un devis : permet de créer un devis avec quelques détails, tels que le nom et la date d’expiration. Vous pouvez également configurer le devis pour activer les signatures électroniques et les paiements .
Configurer des associations : permet d’associer le devis à d’autres types d’objets CRM, tels que des lignes de produits, un modèle de devis, une transaction, etc. Au cours de l’étape suivante, le devis héritera des valeurs de propriété de certaines de ces fiches d’informations associées ainsi que des paramètres du compte.
Définir l’état du devis : permet de définir l’état du devis pour refléter sa prédisposition à être partagé avec les acheteurs. Lorsque vous définissez l’état du devis, par exemple en le transformant en brouillon modifiable ou en devis publié accessible au public, il héritera de certaines propriétés de ses fiches d’informations CRM et paramètres de compte associés.
Partager le devis : une fois un devis publié, vous pouvez le partager avec vos acheteurs.

Créer un devis

Pour créer un devis, vous devez d’abord configurer ses détails de base en effectuant une requête POST à /crm/v3/objects/quotes. Vous devez ensuite effectuer un appel distinct pour associer le devis à d’autres objets, tels que le modèle de devis, les lignes de produit ou une transaction.

En fonction de votre workflow préféré, vous pouvez créer un devis avec des associations via une seule requête POST.

Dans le corps de l’article, ajoutez les propriétés requises suivantes pour configurer ses détails de base.

{
  "properties": {
    "hs_title": "CustomerName - annual SEO audit",
    "hs_expiration_date": "2023-12-10"
  }
}

Paramètre	Type	Description
`hs_title`	Chaîne	Le nom du devis.
`hs_expiration_date`	Chaîne	La date d’expiration du devis.

Les propriétés ci-dessus ne sont que les propriétés minimum requises pour qu’un devis soit lancé, mais d’autres propriétés sont requises pour publier un devis. Pour afficher toutes les propriétés de devis disponibles, faites une requête GET à crm/v3/properties/quotes. Découvrez-en davantage sur l’API des propriétés. La réponse comprendra un id, que vous utiliserez pour continuer à configurer le devis. Vous pouvez mettre à jour les propriétés du devis à tout moment en effectuant une requête PATCH à /crm/v3/objects/quotes/{quoteId}.

Propriétaire du devis

La définition manuelle de la propriété hubspot_owner_id n’est pas possible car il s’agit d’une propriété calculée et toutes les valeurs seront remplacées. Lors de l’utilisation des devis, la propriété fonctionne comme suit :

Si une transaction est associée au devis, la propriété hubspot_owner_id reflétera la propriété hs_associated_deal_owner_id (hs_associated_deal_owner_id est une propriété calculée).
Si une transaction n’est pas associée au devis, la propriété hubspot_owner_id reflétera la propriété hs_quote_owner_id.

Activer les signatures électroniques

Pour activer les signatures électroniques sur le devis, incluez la propriété booléenne hs_esign_enabled dans votre corps de requête avec la valeur true. Notez que vous ne pourrez pas ajouter de contresignataires via l’API. Ceux-ci devront donc être ajoutés dans HubSpot avant de publier le devis. Vous ne pouvez pas non plus publier de devis avec la signature électronique activée si vous avez dépassé votre limite mensuelle de signatures électroniques.

{
  "properties": {
    "hs_title": "CustomerName - annual SEO audit",
    "hs_expiration_date": "2023-12-10",
    "hs_esign_enabled": "true"
  }
}

Vous devrez associer le devis aux signataires du devis ultérieurement. Bien que les contacts signant le devis existent en tant que contacts dans HubSpot, ils sont stockés en tant que types d’association distincts des contacts. Découvrez-en davantage sur l’association de devis avec des signataires de devis.

Activer les paiements

Pour activer les paiements sur un devis, incluez la propriété booléenne hs_payment_enabled dans votre corps de la requête avec la valeur true. En fonction de votre prestataire de services de paiement et des modes de paiement acceptés, vous devrez également définir hs_payment_type et hs_allowed_payment_methods.

Remarque :

Le compte HubSpot doit avoir configuré les paiements HubSpot ou le traitement des paiements Stripe avant d’utiliser cette fonctionnalité.

Paramètre	Type	Description
`hs_payment_enabled`	Booléen	: lorsque la valeur est défini sur `true`, l’option permet au devis de collecter le paiement en utilisant les paiements ou le traitement des paiements Stripe. La valeur par défaut est `false`.
`hs_payment_type`	Énumération	: permet de déterminer le prestataire de services de paiement à utiliser. La valeur peut être soit `HUBSPOT` ou `BYO_STRIPE`.
`hs_allowed_payment_methods`	Énumération	: les modes de paiement à utiliser (par exemple, carte de crédit).
`hs_collect_billing_address`	Booléen	: lorsque la valeur est définie sur `true`, permet à l’acheteur de saisir son adresse de facturation lors du paiement.
`hs_collect_shipping_address`	Booléen	: lorsque la valeur est définie sur `true`, permet à l’acheteur de saisir son adresse de livraison lors du paiement.

Par exemple, pour créer un devis et activer les paiements par carte de crédit/débit ou ACH, votre requête ressemblera à ceci :

{
  "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"
  }
}

Pour suivre le paiement, HubSpot mettra automatiquement à jour les propriétés hs_payment_status et hs_payment_date :

Lorsque vous publiez un devis avec les paiements activés, HubSpot définit automatiquement la propriété hs_payment_status sur PENDING.
Si vous utilisez ACH, lorsque le paiement est traité, HubSpot définira automatiquement la propriété hs_payment_status sur PROCESSING.
Une fois le paiement confirmé, HubSpot définira automatiquement la propriété hs_payment_status sur PAID.
Une fois le devis payé, HubSpot définira automatiquement hs_payment_date à la date et à l’heure de confirmation du paiement.
Une fois le paiement confirmé, le paiement est automatiquement associé au devis. Si vous souhaitez obtenir plus d’informations sur le paiement, reportez-vous à l’API outils de paiement.

Ajout d’associations

Pour créer un devis complet, vous devez l’associer à d’autres fiches d’informations CRM, telles que des lignes de produit, à l’aide de l’API des associations. Le tableau ci-dessous indique quelles associations de fiches d’informations CRM sont requises pour un devis complet et lesquelles sont facultatives. Poursuivez votre lecture pour en savoir plus sur la récupération des identifiants et leur utilisation pour créer les associations requises.

Type d’objet	Obligatoire	Description
Lignes de produit	Oui	: les biens et/ou services vendus via le devis. Vous pouvez créer des lignes de produits à partir de produits de votre bibliothèque de produits ou créer des lignes de produits autonomes personnalisées.
Modèle de devis	Oui	: le modèle qui crée le devis et fournit certains de ses paramètres de configuration, tels que la langue. Chaque devis peut être associé à un modèle.
Transaction	Oui	: la fiche d’informations de transaction pour le suivi des revenus et du cycle de vie des ventes. Un devis hérite des valeurs de la transaction associée, y compris le propriétaire et la devise. Chaque devis peut être associé à une transaction.
Contact	Non	: les acheteurs spécifiques auxquels vous vous adressez dans le devis.
Entreprise	Non	: une entreprise spécifique à laquelle vous vous adressez dans le devis. Chaque devis peut être associé à une entreprise.
Remises, frais et taxes	Non	: l’ensemble des remises, frais et taxes à appliquer au moment du paiement. Pour déterminer le montant total du devis, HubSpot applique d’abord des remises, puis des frais, puis des taxes. Vous pouvez utiliser le champ `hs_sort_order` pour réorganiser des objets du même type. Peut être défini sur des valeurs fixes ou des pourcentages en définissant `hs_type` sur `FIXED` ou `PERCENT`.

Récupération des identifiants pour les associations

Pour effectuer chaque association, vous devez d’abord récupérer l’identifiant de chaque objet que vous souhaitez associer. Pour récupérer chaque identifiant, vous devez effectuer une requête GET au point de terminaison de l’objet concerné, qui suivra le même schéma pour chaque objet CRM. Dans chaque requête, vous pouvez également inclure un paramètre de requête properties pour renvoyer des propriétés spécifiques, si nécessaire. Vous trouverez ci-dessous des exemples de requêtes GET pour chaque type d’objet.

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

#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'

Chaque appel réussi renverra une réponse de 200 avec des détails pour chaque type d’objet récupéré. Vous utiliserez cette valeur dans le champ id pour définir des associations à l’étape suivante.

{
  "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
    }
  ]
}

Création d’associations

Une fois vos identifiants récupérés, vous pouvez appeler l’API des associations pour créer des associations. Pour chaque type d’objet que vous souhaitez associer à un devis, vous devrez procéder à un appel distinct en effectuant une requête PUT à l’aide de la structure d’URL ci-dessous : /crm/v4/objects/quotes/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}

Paramètre	Description
`fromObjectId`	L’ID du devis.
`toObjectType`	Le type d’objet associé. Par exemple : `line_items`, `deals` et `quote_template`.
`toObjectId`	L’ID de l’objet auquel vous associez le devis.

Vous trouverez ci-dessous des exemples de requêtes PUT pour chaque type d’objet.

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}

#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'

Par exemple, si votre devis a un ID de 123456, les requêtes d’association du devis peuvent inclure les éléments suivants :

Lignes de produit (ID : 55555, 66666) :
- /crm/v4/objects/quotes/123456/associations/default/line_items/55555
- /crm/v4/objects/quotes/123456/associations/default/line_items/66666
Modèle de devis (ID : 987654) : /crm/v4/objects/quotes/123456/associations/default/quote_template/987654
Transaction (ID : 345345) : /crm/v4/objects/quotes/123456/associations/default/deals/345345

Chaque association réussie renverra une réponse de 200 ainsi que des détails sur l’association. Les appels ci-dessus associeront les objets dans les deux directions, chaque direction ayant son propre ID. Par exemple, si vous associez le devis à un modèle de devis, la réponse décrira l’association des deux côtés. Dans l’exemple de réponse ci-dessous, 286 est l’ID du type d’association de devis à modèle de devis, et 285 est l’ID du type d’association de modèle de devis à devis.

{
  "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"
}

Lorsque vous associez un devis à un modèle de devis, tenez compte des limites suivantes :

Les modèles de devis doivent être créés avant de pouvoir être associés à un devis.
Un devis ne peut être associé qu’à un seul modèle de devis.
Cette API ne prend pas en charge les devis hérités ou d’offre. Seul le type de modèle CUSTOMIZABLE_QUOTE_TEMPLATE peut être utilisé.

Association des signataires de devis

Si vous activez le devis pour les signatures électroniques, vous devrez également créer une association entre le devis et les contacts qui signent en utilisant un libellé d’association spécifique de devis à contact. Plutôt que d’utiliser les points de terminaison d’association par défaut indiqués ci-dessus, vous devrez effectuer une requête PUT à l’URL suivante : /crm/v4/objects/quote/{quoteId}/associations/contact/{contactId} Dans le corps de la requête, vous devrez spécifier associationCategory et associationTypeId, comme indiqué ci-dessous :

[
  {
    "associationCategory": "HUBSPOT_DEFINED",
    "associationTypeId": 702
  }
]

Créer un devis avec les associations (requête unique)

Le corps de requête suivant créera un nouveau devis avec des associations à un modèle de devis, à une transaction, à deux lignes de produits et à un contact.

Pour que le corps de la requête ci-dessous crée correctement un devis dans votre compte, vous devrez mettre à jour les ID d’objets dans le champ associations afin qu’ils correspondent aux données existantes dans votre CRM. Consultez la section Récupération des identifiants pour les associations pour plus d’informations.

POST /crm/v3/objects/quote

{
  "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
        }
      ]
    }
  ]
}

Paramètre	Type	Description
`properties`	Objet	Valeurs des propriétés pour définir les détails du devis. Les propriétés requises sont `hs_title` et `hs_expiration_date` : `hs_title` : le nom du devis. `hs_expiration_date` : la date d’expiration du devis. `hs_status` : l’état du devis. S’il n’est pas fourni lors de la création, les utilisateurs ne pourront pas modifier le devis dans HubSpot.
`associations`	Tableau	Les autres fiches d’informations du CRM et les autres objets associés au devis. Pour qu’un devis puisse être publié, une transaction et un modèle de devis doivent lui être associés. Les lignes de produits associées à un devis doivent être distinctes des lignes de produits associées à la transaction du devis (vous devez créer des copies des lignes de produits). Pour définir chaque association, incluez un objet distinct dans ce tableau avec les champs suivants : `to` : l’ID de l’fiche d’informations ou de l’objet à associer au devis. `associationCategory` : la catégorie libellé du type d’association, soit `"HUBSPOT_DEFINED"` (libellé par défaut), soit `"USER_DEFINED"` (libellé personnalisé). `associationTypeId` : l’ID du type d’association créé. Par exemple : `286` : modèle de devis à devis `64` : devis à transaction `67` : devis à ligne de produit

Remarque :

Ces lignes de produit doivent être différentes des lignes de produit d’autres objets, même si elles sont associées (par exemple, associer un devis à une transaction). Voir la documentation de l’API des lignes de produit pour plus d’informations.

Mettre à jour l’état du devis

L’état d’un devis décrit sa progression dans le processus de création, de sa configuration initiale à sa publication et son accès public. L’état du devis peut également refléter son processus d’approbation, si les approbations de devis sont activées pour le compte. Lorsque vous définissez l’état d’un devis, HubSpot renseigne automatiquement certaines propriétés. Vous pouvez mettre à jour l’état d’un devis en effectuant une requête PATCH à /crm/v3/objects/quote/{quoteId}. L’état d’un devis est basé sur le champ hs_status. Certains états de devis permettent aux utilisateurs de modifier, de publier et d’utiliser le devis dans les workflows d’approbation des devis. Vous trouverez ci-dessous les états de devis disponibles.

Aucun état : si aucune valeur n’est fournie pour le champ hs_status, le devis aura le statut Minimal. Le devis apparaîtra sur la page index de l’outil Devis, mais ne pourra pas être modifié directement. Les devis à cet état peuvent toujours être utilisés dans l’automatisation, tels que l’outil Séquences, et sont également disponibles pour l’analyse dans l’outil Rapports.
DRAFT : permet de modifier le devis dans HubSpot. Cet état peut être utile lorsque le devis n’est pas entièrement configuré ou si vous préférez autoriser les commerciaux à terminer le processus de configuration du devis dans HubSpot.
APPROVAL_NOT_NEEDED : publie le devis à une URL publiquement accessible (hs_quote_link) sans nécessiter d’être approuvé.
PENDING_APPROVAL : indique que le devis est en attente d’approbation avant de pouvoir être publié.
APPROVED : le devis a été approuvé et est maintenant publié à une URL publiquement accessible (hs_quote_link).
REJECTED : indique que le devis a été configuré, mais qu’il n’a pas été approuvé pour publication et qu’il doit être modifié avant de pouvoir être soumis à nouveau pour approbation.

Remarque :

Si vous activez les signatures électroniques sur le devis, vous ne pourrez pas publier le devis si vous avez dépassé votre limite mensuelle de signatures électroniques.

Par exemple, la requête suivante permet de publier le devis à une URL publiquement accessible.

{
  "properties": {
    "hs_status": "APPROVAL_NOT_NEEDED"
  }
}

Remarque :

Par défaut, HubSpot définira la propriété hs_template_type du devis sur CUSTOMIZABLE_QUOTE_TEMPLATE après avoir mis à jour l’état du devis. Ce type de modèle est pris en charge par l’API v3, tandis que les types de modèles suivants sont des modèles hérités qui ne sont plus pris en charge :

QUOTE
PROPOSAL

Propriétés définies par l’état du devis

La mise à jour de l’état du devis mettra à jour les propriétés suivantes :

hs_quote_amount : calculé sur la base des lignes de produits, taxes, remises et frais associés.
hs_domain : défini à partir du modèle de devis associé.
hs_slug : généré aléatoirement si pas fourni explicitement.
hs_quote_total_preference : défini en fonction des paramètres de votre compte. Si vous n’avez pas configuré ce paramètre, la valeur du champ total_first_payment s’affiche par défaut.
hs_timezone : par défaut, le fuseau horaire de votre compte HubSpot.
hs_locale : défini à partir du modèle de devis associé.
hs_quote_number : défini en fonction de la date et de l’heure actuelles, à moins qu’une date ne soit fournie.
hs_language : défini à partir du modèle de devis associé.
hs_currency : défini en fonction de la transaction associée. Si vous n’avez pas associé une transaction à la proposition, celle-ci sera réglée par défaut sur la devise par défaut de votre compte HubSpot.

En outre, les propriétés ci-dessous seront calculées lorsque le devis passera à l’état Publié :

hs_pdf_download_link : rempli avec une URL d’un PDF pour le devis.
hs_locked : permet de définir sur la valeur true. Pour modifier des propriétés après avoir publié un devis, vous devez tout d’abord mettre à jour le hs_status du devis pour le ramener sur DRAFT, PENDING_APPROVAL ou REJECTED.
hs_quote_link : l’URL du devis accessible au public. Il s’agit d’une propriété en lecture seule qui ne peut pas être définie via l’API après publication.
hs_esign_num_signers_required : si vous avez activé les signatures électroniques, affiche le nombre de signatures requises.
hs_payment_status : statut de la collecte des paiements, si vous avez activé les paiements. Lors de la publication avec les paiements activés, cette propriété sera définie sur EN ATTENTE. Une fois que l’acheteur a effectué le paiement via le devis, le statut sera automatiquement mis à jour en conséquence. En savoir plus sur l’activation des paiements.

Récupérer des devis

Vous pouvez récupérer des devis individuellement ou par lots.

Pour récupérer un devis individuel, effectuez une requête GET à /crm/v3/objects/quotes/{quoteID}.
Pour demander une liste de tous les devis, effectuez une requête GET à /crm/v3/objects/quotes.

Pour ces points de terminaison, vous pouvez inclure les paramètres suivants dans l’URL de la requête :

Paramètre	Description
`properties`	Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si le contact du devis demandé n’a pas de valeur pour une propriété, il n’apparaîtra pas dans la réponse.
`propertiesWithHistory`	Une liste séparée par des virgules des propriétés actuelles et historiques à renvoyer dans la réponse. Si le devis demandé n’a pas de valeur pour une propriété, il n’apparaîtra pas dans la réponse.
`associations`	Une liste séparée par des virgules des objets pour lesquels récupérer les ID associés. Les associations spécifiées qui n’existent pas ne seront pas renvoyées dans la réponse. Découvrez-en davantage sur l’API des associations.

Pour récupérer un lot de devis spécifiques via leurs ID, effectuez une requête POST à crm/v3/objects/quotes/batch/read et incluez les ID dans le corps de la requête. Vous pouvez également inclure un tableau de properties pour indiquer les propriétés à renvoyer. Le point de terminaison du lot ne peut pas récupérer les associations. Découvrez comment lire par lots les associations avec l’API des associations.

{
  "inputs": [
    {
      "id": "342007287"
    },
    {
      "id": "81204505203"
    }
  ],
  "properties": ["hs_content", "hs_sentiment", "hs_submission_timestamp"]
}

Périmètres d’accès

Les périmètres suivants sont requis pour une application afin de créer un devis publiable valide :

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

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Data Studio

Événements

Fichiers

Marketing

Rendez-vous

Chiffre d'affaires

Webhooks

Journal des webhooks

API du CRM | Devis

Présentation

Créer un devis

Propriétaire du devis

Activer les signatures électroniques

Activer les paiements

Remarque :

Ajout d’associations

Récupération des identifiants pour les associations

Création d’associations

Lorsque vous associez un devis à un modèle de devis, tenez compte des limites suivantes :

Association des signataires de devis

Créer un devis avec les associations (requête unique)

Remarque :

Mettre à jour l’état du devis

Remarque :

Remarque :

Propriétés définies par l’état du devis

Récupérer des devis

Périmètres d’accès

​Présentation

​Créer un devis

​Propriétaire du devis

​Activer les signatures électroniques

​Activer les paiements

​Remarque :

​Ajout d’associations

​Récupération des identifiants pour les associations

​Création d’associations

​Lorsque vous associez un devis à un modèle de devis, tenez compte des limites suivantes :

​Association des signataires de devis

​Créer un devis avec les associations (requête unique)

​Remarque :

​Mettre à jour l’état du devis

​Remarque :

​Remarque :

​Propriétés définies par l’état du devis

​Récupérer des devis

​Périmètres d’accès

Présentation

Créer un devis

Propriétaire du devis

Activer les signatures électroniques

Activer les paiements

Remarque :

Ajout d’associations

Récupération des identifiants pour les associations

Création d’associations

Lorsque vous associez un devis à un modèle de devis, tenez compte des limites suivantes :

Association des signataires de devis

Créer un devis avec les associations (requête unique)

Remarque :

Mettre à jour l’état du devis

Remarque :

Remarque :

Propriétés définies par l’état du devis

Récupérer des devis

Périmètres d’accès