Distrato

Retorna distratos de reservas

🔒 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)

Retorna os distratos cadastrados no sistema, feito para integração com sistemas que necessitam um payload de informações menor

get/v1/comercial/reservas/distratos

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/v1/comercial/reservas/distratos
  • Auth
    none declared. Required headers: email, token

Query parameters

limitinteger
Example:30

Limite de itens no conteúdo da resposta.

offsetinteger

Offset do início dos resultados.

a_partir_destring string
Example:28/09/2023

Retorna as reserva cadastradas a partir da data informada.

Headers

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

Response

Distratos retornados com sucesso.

totalinteger

Total de distratos da query disponível no banco de dados

limitstring

Limite de itens no conteúdo da resposta de distratos

offsetinteger

Offset do início dos distratos

totalConteudointeger

Total de distratos da página

Example response

{
  "total": 12340,
  "limit": 30,
  "offset": 0,
  "totalConteudo": 30,
  "distratos": [
    {
      "idReserva": "1515",
      "dataDistrato": "2021-02-03",
      "numeroContrato": "84563256"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.