Financeiro

Retorna o extrato 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/financeiro/extrato

Request

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

Query parameters

offsetinteger

registro inicial

limitinteger

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

Response

Extrato do cliente

totalinteger

offsetinteger

limitinteger

Example response

{
  "total": 22,
  "limit": 30,
  "extrato": [
    {
      "numero_parcela": 1,
      "total_parcela": 48,
      "condicao": "Trimestral",
      "valor_original": 500,
      "data_vencimento": "2019-06-29",
      "recibos": [
        {
          "tipo_recibo": "Distrato",
          "data_calculo": "2020-01-01",
          "data_recibo": "2020-05-07",
          "recibo_valor": 500,
          "total_recibo_valor": 500
        }
      ]
    }
  ]
}

Changes

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