v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Atualizar proposta

put/proposals/{proposal_id}

Path parameters

proposal_idinteger required

ID da proposta.

Request body

deal_idinteger

ID da oportunidade atrelada.

user_idinteger

ID do usuário responsável pela proposta.

namestring

Nome da proposta

proposal_counter_idinteger

ID do contador de proposta (para siglas sequenciais).

proposal_model_idinteger

ID do modelo de proposta.

payment_method_idinteger

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

payment_method_mrr_idinteger

ID do método de pagamento dos itens de receitas recorrentes (MRR).

currency_idinteger

ID da moeda de pagamento: 1: real brasileiro, 2: dólar americano, 3: euro.

brand_idinteger

ID da marca utilizada na proposta.

shipping_company_idinteger

ID da empresa de transporte responsável pela entrega.

billing_company_idinteger

ID da empresa de faturamento.

triangular_company_idinteger

ID da empresa de entrega triangular.

purchase_orderstring

Identificador do pedido de compra.

commission_typeinteger

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

commission_valuenumber float

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

comission_type_mrrinteger

Tipo de comissão para pagamento de itens de receitas recorrentes (MRR): 0: valor percentual, 1: valor absoluto.

comission_value_mrrnumber float

Valor da comissão para itens de receitas recorrentes (MRR).

statusinteger

Status da proposta: 0: aberto, 1: aprovado, 2: negado, 3: cancelado, 4: aguardando assinatura, 5: assinado.

introductionstring

Texto de introdução da proposta.

observationstring

Texto de observações da proposta.

expiration_datestring date

Data de validade da proposta.

first_payment_datestring date

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

first_payment_mrr_datestring date

Data do pagamento da entrada dos itens de receitas recorrentes (MRR).

first_payment_intervalinteger

Prazo (em dias) para a primeira parcela

due_datestring date

Dia do mês de vencimento das parcelas dos itens

parcelsinteger

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

parcels_mrrnumber float

Quantidade de parcelas de pagamento de itens de receitas recorrentes (MRR).

down_payment_percentnumber float

Valor percentual que será pago na entrada.

intervalinteger

Intervalo (em dias) entre as parcelas.

payment_commentstring

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

payment_comment_mrrstring

Comentários sobre o pagamento de itens de receitas recorrentes (MRR)

proposal_layout_idinteger

ID do layout de propostas para geração de PDF customizado.

shipping_typeinteger

Tipo do frete: 0: sem frete, 1: FOB, 2: CIF.

shipping_valuenumber float

Valor do frete.

discount_valuenumber float

Valor do percentual de desconto da forma de pagamento de itens de produtos e serviços (P&S).

delivery_forecast_dateinteger

Dia do mês de previsão de entrega.

Response

200