Referências das Apis

Retorna as reservas de acordo com os filtros

get
https://{dominiodocliente}.cvcrm.com.br/api/v1/comercial/reservas

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

CPF/CNPJ do cliente

string

Informar o id da situação que deseja filtrar ou informar 'todas' para trazer todas as situações.

boolean

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.

boolean

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.

boolean

Sobrescreve a API para retornar as reservas que possuem código interno (já integradas).

integer

Filtra reserva pelo id do empreendimento.

boolean

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.

boolean

Retorna a condição da reserva separando a série por valor líquido.

boolean

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.

integer

Página que deseja visualizar os registros.

integer

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

integer

Identificador do grupo de situações do workflow.

string
length ≤ 10000

Retorna as reserva cadastradas a partir da data informada.

boolean

Retorna também os valores de campos adicionais do tipo Reservas/Contratos.

Headers
string
required

E-mail de autenticação no Construtor de Vendas.

string
required

Token de autenticação no Construtor de Vendas.

Responses

Updated 14 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 14 days ago