Negociações

A Negociação é uma das três Entidades do RD Station CRM:

  • Negociação
  • Contato
  • Empresa

Ela representa a possibilidade de negociar uma venda e contém todas as fases do processo de negociação.

Toda Negociação cadastrada percorre o funil de vendas e, a cada atualização, as informações referentes ao avanço da negociação podem ser registradas em campos específicos.

Assim, todo o histórico de negociações, sejam elas ganhas (venda realizada) ou perdidas, fica armazenado no cadastro da Empresa à qual pertencem, independente do vendedor responsável e do tipo de produto ou serviço negociado.

❗️

Atenção

Toda informação cadastrada deve conter no mínimo 2 caracteres.

Query params

Parâmetros utilizados para listar e exibir Negociações.

NomeTipoDescrição
tokenStringToken do usuário
deal_idStringID da negociação a ser exibida
pageStringNúmero da página listada. Valor padrão é 1
limitStringLimite de negociações que virão por listagem. Valor padrão é 20. Valor máximo é 200
orderStringOrdenação. Valor padrão é "created_at".
directionStringOrdenação da lista. "asc" ou "desc", padrão é "desc"
nameStringNome da negociação
exact_nameStringPara buscas com nome exato, usar o parâmetro exact_name= true
winStringNegociações ganhas. Com o valor true para trazer as negociações ganhas, false para trazer as negociações perdidas e null para retornar as negociações em aberto.
user_idStringID do usuário relacionado à negociação.
start_dateStringPrimeiro dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "start_date": "2020-12-14T15:00:00".
end_dateStringÚltimo dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "end_date": "2020-12-14T15:00:00"
closed_atBooleanAo informar true, retorna as negociações GANHAS/PERDIDAS. Ao informar false, retorna as negociações EM ABERTO OU PAUSADAS.
closed_at_periodBooleanData de fechamento da deal: se true deve ser informado start_date e end_date.
created_at_periodBooleanData de criação da deal: se true, deve ser informado start_date e end_date
prediction_date_periodBooleanData de previsão de fechamento da negociação: se true, deve ser informado start_date e end_date
closed_by_idStringID do usuário que fechou a venda
deal_stage_idStringID da etapa
deal_lost_reason_idStringID do motivo de perda
organizationStringID da empresa
holdStringEstado da negociação pausada. Se marcado como true, retorna todas negociações pausadas. Para outros casos, não deve-se utilizar esse parâmetro.
product_presenceStringNegociações que contenham produtos/serviços relacionados: false (nenhum produto relacionado), true (um ou mais produtos relacionados) ou uma lista de IDs de produto. A lista de IDs deve ser informada com os valores separados por vírgula. Ex.: 5esdsds, d767dsdssd, c6e40fd2f000972a083.
deal_pipeline_idStringID do Funil

Body params

Parâmetros utilizados para criar e atualizar Negociações.

NomeTipoDescriçãoObrigatórioObservação
nameStringNome da negociação a ser exibidaObrigatório somente ao criar uma negociação.
deal_stage_idStringID da etapa do funil
deal_custom_fieldsObjectCampos customizados da negociação
deal_sourceObjectFonte da negociação
contactsArray of objectsContatos associados a negociação
deal_productsArray of objectsProdutos vinculados a negociação
campaignObjectCampanha da negociação
organizationObjectEmpresa à qual a negociação pertence
user_idObjectUsuário responsável pela negociaçãoSe esse parâmetro não for enviado na requisição, o dono do Token (utilizado para autorizar a requisição) será atribuído como Responsável pela negociação.
holdBooleanStatus da negociaçãoValores aceitos: paused (pausada), null (em aberto)
ratingIntegerAvaliação da negociação
winBooleanStatus da negociaçãoValores aceitos: true (negociação ganha), false (negociação perdida), null (negociação em aberto)
prediction_dateDateData da previsão de fechamento da negociaçãoFormato (yyyy-mm-dd)
deal_lost_reason_idStringID do motivo da perda
contacts.legal_baseArrayBase legal