kroz docs

Conceitos

Entenda os objetos e termos fundamentais antes de usar a kroz. Esta página espelha a linguagem da mesa de operação em app.kroz.co.

Em resumo

A kroz gerencia recebíveis imobiliários com repasse automático na origem. Os objetos primários são Contrato, Matriz de rateio e Cobrança, operados na sequência Recebedores → Rateio → Fechamento → Pagadoria.

Regra de ouro:

Pagador compra. Recebedor recebe.


Pagador vs recebedor

Distinção central, confundir os dois quebra split e compliance.

Pagador Recebedor
Quem é Comprador da unidade SPE, terrenista, corretor, força de vendas
Onde cadastra Cobrança (ID do pagador no BaaS) Oficina de Recebedores
Gera Link PIX/boleto walletId para o array split[]
Recebe split? ❌ Nunca ✅ Sim

Se o comprador aparecer na Oficina de Recebedores, pare. Pagador entra como cliente/cobrança, não como recebedor.


Split na origem

Quando o pagador quita PIX ou boleto, o valor já nasce repartido entre os recebedores definidos na matriz, sem que o dinheiro passe por conta central da incorporadora para repasse posterior.

Na UI: badge Split na origem (Pagadoria). Na prática: payload do parceiro BaaS com split[] na criação da cobrança, não depois.

Exemplo prático: PS-0421

Contrato demo PS-0421, Unidade 1804, parcela de R$ 10.000 com matriz 72/18/10:

Recebedor Papel na UI % Valor
SPE emissora (Porto Sereno) SPE 72% (remainder implícito) R$ 7.200
Terrenista Demo Ltda Terrenista / Landbank 18% R$ 1.800
Força de vendas Vendas 10% R$ 1.000

O corretor recebe direto na origem, sem repasse via imobiliária.

Como saber se está certo?

Na aba Payload do Rateio, o JSON deve conter split[] com walletId de cada recebedor externo. SPE retém o remainder automaticamente.


Recebedor e subconta

Recebedor = quem recebe parte do split. Cadastrado na Oficina de Recebedores (/recebedores/).

Cada recebedor identificado possui subconta na instituição de pagamento (IP). Ao criar, o BaaS gera:

  • walletId, usado no array split[] da cobrança
  • apiKey, exibida uma vez; guarde com segurança

Tipos de recebedor (UI)

Opção no app Papel típico
Terrenista / permuta Landbank (18% demo)
Força de vendas Comissão comercial (10% demo)
SPE recebedora Entidade emissora
Imobiliária parceira Intermediação (quando aplicável)
Fornecedor operacional Serviços da obra

Rail de estado

Rascunho → Pendente → Validado → Pronto → Criado

No piloto, pare em Validado (dry-run). Criado = subconta real na parceiro BaaS.

Valores sugeridos

  • Faturamento mensal aproximado: informe valor realista, impacta limites do BaaS
  • Dry-run: sempre ative Manter em dry-run seguro até Fechamento aprovado

SPE emissora

Sociedade de Propósito Específico que emite a cobrança e retém a parcela da evolução da obra, tipicamente o maior percentual da matriz.

Na UI: - Aparece readonly na Pagadoria após Carregar matriz - Label SPE emissora no Rateio - Coluna SPE no livro da Governança

Como calcular: SPE = remainder. Se terrenista 18% + vendas 10%, SPE fica com 72% automaticamente.

Não aloque SPE manualmente como recebedor externo. O motor trata o remainder.


walletId

Identificador da subconta do recebedor no BaaS. Obrigatório no payload de split.

Onde ver Como usar
Oficina de Recebedores → após validação Copie para a matriz
Rateio → aba Payload Confirme no JSON split[].walletId
Lembretes do app walletId vai no array split

Armadilha: recebedor sem walletId validado → split falha na Pagadoria.


Empreendimento, unidade e contrato

Conceito Backend Na UI hoje
Empreendimento developments Campo Empreendimento no sheet Ajustar deal
Unidade contracts.metadata.unidade Parte de Contrato / unidade
Contrato contracts.reference ex.: PS-0421 \| Unidade 1804

