v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Parcelas da reserva

Retorna todas as parcelas de pagamento da 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 interface viabiliza a consulta das parcelas de pagamento das reservas retornando os dados, seu pagador e seu beneficiário.

get/v1/financeiro/parcelas-reservas

Query parameters

limiteinteger
Example:30

Limite de itens exibido por página

paginainteger
Example:1

Quantidade de páginas para exibir os dados

tipoFiltrostring
Example:vencimento|criacao

Tipo de filtro de data que pode ser por vencimento ou criação (padrão por vencimento)

destring
Example:01/01/2022

Data início do vencimento a ser procurado

atestring
Example:01/02/2022

Data fim do vencimento a ser procurado

idUltimoPagamentointeger
Example:1

Id do último pagamento, ele deve ser informado ou as datas

Headers

emailstring required
Example:email@email.com

Email de autenticação no CV

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no CV

Response

Operação realizada com sucesso do get parcela.

totalinteger

Total de resultados da query disponivel no banco de dados.

limiteinteger

Limitar por página.<br/>

paginainteger

Mostrar por página.<br/>

Example response

{
  "total": 12340,
  "limite": 5,
  "pagina": 1,
  "pagamentos": [
    {
      "vencimento": "01/01/2022",
      "valorTotal": "121,12",
      "pagador": [
        {
          "nome": "carlos eduardo",
          "documento": "123456789",
          "telefone": "(79)99999-8888",
          "email": "mail@provedor.com.br",
          "logradouro": "avenida",
          "numero": "12345",
          "complemento": "casa 1",
          "bairro": "nome do bairro",
          "cidade": "nome da cidade",
          "estado": "nome do estado"
        }
      ],
      "beneficiario": [
        {
          "nome": "carlos eduardo",
          "documento": "123456789",
          "telefone": "(79)99999-8888",
          "email": "mail@provedor.com.br",
          "logradouro": "avenida",
          "numero": "12345",
          "complemento": "casa 1",
          "bairro": "nome do bairro",
          "cidade": "nome da cidade",
          "estado": "nome do estado"
        }
      ],
      "parcelas": [
        {
          "idparcela": 123,
          "valor": "11.01"
        }
      ]
    }
  ]
}