v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Gestões de Distrato

Retorna todas as gestões de distrato cadastradas

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

Este endpoint retorna uma lista de gestões de distrato cadastradas no sistema CV. Você pode filtrar os resultados usando parâmetros como iddistrato, idreserva, idpessoa, ou o número do documento. A resposta também inclui informações detalhadas sobre as gestões, como datas, motivos de cancelamento, observações, e outros metadados relevantes.

get/gestoes-distrato

Query parameters

offsetinteger

Registro inicial

limitinteger

Example:30

Quantidade de registros (caso não passe retorna todos)

iddistratointeger

Example:20

Código de indentificação do distrato no cv

idreservainteger

Example:2001

Código de indentificação da reserva no cv

idpessoainteger

Example:9

Código de indentificação da pessoa no cv

documentostring

Example:12345678900

Documento da pessoa no cv

Headers

emailstring required

Example:email@email.com

Email de autenticação no CV

tokenstring required

Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Token de autenticação no CV

Response

Resposta de Gestões de Distrato

totalinteger

Total de resultados

limitinteger

Limite de itens no conteúdo da resposta

offsetinteger

Offset do início dos resultados

totalConteudointeger

Total de resultados no conteúdo da resposta

Example response

{
  "total": 30,
  "limit": 30,
  "offset": 0,
  "totalConteudo": 30,
  "gestao_distratos": [
    {
      "iddistrato": 10,
      "data_cad": "2023-04-23 15:18:36",
      "idreserva": 2001,
      "idsituacao": 1,
      "situacao": "Início",
      "data_ultima_alteracao_situacao": "2023-05-10 15:45:19",
      "idmotivo_cancelamento": 1,
      "motivo_cancelamento": "Início",
      "descricao_motivo_cancelamento": "Início",
      "vencimento": "2023-07-24 13:48:13",
      "solicitacao": "S",
      "observacoes": "Teste",
      "idunidade": 100,
      "unidade": "AP 101",
      "idbloco": 4,
      "bloco": "Bloco A",
      "idetapa": 2,
      "etapa": "Única",
      "idempreendimento": 2,
      "empreendimento": "Única",
      "pessoa": {
        "idpessoa": 20,
        "idpessoa_int": "791",
        "nome": "Pessoa CV",
        "documento": "1234567899"
      },
      "associados": [
        {
          "idpessoa": 21,
          "idpessoa_int": "791",
          "nome": "Pessoa CV 2",
          "documento": "1234567890"
        }
      ],
      "documentos": [
        {
          "idtipo": 1,
          "tipo": "RG",
          "situacao": "Reprovado",
          "arquivo_nome": "rg.jpg"
        }
      ],
      "mensagens": [
        {
          "usuario": "Gestor CV",
          "mensagem": "Mensagem teste"
        }
      ],
      "contratos": [
        {
          "contrato": "Termo de consentimento",
          "assinado": "2023-07-24 13:48:13",
          "validado": "2023-07-24 13:48:13"
        }
      ]
    }
  ]
}