Importante: não há telas dedicadas de cadastro hoje. Três caminhos:

  1. Rateio → Ajustar deal: configura inline para o deal
  2. Pagadoria → Contrato → Carregar matriz: referencia contrato existente no backend
  3. Seed/backend: demo pré-carregado (Porto Sereno, PS-0421)

Exemplo de nomenclatura

Campo Bom Evitar
Empreendimento Porto Sereno Residences Obra 1, Teste
Contrato / unidade PS-0421 \| Unidade 1804 contrato novo
Referência externa Código do ERP/CRM UUID interno exposto

Matriz de rateio

Versão das regras de repasse ligada a um contrato. Na UI: Matriz ou Matriz de rateio.

Demo padrão: SPE 72% · Landbank 18% · Vendas 10% (CPC 47)

Composta por:

  • Alocações, recebedores + percentuais
  • SPE emissora, remainder automático
  • Prova selada, hash após Validar rateio

Regra de ouro

Versão validada é imutável para fins operacionais. Correção = nova versão (futuro: superseded_by no Rule Engine).

Comissão na 3ª parcela

Regra de negócio visível na UI:

Parcela < 3 → Comissão de vendas entra na 3ª parcela

Parcela Vendas na matriz
1 ou 2 Suspenso
3+ Elegível

Configure o número da parcela em Ajustar dealParcela.

Papéis (role no backend)

Role Label na UI Função
spe SPE emissora Evolução da obra (remainder)
landbank Terrenista / Landbank Permuta ou terreno
sales Força de vendas / Vendas Comissão comercial

Basis (base de cálculo: Rule Engine)

Basis Significado Exemplo
percent % do valor líquido 18% terrenista
fixed Valor fixo por evento R$ 500 fee fixo
remainder O que sobrar SPE emissora

Dry-run (modo seguro)

Simulação sem efeitos colaterais no BaaS. Valida payload, percentuais e cadastro antes de execução real.

Módulo Toggle / ação Mensagem de sucesso
Recebedores Manter em dry-run seguroValidar Payload (Dry-Run) Dry-run concluído. Revise o payload…
Rateio Validar rateio Rateio validado em modo seguro.
Pagadoria Executar em modo seguroGerar cobrança Pagadoria validada em dry-run.
Sandbox Simular split D+0 Backend validou o payload com sucesso.
Fechamento Validar fechamento Fechamento validado em dry-run…

Quando usar cada um

Situação Onde simular
Testar CNPJ/endereço de recebedor Recebedores
Validar percentuais de um deal Rateio
Testar % isolados (SPE/L/V) Sandbox
Validar cobrança completa Pagadoria
Checklist pré-execução Fechamento

Regra: nunca desative dry-run sem Fechamento aprovado.


Cobrança (Pagadoria)

Cobrança = charge PIX ou boleto emitida contra o pagador, com split embutido.

Tipos de cobrança

Tipo Quando usar
Sinal Reserva da unidade
Entrada Primeiro pagamento significativo
Pré-venda Antes da escritura
Parcela Parcela pró-soluto recorrente

Fluxo: Contrato carregadoTipo de cobrançaSplit na origemMensagem para o corretor

Campos comerciais (não alteram split)

Corretor, Gerente, Imobiliária, vão para captabilidade (CSV export), não para o payload de split.


Fechamento

Mesa de validação pré-execução, garante que contrato, recebedores, matriz e payload estão coerentes antes de cobrança real.

Estágios: ContratoRecebedoresRateioAprovaçãoEvidência

Ação Pré-requisito Resultado
Validar fechamento Rateio validado Checklist 6/6, status Validado
Aprovar execução Fechamento validado Status Aprovado
Exportar evidência Fechamento aprovado JSON + link Governança

Exemplos de checks: Contrato possui referência externa, Soma da matriz fecha em 100%, Payload do parceiro BaaS gerado em sandbox.


Conciliação

Processo de baixa e resolução de divergências após liquidação.

Fluxo na UI:

