v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Condição de Pagamentos da Reserva

Retorna as condições de pagamento de uma reserva

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

A API tem o objetivo de apresentar a condição de pagamento da reserva com detalhamento de todas as séries, vencimentos e valores.**

get/v1/comercial/reservas/condicao-pagamentos

Query parameters

idreservainteger required
Example:1024

Identificador da reserva no Construtor de Vendas.

paginainteger
Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger
Example:30

Quantidade de registro por página, máximo 500 registros.

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Response

Reservas

paginainteger

Página atual

total_de_paginasinteger

Quantidade total de páginas

registrosinteger

Quantidade de reservas na página

total_de_registrosinteger

Quantidade total de reservas

Example response

{
  "pagina": 1,
  "total_de_paginas": 36,
  "registros": 30,
  "total_de_registros": 1054,
  "dados": [
    {
      "idreserva": 1,
      "idreserva_int": 1,
      "valor_total_contrato": 123.05,
      "valor_total_com_juros": 123.05,
      "valor_liquido": 123.05,
      "valor_liquido_com_juros": 123.05,
      "condicao": [
        {
          "idserie": 1,
          "idserie_int": "PU",
          "serie": "Ato",
          "sigla": "Ato",
          "valor_total": 123.05,
          "valor_total_com_juros": 123.05,
          "valor_liquido": 123.05,
          "quantidade_parcelas": 10,
          "tipo_juros": "SJ|TP",
          "tipo_juros_descricao": "Sem Juros|Tabela Price",
          "tipo": "V|F",
          "tipo_descricao": "Variável|Fixa",
          "correcao": "Sim|Não",
          "retirar_comissao": "Sim|Não",
          "indexador": "NGM",
          "portador": "Portador",
          "data_base_juros": "2021-01-01",
          "juros_condicao": "Não calcular juros",
          "juros_futuro": 0.01,
          "data_cadastro": "2022-12-30 13:18:37",
          "parcelas": [
            {
              "vencimento": "2021-01-01",
              "valor": 26189.28,
              "valor_liquido": 26189.28,
              "valor_com_juros": 26189.28
            }
          ]
        }
      ]
    }
  ]
}