Adicionar proposta

post

https://api.pipe.run/v1/proposals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para adicionar uma proposta à uma oportunidade na conta do CRM PipeRun.

Lista de meios de pagamento

Esta tabela é importante para consultar e utilizar o Código (ID) e o Nome para informar as parcelas da proposta.

ID	Nome
1	Boleto
2	Cartão de Crédito
3	Transferência Bancária
4	Dinheiro (Espécie)
5	Cartão de Débito
6	Cheque
7	Bitcoin $
8	Invoice Internacional
9	A combinar
10	Débito em Conta
11	PIX

Body Params

deal_id

int32

required

ID da oportunidade

user_id

int32

ID do usuário responsável pela proposta

template

int32

ID do template de proposta

name

string

Nome da proposta

proposal_counter_id

int32

ID do contador de proposta (para siglas sequenciais)

proposal_model_id

int32

ID do modelo de proposta

payment_method_id

int32

ID do método de pagamento dos itens de produtos e serviços (P&S) da proposta

payment_method_mrr_id

int32

ID do método de pagamento dos itens de recorrência (MRR) da proposta

currency_id

int32

Moeda de pagamento (1= real brasileiro) / 2= dólar americano / 3= euro)

brand_id

int32

ID da marca utilizada na proposta

shipping_company_id

int32

ID da empresa de transporte responsável pela entrega

billing_company_id

int32

ID da empresa de faturamento

triangular_company_id

int32

ID da empresa de entrega triangular

purchase_order

string

Identificador do pedido de compra

commission_type

int32

Tipo de comissão para pagamento de itens de produtos e serviços (P&S) (0= valor percentual / 1= valor absoluto)

commission_value

float

Valor da comissão para itens de produtos e serviços (P&S)

comission_type_mrr

int32

Tipo de comissão para pagamento de itens de receitas recorrentes (MRR) (0= valor percentual / 1= valor absoluto)

comission_value_mrr

float

Valor da comissão para itens de recorrência (MRR)

status

int32

Status da proposta (0= aberto / 1= aprovado / 2= negado / 3= cancelado / 4= aguardando assinatura / 5= assinado)

introduction

string

Introdução da proposta

observation

string

Observações da proposta

expiration_date

date

Data de validade da proposta.

first_payment_date

date

Data do pagamento da entrada dos itens de produtos e serviços (P&S)

first_payment_mrr_date

date

Data do pagamento da entrada dos itens de recorrência (MRR)

first_payment_interval

int32

Prazo (em dias) para a primeira parcela

parcels

int32

Quantidade de parcelas de pagamento de itens de produtos e serviços (P&S)

parcels_mrr

int32

Quantidade de parcelas de pagamento de itens de recorrência (MRR)

down_payment_percent

float

Valor percentual que será pago na entrada

interval

int32

Intervalo (em dias) entre as parcelas

payment_comment

string

Comentários sobre o pagamento de itens de produtos e serviços (P&S)

payment_comment_mrr

string

Comentários sobre o pagamento de itens de recorrência (MRR)

proposal_layout_id

int32

ID do layout de proposta

shipping_type

int32

Tipo do frete (0= sem frete / 1= FOB / 2= CIF)

shipping_value

float

Valor do frete

discount_type

int32

Tipo de desconto da proposta (0= valor percentual / 1= valor absoluto)

discount_value

float

Valor do percentual de desconto da proposta

delivery_forecast_date

int32

Dia do mês de previsão de entrega

items

array of objects

Array contendo os dados dos itens vinculados à proposta

items

proposalParcels

array of objects

Divisão de parcelas da proposta

proposalParcels

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Lista de meios de pagamento

201201

400400

422422