Webhook BaaS → Agente + motor → Aprovação DF → Execução
Conceito Significado
Sugestão Proposta automática de baixa ou ajuste
Confiança Alta / Média / Baixa · filtro na fila
Aprovador (DF) Diretor Financeiro · aprovação humana
Execução manual Em demo: execução manual no BaaS após aprovação

Use quando valor pago ≠ valor esperado, multa/juros, ou atraso.


Governança, evidência e trilha

Governança = hub de tesouraria e auditoria.

Termo O que é
Livro Registro cronológico de eventos financeiros
Trilha Sequência de decisões e mudanças de estado
Evidência Export JSON de fechamento aprovado
Prova selada Hash da validação de rateio
Captabilidade CSV de atribuição comercial (Pagadoria)

Hero aside: Quem decidiu / O que mudou / Como provar

Colunas do livro: Evento, Valor, SPE, Terrenista, Vendas, Situação, Ações


RC 16 (sem conta-bolsão)

Resolução BCB nº 16/2025, exige identificação de recebedores em contas de pagamento.

Na prática para a kroz:

  • ✅ Dinheiro vai direto ao destino (SPE, terrenista, corretor)
  • ✅ Cada recebedor com subconta na IP
  • ❌ Dinheiro não dorme em conta da incorporadora ou plataforma

Como validar com parceiro BaaS

Modelo Descrição Atende kroz?
A · Split na origem Repasse na liquidação (split[]) ✅ Desenho atual
B · Conta + P2P Cash-in → N transferências ⚠️ Ressalvas RC 16
C · Batch manual Rateio posterior

Ver Compliance e Adaptadores BaaS.


BaaS e parceiro licenciado

BaaS (Banking as a Service) = parceiro regulado que processa Pix, boleto, subcontas e split.

Camada Responsável
Regras, UI, auditoria kroz (app.kroz.co)
Pix, boleto, subcontas, split Parceiro BaaS licenciado (em contratação)

Disclosure na UI (Recebedores, Pagadoria, Sandbox):

Serviços financeiros prestados pela instituição de pagamento parceira licenciada… A kroz atua exclusivamente como integradora tecnológica e não é instituição financeira.

O adaptador traduz matriz kroz → payload do parceiro BaaS (split[], walletId).


CPC 47

Regime fiscal exibido na matriz demo: CPC 47, referência contábil para reconhecimento de receita em incorporações. Aparece como label na matriz padrão 72/18/10.

Não altera o cálculo do split na UI; contextualiza a operação para o financeiro.


Rule Engine (visão conceitual)

Motor interno (em implementação) que formaliza o que a UI já faz:

  • rule_versions, matriz versionada
  • rule_triggers, gatilhos (ex.: payment_settled, installment_number_gte)
  • domain_events, webhooks normalizados
  • split_executions + audit_events, prova de qual regra gerou qual split

Nome comercial: "O contrato vira regra executável".
Não usar "smart contract".

Ver Rule Engine


Relações entre conceitos

graph TD
    DEV[Empreendimento] --> CTR["Contrato / unidade"]
    CTR --> RV[Matriz de rateio]
    REC[Recebedores + walletId] --> RV
    RV --> FECH[Fechamento]
    FECH --> COB[Cobrança / Pagadoria]
    COB --> BAAS[BaaS / Split na origem]
    BAAS --> CONC[Conciliação]
    CONC --> GOV[Governança / Trilha]
    RV --> AUD[Prova selada]

Glossário rápido (UI ↔ backend)

Termo na UI Backend / técnico
Empreendimento developments
Contrato / unidade contracts.reference + metadata.unidade
Matriz de rateio split_matrices
SPE emissora spes
Recebedor subconta na IP + walletId
Pagador customer no BaaS
Prova selada seal_hash / audit
Payload JSON enviado ao BaaS
Dry-run seguro dryRun: true nas APIs

O que evitar

❌ Evite ✅ Faça
Cadastrar comprador como recebedor Customer ID na Pagadoria
Desativar dry-run sem Fechamento Validar → Aprovar → Executar
Assumir contrato existe Ajustar deal ou Carregar matriz
Ignorar parcela < 3 para vendas Verificar status Suspenso/Elegível
Perder apiKey do recebedor Exportar evidência na criação

Leia também