---
title: "Retorna os distratos"
method: GET
path: "/distratos"
tags: ["Distratos"]
---

# Retorna os distratos

`GET /distratos`

## Request

- Base URL: `https://integracao.cvcrm.com.br/api/v1/cvdw`
- URL: `https://integracao.cvcrm.com.br/api/v1/cvdw/distratos`
- Auth: none declared. Required headers: `email`, `token`

> 🔒 **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)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-apis-cvcrm-email-token)

Esta api retorna os dados dos distratos a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.

## Query parameters

- `pagina` integer
- `registros_por_pagina` integer
- `a_partir_referencia` integer
- `a_partir_data_referencia` string
- `ate_data_referencia` string

## Headers

- `email` string, required
- `token` string, required

## Response `200`

Distratos

- object: Dados distrato
  - `pagina` integer: Página atual do retorno dos registros
  - `registros` integer: Quantidade de registro da página, máximo 500 registros
  - `total_de_registros` integer: Total de registros encontrados
  - `total_de_paginas` integer: Total de páginas encontradas
  - `dados` Distratos[]
    - `referencia` string: Código identificador da reserva
    - `referencia_data` string: Data de referência
    - `ativo` string: Informa se está ativo ou não
    - `idreserva` integer: Código identificador da reserva
    - `aprovada` string: Informação de aprovação da reserva. (Sim, Não)
    - `data_cad` string: Data de cadastro da reserva
    - `situacao_data` string: Situação no cadastro do distrato da reserva
    - `situacao_atual` string: Situação atual da reserva
    - `idsituacao` integer: Código identificador da situação
    - `idempreendimento` integer: Código identificador do empreendimento
    - `codigointerno_empreendimento` string: Código interno do empreendimento
    - `empreendimento` string: Empreendimento da reserva
    - `regiao` string: Região do empreendimento da reserva
    - `etapa` string: Etapa do empreendimento
    - `bloco` string: Bloco do empreendimento
    - `idunidade` integer: Id da unidade do empreendimento
    - `unidade` string: Unidade do empreendimento
    - `venda` string: Código identificador da reserva distratada
    - `idcliente` integer: Código identificador do cliente
    - `cliente` string: Nome do cliente da reserva
    - `documento` string: Número do documento (CPF/CNPJ) do cliente
    - `cep_cliente` string: CEP do cliente
    - `idcorretor` integer: Código identificador do corretor vinculado
    - `corretor` string: Corretor da reserva
    - `idimobiliaria` integer: Código identificador da imobiliária vinculada
    - `imobiliaria` string: Imobiliária da reserva
    - `motivo_distrato` string: Título da razão do distrato
    - `descricao_motivo_distrato` string: Descrição do motivo do distrato
    - `valor_contrato` number: Valor do contrato da reserva
    - `data_sincronizacao` string: Data da sincronização

## Other responses

- `400`: Erro de solicitação da API de distratos, revise os parâmetros!
- `401`: E-mail e/ou token incorreto(s).
- `422`: Erro inesperado na API de distratos, por favor entre em contato com o suporte técnico.

---

[API](https://skmtc.dev/cvcrm/apis/cvdw.md) - [All operations](https://skmtc.dev/cvcrm/apis/cvdw/llms.txt) - [OpenAPI document](https://skmtc.dev/cvcrm/apis/cvdw/revisions/ca413a559002?raw)