Skip to main content

​
Visão Geral

Recibos não são criados diretamente via esta API. Eles são gerados automaticamente pelo endpoint PATCH /financeiro/:id/pagar no momento do pagamento, e vinculados à conta via reciboId. Eles ficam disponíveis para consulta e impressão — mas não são editáveis.

​
O objeto Recibo

{
  "id": "rec001",
  "contaId": "fin001",
  "contratoId": "con789",
  "locatarioNome": "João da Silva",
  "locatarioCpf": "123.456.789-00",
  "imovelEndereco": "Rua das Flores, 123 - Apto 42, Centro, São Paulo/SP",
  "valor": 2500,
  "descricao": "Aluguel - Fevereiro/2025",
  "tipo": "INTEGRAL",
  "formaPagamento": "PIX",
  "dataPagamento": "2025-02-03T18:00:00.000Z",
  "codigoRecibo": "FIN00123",
  "userId": "uid_do_usuario",
  "criadoEm": "2025-02-03T18:00:01.000Z"
}

​
Tipos de recibo

ValorGerado quando
INTEGRALPagamento cobre 100% do valor
PARCIALPagamento cobre menos que o valor total
CAUCAOQuando o tipo da conta é CAUCAO

​
Campo codigoRecibo

Código legível gerado a partir dos primeiros 8 caracteres do contaId, em maiúsculo. Serve como referência humana no recibo impresso.

​
Listar recibos

​
contratoId
string
Filtra recibos de um contrato específico.
Ordenados por dataPagamento decrescente. 
GET /recibos
Cookie: imob_session=<session_cookie>

GET /recibos?contratoId=con789
Cookie: imob_session=<session_cookie>

​
Buscar recibo por ID

GET /recibos/:id
Cookie: imob_session=<session_cookie>

​
Deletar recibo

A deleção remove apenas o recibo do banco, não reverte o pagamento. A conta permanece com status: PAGO. Use apenas para corrigir registros duplicados ou com erro.
DELETE /recibos/:id
Cookie: imob_session=<session_cookie>