Fluxo completo de integração

Mapa dos relacionamentos

Empresa
  └── Pessoas ──┬── Locações ── Imóveis
                │       │
                │       └── Contas (origemType: "Locacao")
                │              ├── Itens de contas (composição)
                │              └── Pagamentos (baixas)
                └── (pessoa vinculada à conta)

Roteiro passo a passo

1. Encontre o contrato

GET /locacoes?status[]=Ativa

Anote id, imovelId e os pessoaId de proprietarios e inquilinos.

2. Liste as parcelas em aberto

GET /contas?situacao[]=em_aberto

O par origemId/origemType liga cada conta à locação de origem.

3. Detalhe a composição de cada conta

GET /contas-itens?contaId={id}

Separe aluguel, taxas, multa, juros e descontos pelas flags e pela categoria de cada item.

4. Confirme as baixas

GET /pagamentos?contaId={id}&estornado=false

Uma conta pode ter múltiplos pagamentos parciais até ficar paga.

5. Resolva as pessoas

GET /pessoas/{pessoaId}

Converta qualquer pessoaId em nome, documento e contatos.

💡
Dica de performance: carregue pessoas e imóveis uma vez e mantenha um cache local indexado por ID, em vez de consultar /pessoas/{id} a cada conta processada.

Próximo passo

Acompanhando pagamentos

Detecte baixas, contas vencidas e estornos com polling