Os orçamentos são usados para compartilhar informações de preços com possíveis compradores. Os pontos de extremidade dos orçamentos permitem recuperar esses dados e sincronizá-los entre o HubSpot e outros sistemas.
POST
para /crm/v3/objects/quotes
. Posteriormente, você fará uma chamada separada para associar o orçamento a outros objetos, como o modelo de orçamento, itens de linha ou um negócio.
Parâmetro | Tipo | Descrição |
---|---|---|
hs_title | String | O nome do orçamento. |
hs_expiration_date | String | A data em que o orçamento expira. |
GET
para crm/v3/properties/quotes
. Saiba mais sobre a API de propriedades.
A resposta incluirá um id
, que você usará para continuar a configurar o orçamento. Você pode atualizar as propriedades do orçamento a qualquer momento, fazendo uma solicitação PATCH
para /crm/v3/objects/quotes/{quoteId}
.
hubspot_owner_id
manualmente não é possível porque é uma propriedade calculada, e quaisquer valores serão substituídos. Ao usar aspas, a propriedade funciona da seguinte maneira:
hubspot_owner_id
refletirá a propriedade hs_associated_deal_owner_id
(hs_associated_deal_owner_id
é uma propriedade calculada).hubspot_owner_id
refletirá a propriedade hs_quote_owner_id
.hs_esign_enabled
no corpo da solicitação com um valor true
. Observe que você não poderá adicionar contrassignatários por meio da API; portanto, eles precisarão ser adicionados ao HubSpot antes de publicar o orçamento. Você também não pode publicar um orçamento com a assinatura eletrônica habilitada se tiver excedido o limite mensal de assinaturas eletrônicas.
hs_payment_enabled
no corpo da solicitação com um valor true
. Dependendo do seu processador de pagamentos e dos métodos de pagamento aceitos, você também terá que definir hs_payment_type
e hs_allowed_payment_methods
.
Parâmetro | Tipo | Descrição |
---|---|---|
hs_payment_enabled | Booleano | Quando definido como true , permite que o orçamento receba pagamentos usando os pagamentos da HubSpot ou o processamento de pagamentos do Stripe. O padrão é false . |
hs_payment_type | Enumeração | Determina qual processador de pagamentos usar. O valor pode ser HUBSPOT ou BYO_STRIPE . |
hs_allowed_payment_methods | Enumeração | Os métodos de pagamento a serem usados (por exemplo, cartão de crédito). |
hs_collect_billing_address | Booleano | Quando definido como true , permite que o comprador insira o seu endereço de envio ao finalizar a compra. |
hs_collect_shipping_address | Booleano | Quando definido como true , permite que o comprador insira seu endereço de entrega ao finalizar a compra. |
hs_payment_status
e hs_payment_date
:
hs_payment_status
como PENDING
.hs_payment_status
para PROCESSING
.hs_payment_status
como PAID
.hs_payment_date
para a data e hora em que o pagamento foi confirmado.hs_sort_order
para reordenar objetos do mesmo tipo. Pode ser definido como valores fixos ou porcentagens, definindo hs_type
como FIXED
ou PERCENT
| . |
GET
para o pontos de extremidade do objeto relevante, que segue o mesmo padrão em cada objeto do CRM. Ao fazer cada solicitação, você também pode incluir um parâmetro de consulta de properties
para retornar propriedades específicas quando necessário. Veja exemplos de solicitações GET
para cada tipo de objeto.
200
com detalhes para cada tipo de objeto buscado. Você usará o valor no campo id
para definir associações na próxima etapa.
PUT
com a estrutura de URL abaixo:
/crm/v4/objects/quotes/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
Parâmetro | Descrição |
---|---|
fromObjectId | O ID do orçamento. |
toObjectType | O tipo de objeto ao qual você está fazendo a associação. Por exemplo, line_items , deals e quote_template . |
toObjectId | O ID do objeto ao qual você está associando o orçamento. |
PUT
para cada tipo de objeto.
123456
, as solicitações para associar o orçamento podem incluir o seguinte:
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
com detalhes sobre a associação. As chamadas acima irão associar os objetos em ambas as direções, com cada direção tendo o seu próprio ID. Por exemplo, se você associar o orçamento a um modelo de orçamento, a resposta descreverá a associação de ambos. Na resposta de exemplo abaixo, 286
é o ID do tipo de associação de orçamento para modelo de orçamento e 285
é o ID do tipo de associação modelo de orçamento para orçamento.
CUSTOMIZABLE_QUOTE_TEMPLATE
pode ser usado.PUT
para o seguinte URL:
/crm/v4/objects/quote/{quoteId}/associations/contact/{contactId}
No corpo da solicitação, você precisará especificar associationCategory
e associationTypeId
, conforme mostrado abaixo:
associations
para corresponder aos dados existentes em seu CRM. Reveja a seção Recuperando IDs para associações para obter orientações adicionais.POST
/crm/v3/objects/quote
Parâmetro | Tipo | Descrição |
---|---|---|
properties | Objeto | Valores de propriedade para definir os detalhes do orçamento. As propriedades necessárias são hs_title e hs_expiration_date :
|
associations | Matriz | Os outros registros e objetos de CRM associados ao orçamento. Para que um orçamento possa ser publicado, ele deve ter um negócio associado e um modelo de orçamento. Os itens associados a um orçamento devem ser diferentes dos itens associados ao negócio do orçamento (ou seja, você deve criar cópias dos itens). Para definir cada associação, inclua um objeto separado nessa matriz com os seguintes campos:
|
PATCH
para /crm/v3/objects/quote/{quoteId}
.
O estado de um orçamento é baseado no campo hs_status
. Alguns estados do orçamento permitem que os usuários editem, publiquem e usem o orçamento nos fluxos de trabalho de aprovação. Veja os estados de orçamento disponíveis.
hs_status
, o orçamento estará no estado Mínimo. O orçamento aparecerá na página de índice da ferramenta de orçamentos, mas não pode ser editada diretamente. Os orçamentos nesse estado ainda podem ser usados na automação, como a ferramenta de sequências, e também estão disponíveis para análise dentro da ferramenta de relatório.DRAFT
: permite que o orçamento seja editado no HubSpot. Esse estado pode ser útil quando o orçamento não estiver totalmente configurado ou se você preferir que os representantes de vendas concluam o processo de configuração do orçamento no HubSpot.APPROVAL_NOT_NEEDED
: publica o orçamento em um URL de acesso público (hs_quote_link
) sem precisar ser aprovado.PENDING_APPROVAL
: indica que o orçamento está aguardando aprovação para que possa ser publicado.APPROVED
: o orçamento foi aprovado e agora está publicado em um URL de acesso público (hs_quote_link
).REJECTED
: indica que o orçamento foi configurado, mas não foi aprovado para publicação e deve ser editado antes que possa ser enviado para aprovação novamente.hs_template_type
do orçamento como CUSTOMIZABLE_QUOTE_TEMPLATE
depois de atualizar o estado do orçamento. Este tipo de modelo é suportado pela API v3, enquanto que os seguintes tipos são modelos antigos que não são mais suportados:QUOTE
PROPOSAL
hs_quote_amount
: calculado com base em quaisquer itens de linha, impostos, descontos e taxas associados.hs_domain
: definido a partir do modelo de orçamento associado.hs_slug
: gerado aleatoriamente se um não for fornecido explicitamente.hs_quote_total_preference
: definido com base nas configurações da sua conta. Se você não tiver configurado essa configuração, ela será padronizada para o valor do campo total_first_payment.hs_timezone
: o padrão é o fuso horário da sua conta da HubSpot.hs_locale
: definido a partir do modelo de orçamento associado.hs_quote_number
: define com base na data e hora atuais, a menos que uma seja fornecida.hs_language
: definido a partir do modelo de orçamento associado.hs_currency
: definido com base no negócio associado. Se você não associou um negócio ao orçamento, ele será padronizado para a moeda padrão da sua conta da HubSpot.hs_pdf_download_link
: preenchido com uma URL de um PDF para o orçamento.hs_locked
: definido como true
. Para modificar qualquer propriedade depois de publicar um orçamento, você deve primeiro atualizar o hs_status
do orçamento de volta para DRAFT
, PENDING_APPROVAL
ou REJECTED
.hs_quote_link
: o URL de acesso público do orçamento. Esta é uma propriedade somente leitura e não pode ser definida por meio da API após a publicação.hs_esign_num_signers_required
: exibe o número de assinaturas necessárias se as assinaturas eletrônicas estiverem habilitadas.hs_payment_status
: o status do pagamento, caso tenha habilitado os pagamentos. Após a publicação com os pagamentos ativados, esta propriedade será definida como PENDENTE. Assim que o comprador fizer o pagamento por meio do orçamento, o status será atualizado automaticamente. Saiba mais sobre como habilitar os pagamentos.GET
para /crm/v3/objects/quotes/{quoteID}
.GET
para /crm/v3/objects/quotes
.Parâmetro | Descrição |
---|---|
properties | Uma lista separada por vírgulas das propriedades a serem retornadas em resposta. Se o quotecontact solicitado não tiver um valor para uma propriedade, ele não será exibido na resposta. |
propertiesWithHistory | Uma lista separada por vírgulas das propriedades atuais e do histórico a serem retornadas em resposta. Se o orçamento solicitado não tiver um valor para uma propriedade, ele não será exibido na resposta. |
associations | Uma lista separada por vírgulas de objetos para recuperar IDs associados. Todas as associações especificadas que não existem não serão retornadas na resposta. Saiba mais sobre a API de associações. |
POST
para crm/v3/objects/quotes/batch/read
e inclua os IDs no corpo da solicitação. Você também pode incluir uma matriz de properties
para especificar quais propriedades retornar. O ponto de extremidade em lote não pode recuperar associações. Saiba como fazer associações de leitura em lote com a API de associações.
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