Financeiro

Retorna os parcelas disponiveis para antecipação de uma unidade

🔒 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/antecipacao-parcelas/{idUnidade}

Request

Base URL
https://integracao.cvcrm.com.br/api/v1/cliente
URL
https://integracao.cvcrm.com.br/api/v1/cliente/financeiro/antecipacao-parcelas/{idUnidade}
Auth
HTTP bearer

Path parameters

idUnidadeinteger required

id da unidade

Query parameters

offsetinteger

registro inicial

limitinteger

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

Response

Parcelas do cliente

totalinteger

offsetinteger

limitinteger

possui_parcelas_pendentesboolean

codigo_titulo_siengeinteger

Example response

{
  "total": 17,
  "limit": 30,
  "possui_parcelas_pendentes": true,
  "codigo_titulo_sienge": 4566,
  "parcelas": [
    {
      "data_vencimento": "2023-06-01 00:00:00",
      "tipo_condicao_parcela": "Parcelas Mensais",
      "valor_original": "R$ 100,99",
      "valor_acrescimo": "R$ 10,00",
      "valor_corrigido": "R$ 110,99"
    }
  ]
}

Changes

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