Skip to main content

​
O objeto Conta

{
  "id": "fin001",
  "contratoId": "con789",
  "descricao": "Aluguel - Fevereiro/2025",
  "valor": 2500,
  "dataVencimento": "2025-02-05",
  "tipo": "ALUGUEL",
  "status": "PAGO",
  "dataPagamento": "2025-02-03T18:00:00.000Z",
  "reciboId": "rec001",
  "userId": "uid_do_usuario",
  "criadoEm": "2025-01-15T10:00:00.000Z"
}

​
Tipos válidos

ValorDescrição
ALUGUELParcela mensal de aluguel
CAUCAODepósito caução
REPAROCobrança por reparo/dano

​
Status

ValorDescrição
PENDENTEAguardando pagamento
ATRASADOPENDENTE com dataVencimento anterior a hoje — auto-gerenciado
PAGOPagamento confirmado
CANCELADOConta cancelada manualmente
O status ATRASADO nunca precisa ser setado manualmente. A API atualiza automaticamente via batch ao listar ou buscar contas.

​
Criar conta

​
contratoId
string
required
ID do contrato ao qual esta conta está vinculada.
​
descricao
string
required
Descrição legível (ex: "Aluguel - Fevereiro/2025").
​
valor
number
required
Valor em reais.
​
dataVencimento
string
required
Data de vencimento no formato YYYY-MM-DD.
​
tipo
string
required
Um dos valores: ALUGUEL, CAUCAO, REPARO.
POST /financeiro
Cookie: imob_session=<session_cookie>
Content-Type: application/json

{
  "contratoId": "con789",
  "descricao": "Aluguel - Fevereiro/2025",
  "valor": 2500,
  "dataVencimento": "2025-02-05",
  "tipo": "ALUGUEL"
}
Resposta 201
{
  "message": "Conta criada com sucesso",
  "id": "fin001"
}

​
Listar contas

​
contratoId
string
Filtra por contrato específico.
​
status
string
Filtra por status após a atualização automática de inadimplência.
GET /financeiro?contratoId=con789&status=ATRASADO
Cookie: imob_session=<session_cookie>

​
Listar contas por contrato

Atalho equivalente a GET /financeiro?contratoId=:id. Mantido por compatibilidade. 
GET /financeiro/contrato/:contratoId
Cookie: imob_session=<session_cookie>

​
Registrar pagamento

Este é o endpoint mais importante do módulo. Ele suporta pagamento integral e parcial.
​
valorPago
number
Valor efetivamente recebido. Se omitido, assume o valor total da conta.
​
formaPagamento
string
Ex: "PIX", "Boleto", "Transferência". Salvo no recibo.
PATCH /financeiro/:id/pagar
Cookie: imob_session=<session_cookie>
Content-Type: application/json

{
  "valorPago": 2500,
  "formaPagamento": "PIX"
}

​
Pagamento Integral

Resposta 200 — Integral
{
  "status": "sucesso",
  "tipo_pagamento": "INTEGRAL",
  "saldo_devedor": 0,
  "recibo_digital": { ... }
}

​
Pagamento Parcial

Quando valorPago < valor:
  1. A conta atual é marcada como PAGO com o valor recebido e descrição (Parcial).
  2. Uma nova conta é criada automaticamente com o saldo restante, status PENDENTE e mesmo dataVencimento.
  3. Um recibo do tipo PARCIAL é gerado e vinculado.
Resposta 200 — Parcial
{
  "status": "sucesso",
  "tipo_pagamento": "PARCIAL",
  "saldo_devedor": 500,
  "recibo_digital": { ... }
}
Contas com status PAGO ou CANCELADO retornam 400 Bad Request ao tentar pagar novamente.

​
Atualizar conta

Use para editar campos como descricao, dataVencimento ou status manualmente. 
PATCH /financeiro/:id
Cookie: imob_session=<session_cookie>
Content-Type: application/json

{
  "status": "CANCELADO"
}

​
Deletar conta

DELETE /financeiro/:id
Cookie: imob_session=<session_cookie>