v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Ver detalhes da proposta

get/proposals/{proposal_id}

Path parameters

proposal_idinteger required

ID da proposta.

Query parameters

withstring

Obter recursos com relações.

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": {
    "total": 1,
    "count": 1,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1
  }
}