API de CRM | Cotizaciones

​

Resumen

1. Crear una cotización: crea una cotización con algunos detalles, como el nombre y la fecha de vencimiento. También puedes configurar la cotización para habilitar las firmas electrónicas y los pagos.
2. Configurar asociaciones: asocia la cotización con otros tipos de objetos del CRM, como elementos de pedido, plantillas de cotización, un negocio, entre otros. Durante el siguiente paso, la cotización heredará los valores de propiedad de algunos de estos registros asociados, así como la configuración de la cuenta.
3. Establecer el estado de la cotización: establece el estado de la cotización para que refleje que está lista para ser compartida con los compradores. Al establecer el estado de la cotización, como convertirla en un borrador editable o en una cotización publicada y accesible de forma pública, heredará ciertas propiedades de los registros de CRM asociados y de la configuración de la cuenta.
4. Compartir la cotización: una vez que se ha publicado una cotización, puedes compartirla con tus compradores.

​

Crear una cotización

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

​

Propietario de la cotización

• Si hay un negocio asociado a la cotización, la propiedad hubspot_owner_id reflejará la propiedad hs_associated_deal_owner_id (hs_associated_deal_owner_id es una propiedad calculada).
• Si no hay una cotización asociada a un negocio, la propiedad hubspot_owner_id mostrará la propiedad hs_quote_owner_id.

​

Habilitar firmas electrónicas

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

​

Habilitar los pagos

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

• Cuando publiques una cotización con los pagos habilitados, HubSpot establecerá automáticamente la propiedad hs_payment_status como PENDING.
• Si utilizas ACH, cuando se procese el pago, HubSpot establecerá automáticamente la propiedad hs_payment_status a PROCESSING.
• Cuando se confirme el pago, HubSpot establecerá automáticamente la propiedad hs_payment_status como PAID.
• Una vez que se pague la cotización, HubSpot establecerá automáticamente hs_payment_date en la fecha y hora en que se confirmó el pago.
• Una vez confirmado el pago, este se asocia automáticamente a la cotización. Si deseas obtener más información sobre los pagos, consulta la API de pagos.

​

Agregar asociaciones

​

Buscar ID para asociaciones

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

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

​

Crear asociaciones

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}

• Elementos de pedido (ID: 55555, 66666):
  • /crm/v4/objects/quotes/123456/associations/default/line_items/55555
  • /crm/v4/objects/quotes/123456/associations/default/line_items/66666
• Plantilla de cotización (ID: 987654): /crm/v4/objects/quotes/123456/associations/default/quote_template/987654
• Negocio (ID: 345345): /crm/v4/objects/quotes/123456/associations/default/deals/345345

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

​

Asociar firmantes de cotizaciones

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

​

Crear una cotización con asociaciones (solicitud única)

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

​

Actualizar el estado de la cotización

• Sin estado: si no se proporciona ningún valor para el campo hs_status, la cotización estará en el estado Mínimo. La cotización aparecerá en la página de índice de la herramienta cotizaciones, pero no se podrá editar directamente. Las cotizaciones en este estado todavía se pueden usar en la automatización, como la herramienta de secuencias y también están disponibles para analizar dentro de la herramienta de informes.
• DRAFT: permite editar la cotización en HubSpot. Este estado puede ser útil cuando la cotización no está completamente configurada o si prefieres permitir que los representantes de ventas completen el proceso de configuración de la cotización en HubSpot.
• APPROVAL_NOT_NEEDED: publica la cotización en una URL de acceso público (hs_quote_link) sin necesidad de aprobación.
• PENDING_APPROVAL: indica que la cotización está a la espera de ser aprobada antes de que pueda ser publicada.
• APPROVED: la cotización ha sido aprobada y ahora está publicada en una URL de acceso público (hs_quote_link).
• REJECTED: indica que la cotización ha sido configurada pero no ha sido aprobada para su publicación y debe editarse antes de que pueda enviarse de nuevo para su aprobación.

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

​

Propiedades establecidas por el estado de la cotización

• hs_quote_amount: se calcula en función de cualquier elemento de pedido asociado, impuesto, descuento y tarifa.
• hs_domain: se establece a partir de la plantilla de cotización asociada.
• hs_slug: se genera de forma aleatoria si no se proporciona un valor.
• hs_quote_total_preference: se establece en función de la configuración de tu cuenta. Si no has configurado este ajuste, por opción predeterminada será el valor del campo total_first_payment.
• hs_timezone: es la zona horaria predeterminada de tu cuenta de HubSpot.
• hs_locale: se establece a partir de la plantilla de cotización asociada.
• hs_quote_number: se establece en función de la fecha y hora actuales, a menos que se proporcione una.
• hs_language: se establece a partir de la plantilla de cotización asociada.
• hs_currency: se establece en función del negocio asociado. Si no has asociado un negocio con la cotización, esta cambiará por opción predeterminada a la divisa predeterminada de tu cuenta de HubSpot.

• hs_pdf_download_link: se rellena con una URL de un PDF para la cotización.
• hs_locked: se establece en true. Para modificar cualquier propiedad después de haber publicado una cotización, primero debes actualizar el hs_status de la cotización a DRAFT, PENDING_APPROVAL o REJECTED.
• hs_quote_link: la URL de acceso público de la cotización. Esta es una propiedad de solo lectura y no se puede configurar a través de la API después de la publicación.
• hs_esign_num_signers_required: si has habilitado las firmas electrónicas, muestra el número de firmas necesarias.
• hs_payment_status: el estado de cobro del pago, si habilitaste los pagos. Al publicar con los pagos habilitados, esta propiedad se establecerá en PENDING. Una vez que el comprador envíe el pago a través de la cotización, el estado se actualizará automáticamente. Más información sobre cómo habilitar los pagos.

​

Buscar cotizaciones

• Para buscar una cotización individual, haz una solicitud GET a /crm/v3/objects/quotes/{quoteID}.
• Para solicitar una lista de todas las cotizaciones, envía una solicitud GET a /crm/v3/objects/quotes.

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

​

Permisos

• 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