v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar propostas

Endpoint de lista de dados

get/proposals

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

idinteger

Filtrar pelo ID da proposta.

user_idinteger

Filtrar pelo ID do usuário que gerou a proposta.

deal_idinteger

Filtrar pelo ID da oportunidade de origem da proposta.

proposal_model_idinteger

Filtrar pelo ID do modelo da proposta.

payment_method_idinteger

Filtrar pelo ID da forma de pagamento de produto e serviço (P&S).

payment_method_mrr_idinteger

Filtrar pelo ID da forma de pagamento de receita recorrente (MRR).

proposal_counter_idinteger

Filtrar pelo ID do contador de proposta.

value_mrrnumber float

Filtrar pelo valor de receita recorrente (MRR) da proposta.

statusinteger

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

introductionstring

Filtrar pelo conteúdo da introdução da proposta.

delivery_forecast_dateinteger

Filtrar pelo intervalo entre as parcelas de pagamento.

payment_methodstring

Filtrar pela forma de pagamento.

observationstring

Filtrar pelas observações da proposta.

versionstring

Filtrar pela versão da proposta.

shipping_typestring

Filtrar pelo tipo de entrega.

shipping_valuestring

Filtrar pelo valor da entrega.

due_dateinteger

Filtrar pelo dia de vencimento do pagamento de produto e serviço (P&S) da proposta.

due_date_mrrinteger

Filtrar pelo dia de vencimento do pagamento de receita recorrente (MRR) da proposta.

hashstring

Filtrar pela hash da proposta.

created_at_startstring date

Filtrar por propostas criadas a partir da data informada.

created_at_endstring date

Filtrar por propostas criadas até a data informada.

updated_at_startstring date

Filtrar por propostas atualizadas a partir da data informada.

updated_at_endstring date

Filtrar por propostas atualizadas até a data informada.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "user_id": 1,
      "deal_id": 1,
      "proposal_model_id": 1,
      "payment_method_id": 1,
      "payment_method_mrr_id": 1,
      "proposal_counter_id": 1,
      "currency_id": 1,
      "name": "PPRN26186",
      "value": 100,
      "introduction": "Proposta para Oportunidade 1",
      "deal_date": "2019-10-03 10:10:33",
      "expiration_date": "2019-10-03",
      "payment_method": 1,
      "observation": 1,
      "visualized_in": 1,
      "version": 7,
      "first_payment_date": 1,
      "first_payment_mrr_date": "2019-10-03",
      "number": 123,
      "hash": "c4rzzbzn4so4co08s4ok40o00k0s0gs",
      "url": "https://example.org/proposal.pdf",
      "created_at": "2019-10-03",
      "due_date_mrr": 1,
      "shipping_company_id": 1,
      "billing_company_id": 1,
      "triangular_company_id": 1,
      "purchase_order": 1,
      "parcels": 2,
      "down_payment_percent": 1,
      "interval": 1,
      "commission_type": 1,
      "commission_value": 5.5,
      "commission_type_mrr": 1,
      "commission_value_mrr": 5.5,
      "brand_id": 1,
      "currency": {
        "id": 1,
        "name": "Real Brasileiro",
        "origin_country": "Brasil",
        "symbol": "R$"
      },
      "items": {
        "id": 1,
        "origin_country": "Brasil",
        "quantity": 1,
        "value": 122,
        "item": {
          "id": 1,
          "account_id": 1,
          "category_id": 1,
          "custom_field_id": 1,
          "type": 1,
          "deleted": 1,
          "name": "item2"
        }
      }
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6Mi....0ZW1zIjp0cnVlfQ"
    }
  }
}