v1
latestOpenAPI 3.0.02026-07-264636241.7 MBRetorna as reservas de acordo com os filtros
🔒 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)
Esta API serve como um informativo ao sistema legado acerca das reservas que podem ser integradas como vendidas, por esse motivo não há solicitação de preenchimento de dados para a sua execução. Neste caso, como a requisição é do tipo 'GET', somente são necessários passar os parâmetros de autenticação por meio do HEADER, ou seja, a requisição não terá BODY.
Obs: Ela também fará consultas no Construtor de Vendas por reservas em situação com flag 'pode faturar' ou 'vendida', tendo o controle pelos parâmetros da query especificados exclusivamente (i.e. não pode especificar os dois num mesmo request).
Obs2: Reservas que ainda não foram integradas (possuem a coluna codigointerno populada) não são listadas, este padrão pode ser configurado com o parâmetro retornar_integradas.
Query parameters
CPF/CNPJ do cliente
Informar o id da situação que deseja filtrar ou informar 'todas' para trazer todas as situações.
Filtra as reserva que podem faturar, por padrão o valor é true mesmo se não passado. Por padrão trazem as reservas que estão no Pode Faturar. Se usar o false traz todas as reservas.
Filtra as reservas que estão ativas diferentes de : Cancelada, Vendida, Vencida e Distrato. Por padrão, o valor é false, mesmo que não seja informado. Caso seja informado, o comportamento padrão do parâmetro faturar é desativado.
Sobrescreve a API para retornar as reservas que possuem código interno (já integradas).
Filtra reserva pelo id do empreendimento.
Adiciona à condição da reserva os campos: valor_liquido_com_juros, idusuario_quem_aprovou, indexador, forma_pagamento, possui_juros, possui_correcao, juros_condicao, juros_contrato, prestacao_saf, valor_seriecomissaoforadocontrato e valor_seriecomissaonocontrato.
Retorna a condição da reserva separando a série por valor líquido.
Retorna a condição da reserva separando a série por valor menos o valor da comissão e o campo Comissão paga pela condição da reserva. Adiciona à condição da reserva o campo: valor_liquido_com_juros. Retorna array da programação da comissão.
Página que deseja visualizar os registros.
Quantidade de registro por página, máximo 500 registros.
Identificador do grupo de situações do workflow.
Retorna as reserva cadastradas a partir da data informada.
Retorna também os valores de campos adicionais do tipo Reservas/Contratos.
Headers
Response
Reservas retornadas com sucesso.
Lista as reservas no CVCRM. As chaves do objeto são os IDs das reservas (número inteiro).
Example response
{
"$ref": "#/components/examples/RetornoReserva"
}