Contratos

Retornar os contratos das unidades do cliente

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: POST /api/v1/cliente/autenticacao (documento e senha do cliente) ou POST /api/v1/cliente/autenticacao/sindico (síndicos). ⚠️ O token de integração das APIs v2/v3 (POST /api/v3/auth/token) não é válido para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.

get/contratos

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/cliente
  • URL
    https://integracao.cvcrm.com.br/api/v1/cliente/contratos
  • Auth
    HTTP bearer

Query parameters

offsetinteger

registro inicial

limitinteger

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

Response

Listagem de Contratos

totalinteger
offsetinteger
limitstring nullable

Example response

{
  "total": 5,
  "contratos": [
    {
      "idcontrato": 11625,
      "titulo": "Contrato automático - Cliente e associado",
      "tipo": "Venda",
      "criado": "2022-06-20 15:16:17",
      "unidade": {
        "idunidade": 17785,
        "nome": "APTO 101",
        "previsao_entrega": "0000-00-00",
        "bloco": {
          "idbloco": 3046,
          "nome": "Unica_1"
        },
        "etapa": {
          "idetapa": 9520,
          "nome": "FASE 1"
        },
        "empreendimento": {
          "idempreendimento": 217,
          "nome": "Alphapark da Avenida",
          "foto": {
            "nome": "CAMBORIU (1) (1).jpg",
            "tipo": "image/jpeg",
            "tamanho": 10021,
            "url": "https://localhost.cvcrm.com.br/api/get/imagens/empreendiment"
          }
        }
      },
      "arquivo": {
        "url": "https://localhost.cvcrm.com.br/api/get/contrato/13762/CxgWhN"
      }
    }
  ]
}

Changes

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