1. Gestão de portfolio
AgRisk
  • AgRisk
    • Documentação
      • AgRisk
    • API - AgRisk
      • Login
        • Atualizar token
        • Autenticar usuário
      • Consultas
        • Solicitar consulta
        • Listar consultas
        • Listar consultas da empresa
      • Listagem de Produtos
        • Listar produtos
      • Clientes
        • Listar clientes
        • Criar cliente
        • Listar contadores de clientes
        • Deletar cliente
        • Listar contadores de clientes no grupo
      • Dados Cadastrais
        • Buscar dados cadastrais
      • Grupos
        • Listar grupos
        • Criar grupo
        • Listar clientes em grupo
        • Criar cliente em grupo
        • Atualizar nome do grupo
        • Deletar grupo
        • Inserir cliente em grupo
        • Remover cliente de grupo
      • Análise de Matrícula
        • Listar análises de matrículas
        • Criar análise de matrícula
        • Buscar análise de matrícula
        • Deletar análise de matrícula
      • Contatos
        • Listar contatos
      • BNDES
        • Listar BNDES
      • Boa Vista
        • Listar Boa Vista
      • Compliance
        • Listar compliance
      • CPRs
        • Listar CPRs
        • Buscar CPR
      • Grupo econômico
        • familiar
          • Listar grupo econômico
          • Listar grupo familiar
      • Imposto de Renda
        • Criar ativo financeiro
        • Listar ativos financeiros
        • Criar dívida
        • Importar dívidas
        • Listar dívidas
        • Atualizar dívida
        • Deletar dívida
        • Criar ativo móvel
        • Listar ativos móveis
        • Atualizar ativo móvel
        • Deletar ativo móvel
        • Criar imóvel urbano
        • Listar imóveis urbanos
        • Atualizar imóvel urbano
        • Deletar imóvel urbano
      • Judicial
        • Listar processos judiciais
        • Buscar processo judicial
        • Solicitar análise por IA
      • Protestos
        • Listar protestos
      • Imóveis Rurais - Simples
        • Criar imóvel rural
        • Listar imóveis rurais
        • Buscar imóvel rural
      • Endividamento
        • Listar SCR (endividamento)
      • Imóveis Rurais - CAR
        • Listar CAR (Cadastro Ambiental Rural)
        • Buscar CAR
        • Deletar CAR
        • Criar CAR
        • Download certidão CAR
      • QUOD
        • Buscar Quod
      • Restritivo Nacional
        • Buscar Restritivo Nacional
      • Veicular
        • Buscar Patrimônio Veicular
      • Sintegra
        • Listar Sintegras
    • APIs
    • Raiz
    • Esquemas
      • API Requests
        • ClientResponse
  • AgFlow
    • 🇧🇷 Português
      • Aprovação
        • Aprovação — Visão Geral
        • Consultar configuração de aprovação
        • Criar configuração de aprovação
        • Atualizar configuração de aprovação
        • Adicionar regra de aprovação
        • Atualizar regra de aprovação
        • Remover configuração de aprovação
        • Consultar aprovação do card
        • Registrar voto de aprovação
        • Atualizar voto de aprovação
      • Fluxo
        • Fluxo — Visão Geral
        • Verificar disponibilidade
        • Criar fluxo
        • Listar fluxos
        • Obter fluxo
        • Atualizar fluxo
        • Remover fluxo
        • Adicionar usuário ao fluxo
        • Remover usuário do fluxo
        • Listar caminhos de campos dinâmicos
      • Consulta a Bureau
        • Consulta a Bureau — Visão Geral
        • Obter configuração de consulta a bureau
        • Criar configuração de consulta a bureau
        • Atualizar configuração de consulta a bureau
      • Campos
        • Campos — Visão Geral
        • Listar campos da fase
        • Atualizar campos da fase
        • Atualizar regras de campos da fase
      • Conversa
        • Conversa — Visão Geral
        • Obter configuração de conversa
        • Criar configuração de conversa
        • Remover configuração de conversa
      • Motores
        • Motores — Visão Geral
        • Consultar resultado do motor de decisão do card
        • Executar motor de decisão no card
        • Consultar inputs do motor de crédito para o card
        • Consultar resultado do motor de crédito do card
        • Executar motor de crédito no card
        • Consultar configuração do motor de decisão
        • Criar configuração do motor de decisão
        • Atualizar configuração do motor de decisão
        • Remover configuração do motor de decisão
        • Consultar detalhe da configuração do motor de crédito
        • Criar configuração do motor de crédito
        • Listar configurações do motor de crédito do flow
        • Listar políticas de crédito aplicáveis a um card
        • Atualizar configuração do motor de crédito
        • Remover configuração do motor de crédito
      • Parecer
        • Parecer — Visão Geral
        • Consultar configuração do parecer técnico
        • Criar configuração do parecer técnico
        • Atualizar configuração do parecer técnico
        • Consultar parecer registrado no card
        • Registrar parecer no card
        • Atualizar parecer no card
      • Formulário Inicial
        • Formulário Inicial — Visão Geral
        • Criar formulário inicial
        • Definir regras condicionais do formulário
        • Atualizar metadados do formulário
        • Consultar formulário inicial
        • Consultar formulário público
        • Atualizar campos do formulário
        • Remover formulário inicial
      • Filtros
        • Filtros — Visão Geral
        • Listar filtros salvos
        • Criar filtro salvo
        • Atualizar filtro salvo
        • Buscar cards do flow
        • Busca global de cards
      • AgRisk
        • AgRisk — Visão Geral
        • Listar produtos de consulta AgRisk
      • Gatilhos
        • Gatilhos — Visão Geral
        • Listar gatilhos do flow
        • Criar gatilho
        • Atualizar gatilho
        • Remover gatilho
        • Listar gatilhos da fase
      • Autenticação
        • Autenticação — Visão Geral
        • Autenticar usuário
      • Mensageria
        • Mensageria — Visão Geral
        • Configurar telefone
        • Consultar configuração de mensageria
        • Criar configuração de mensageria
        • Atualizar configuração de mensageria
        • Criar regras de mensageria
        • Atualizar regra de mensageria
        • Remover configuração de mensageria
      • Empresas e Papéis
        • Empresas e Papéis — Visão Geral
        • Listar usuários da empresa
        • Listar papéis da empresa
        • Atualizar papel
        • Listar catálogo de permissões
        • Criar papel
        • Gerar URL de upload do logotipo
        • Gerar URL de download do logotipo
        • Atribuir papéis a um usuário
      • Documentos
        • Documentos — Visão Geral
        • Criar configuração de geração automática de documento
        • Remover configuração de geração automática de documento
        • Consultar configuração de geração automática de documento
        • Atualizar configuração de geração automática de documento
        • Consultar campos para geração do documento
        • Gerar documento a partir de template
        • Consultar template por ID
        • Listar templates do card
        • Ativar template
        • Criar template de documento
        • Remover template
        • Listar templates
        • Definir campos do template
        • Configurar regras condicionais do template
        • Atualizar arquivo do template
      • Cards
        • Cards — Visão Geral
        • Listar cards de uma fase
        • Mover card de fase
        • Criar card
        • Listar cards do flow
        • Criar card via link público
        • Buscar cards
        • Obter card
        • Atualizar card
        • Atualizar responsável do card
        • Atualizar campos via link público
        • Atualizar campos de fase do card
        • Remover cards em lote
        • Atualizar Ficha Cadastral do card
        • Obter responsável do card
        • Listar etiquetas do card
        • Listar campos de uma fase do card
        • Listar campos de uma fase do card (link público)
        • Obter histórico do card
        • Listar clientes do card
        • Criar comentário no card
        • Listar comentários do card
        • Remover comentário do card
        • Listar anexos do card
        • Cadastrar anexo no card
        • Remover anexo do card
        • Remover vínculo do anexo com campo de fase
        • Adicionar membros ao grupo do card
        • Remover membro do grupo do card
      • Configuração de Cliente
        • Configuração de Cliente — Visão Geral
        • Obter configuração de cliente por empresa
        • Criar configuração de cliente
        • Atualizar configuração de cliente
        • Obter configuração de cliente
        • Remover configuração de cliente
        • Listar seções
        • Criar seções
        • Obter seção
        • Atualizar seção
        • Atualizar seção parcialmente
        • Remover seção
        • Listar campos
        • Criar campos
        • Obter campo
        • Atualizar campo
        • Atualizar campo parcialmente
        • Remover campo
        • Listar regras
        • Criar regra
        • Obter regra
        • Atualizar regra
        • Atualizar regra parcialmente
        • Remover regra
      • Fase
        • Fase — Visão Geral
        • Criar ação de fase
        • Criar fase
        • Remover ação de fase
        • Remover fase
        • Listar ações da fase
        • Listar fases
        • Atualizar ação de fase
        • Atualizar fase
    • 🇺🇸 English
      • Phase
        • Phase — Overview
        • Create phase action
        • Create phase
        • Delete phase action
        • Delete phase
        • List phase actions
        • List phases
        • Update phase action
        • Update phase
      • Approval
        • Approval — Overview
        • Get approval configuration
        • Create approval configuration
        • Update approval configuration
        • Add approval rule
        • Update approval rule
        • Delete approval configuration
        • Get card approval
        • Register approval vote
        • Update approval vote
      • Flow
        • Flow — Overview
        • Health check
        • Create flow
        • List flows
        • Get flow
        • Update flow
        • Delete flow
        • Add user to flow
        • Remove user from flow
        • List dynamic field paths
      • Bureau Query
        • Bureau Query — Overview
        • Get bureau query configuration
        • Create bureau query configuration
        • Update bureau query configuration
      • Fields
        • Fields — Overview
        • List phase fields
        • Update phase fields
        • Update phase field rules
      • Engines
        • Engines — Overview
        • Get card decision engine result
        • Run card decision engine
        • Get card credit engine inputs
        • Get card credit engine result
        • Run card credit engine
        • Get decision engine configuration
        • Create decision engine configuration
        • Update decision engine configuration
        • Delete decision engine configuration
        • Get credit engine configuration detail
        • Create credit engine configuration
        • List flow credit engine configurations
        • List credit policies applicable to a card
        • Update credit engine configuration
        • Delete credit engine configuration
      • Conversation
        • Conversation — Overview
        • Get conversation configuration
        • Create conversation configuration
        • Delete conversation configuration
      • Opinion
        • Opinion — Overview
        • Get opinion configuration
        • Create opinion configuration
        • Update opinion configuration
        • Get card opinion
        • Create card opinion
        • Update card opinion
      • Start Form
        • Start Form — Overview
        • Create start form
        • Set start form conditional rules
        • Update start form metadata
        • Get start form
        • Get public start form
        • Update start form fields
        • Delete start form
      • Filters
        • Filters — Overview
        • List saved filters
        • Create saved filter
        • Update saved filter
        • Search flow cards
        • Search cards across flows
      • AgRisk
        • AgRisk — Overview
        • List AgRisk query products
      • Triggers
        • Triggers — Overview
        • List flow triggers
        • Create trigger
        • Update trigger
        • Delete trigger
        • List phase triggers
      • Authentication
        • Authentication — Overview
        • Authenticate user
      • Messaging
        • Messaging — Overview
        • Configure phone
        • Get messaging config
        • Create messaging config
        • Update messaging config
        • Create messaging rules
        • Update messaging rule
        • Delete messaging config
      • Companies & Roles
        • Companies & Roles — Overview
        • List company users
        • List company roles
        • Update role
        • List permissions catalog
        • Create role
        • Generate company logo upload URL
        • Generate company logo download URL
        • Assign roles to a user
      • Documents
        • Documents — Overview
        • Create automatic document configuration
        • Delete automatic document configuration
        • Get automatic document configuration
        • Update automatic document configuration
        • Get fields for document generation
        • Generate document from template
        • Get template by ID
        • List card templates
        • Activate template
        • Create document template
        • Delete template
        • List templates
        • Set template fields
        • Configure template conditional rules
        • Update template file
      • Cards
        • Cards — Overview
        • List cards in a phase
        • Move card to another phase
        • Create card
        • List flow cards
        • Create card via public link
        • Search cards
        • Get card
        • Update card
        • Update card assignee
        • Update fields via public link
        • Update card phase fields
        • Delete cards in bulk
        • Update card registration record
        • Get card assignee
        • List card labels
        • List card phase fields
        • List card phase fields (public link)
        • Get card history
        • List card clients
        • Create card comment
        • List card comments
        • Delete card comment
        • List card attachments
        • Register card attachment
        • Delete card attachment
        • Delete attachment's phase-field link
        • Add members to card group
        • Remove card group member
      • Client Configuration
        • Client Configuration — Overview
        • Get client configuration by company
        • Create client configuration
        • Update client configuration
        • Get client configuration
        • Delete client configuration
        • List sections
        • Create sections
        • Get section
        • Update section
        • Partially update section
        • Delete section
        • List fields
        • Create fields
        • Get field
        • Update field
        • Partially update field
        • Delete field
        • List rules
        • Create rule
        • Get rule
        • Update rule
        • Partially update rule
        • Delete rule
    • 💼 Visão de Negócio
      • Fase
      • Fluxo
      • Campos — Visão de Negócio
      • Aprovação
      • Parecer
      • Motores
      • Empresas e Papéis
      • Gatilhos
      • Conversa
      • Documentos
      • Mensageria
      • Filtros
      • Autenticação
      • Configuração de Cliente
      • Cards
      • AgRisk
      • Formulário Inicial
      • Consulta a Bureau
    • 💼 Business Overview
      • Phase
      • Flow
      • Approval
      • Fields — Business Overview
      • Opinion
      • Engines
      • Companies & Roles
      • Documents
      • Triggers
      • Messaging
      • Conversation
      • Filters
      • Authentication
      • Client Configuration
      • Cards
      • AgRisk
      • Start Form
      • Bureau Query
  • Portfolio
    • Documentação
      • Empresa
      • Gestão de portfolio
        • Análise geral
        • Dicionário de campos base (Necessário validar)
        • [Desatualizado]Fluxo de funcionamento
        • Carteiras
          • Gestão da carteira
        • Contratos
          • Contratos
          • Template Contratos
        • Pagamentos
          • Pagamentos
        • Baixas
          • Baixas
        • Clientes
          • Devedores e credores (Participantes)
          • Informações dos clientes
        • Importação de dados
          • Importação de dados
        • Garantia
          • Colaterais
      • Gestão de Cobrança
        • Régua de cobrança
          • Regras da régua por empresa
        • Atividades
          • Regras das Atividades
  1. Gestão de portfolio

[Desatualizado]Fluxo de funcionamento

Gestão de Portfolio — Fluxograma e Apresentação de Negócio#

Propósito: apresentar de ponta a ponta o funcionamento do módulo de Gestão de Portfolio para audiência de negócio. Cobre desde o setup inicial da empresa até o ciclo operacional de contratos, parcelas, baixas, inadimplência e visão de clientes na carteira. Cada fluxo traz o diagrama visual + regras de negócio chave.

1. O que é este módulo#

O Gestão de Portfolio é o módulo responsável por cadastrar, acompanhar e gerir carteiras de recebíveis — com foco no agronegócio. Permite que empresas registrem contratos de crédito (CPR Física, CPR Financeira, CCB, duplicatas, contratos de compra e venda, etc.), acompanhem o cumprimento das obrigações de pagamento, registrem baixas e monitorem a inadimplência por cliente e por carteira.

Entidades principais (em uma frase cada)#

EntidadeO que é
EmpresaA pessoa jurídica dona da carteira (cliente da Nagro).
Portfolio (Carteira)Agrupamento de carteiras. Uma empresa pode ter várias.
CarteiraAgrupamento obrigatório dentro de um portfolio. Onde os contratos vivem efetivamente (nome técnico: SubPortfolio).
Template de ContratoMolde que define como os contratos serão preenchidos.
DictionaryCatálogo da plataforma com os campos base de cada tipo de instrumento.
ContratoInstrumento jurídico-financeiro com participantes, parcelas e garantias.
ParticipanteCredor, devedor ou garantidor do contrato (sempre um Client).
Parcela (Pagamento)Obrigação de pagamento individual com vencimento.
BaixaRegistro de recebimento de uma parcela.
ColateralGarantia (real ou fidejussória) vinculada ao contrato.
ClientPessoa física ou jurídica cadastrada no AgRisk, que aparece nos contratos.

2. Hierarquia geral#

Regras fundamentais da hierarquia:
Toda empresa tem um ou mais portfolios independentes (silos isolados — não há visão consolidada cross-portfolio).
Cada portfolio tem uma ou mais carteiras. Carteira é obrigatória para que um portfolio receba contratos — não há acesso direto a contratos pelo portfolio.
Cada carteira contém zero ou mais contratos.
Cada contrato pertence a exatamente uma carteira, e portanto a exatamente um portfolio.
Cada contrato referencia um template (que define os campos do formulário).
Cada contrato tem um ou mais credores, um ou mais devedores e zero ou mais garantidores.
Cada contrato tem uma ou mais parcelas (obrigações de pagamento).
Cada parcela pode ter zero ou mais baixas (registros de recebimento).
Cada contrato pode ter zero ou mais colaterais (garantias).

3. Fluxo 1 — Setup inicial da empresa#

Quando uma empresa começa a usar o módulo, passa pela seguinte sequência:
Pontos de atenção:
O Client espelho representa a empresa quando ela aparece como credora dos próprios contratos (caso muito comum em crédito agro).
O modelo de visibilidade funciona em duas camadas: permissão RBAC (o que o usuário pode fazer) + atribuição a portfolios/carteiras (em quais carteiras ele atua).
Atribuição em portfolio dá visibilidade total do portfolio; atribuição em carteira restringe a visibilidade aos contratos daquela carteira.

4. Fluxo 2 — Templates e o Dictionary#

O template é o molde que define como um contrato será preenchido. Ele combina três camadas:
Princípios fundamentais:
PrincípioImplicação
Template é um snapshotO template captura as camadas 1 e 2 do Dictionary no momento da criação. Fica autocontido — não consulta o Dictionary depois.
Mudanças no Dictionary não afetam templates existentesQuando o AgRisk evolui o Dictionary, só novos templates capturam a mudança.
Refresh opcional do snapshotA empresa pode optar por atualizar um template existente para a versão mais nova do Dictionary, preservando a camada 3 (customizações próprias).
Tipo OTHERQuando o template é do tipo OTHER, a camada 2 fica vazia — toda especificidade vem da camada 3.

5. Fluxo 3 — Criação de um contrato#

Regras-chave da criação:
Credor obrigatório — pode ser a própria empresa (via Client espelho) ou outro Client (banco, cooperativa, fundo).
Todos os participantes devem ser Clients existentes na plataforma — o módulo não cria Clients.
O contrato é criado em status DRAFT e fica nesse estado até ser ativado explicitamente.
A ativação valida as pré-condições (mínimo de participantes, parcelas, etc.).

6. Fluxo 4 — Ciclo de vida do contrato#

Como o status muda — duas formas:
1.
Automaticamente via job programado (madrugada): o sistema lê o status das parcelas e atualiza o status do contrato.
2.
Manualmente via PUT /status: usuário (gestor) reconhece a situação e marca explicitamente (ex.: marca inadimplência antes do prazo automático).

7. Fluxo 5 — Ciclo de vida da parcela#

Regras de transição importantes:
O job de OVERDUE move parcelas PENDING ou PARTIALLY_PAID com dueDate ultrapassado para OVERDUE.
Quando uma parcela PARTIALLY_PAID vai para OVERDUE, o histórico de baixas anteriores é preservado (no campo receivedAmount acumulado).
O job de DEFAULTED lê o daysToDefault do contrato (configurável por contrato) e move parcelas em atraso há mais de N dias.
Se daysToDefault não estiver configurado no contrato, a transição automática para DEFAULTED não ocorre — só manual.

8. Fluxo 6 — Registro de uma baixa (recebimento)#

O conceito do "snapshot duplo":
CampoOrigemSignificado
calculatedInterestAmountSistemaJuros que o sistema calculou (baseado em dailyInterestPercentage × dias de atraso). Imutável.
chargedInterestAmountUsuárioJuros efetivamente cobrados. Pode ser igual ou diferente do calculado.
calculatedFineAmount / chargedFineAmountMesma lógicaMulta calculada vs. cobrada.
calculatedDiscountAmount / chargedDiscountAmountMesma lógicaDesconto calculado vs. concedido.
Esse modelo permite acordos comerciais (desconto da multa, perdão parcial de mora) sem perder a trilha de auditoria — o gestor sempre pode ver o que o sistema calculou e o que foi efetivamente cobrado.

9. Fluxo 7 — Cancelamento de uma baixa (correção de erro)#

Diferente de outros sistemas, não editamos uma baixa. Para corrigir um erro, cancelamos e criamos uma nova baixa correta.
Por que cancelar e não editar?
Auditoria preservada: todo movimento financeiro fica visível, mesmo cancelado. Útil para conferência interna, fiscalização e prestação de contas a terceiros.
Sem complexidade de "edição parcial": evita risco de inconsistência (ex.: alguém edita o valor mas esquece de recalcular encargos).
Padrão de mercado: ERPs financeiros como Senior, Protheus, Sankhya seguem esse modelo.

10. Fluxo 8 — Inadimplência e jobs programados#

O sistema combina transições automáticas (via jobs noturnos) e marcação manual (via gestor).
Quando usar manual vs. automático:
CenárioRecomendação
Cliente comunica formalmente que não vai pagar antes do prazo daysToDefaultManual — gestor marca DEFAULTED imediatamente.
Cliente apenas atrasou, ainda há expectativa de regularizaçãoDeixa o automático rodar — gestor não interfere.
Operação está em processo de renegociaçãoManual — gestor marca RENEGOTIATED quando o novo contrato é criado.
Erro operacional (parcela criada errada)Manual — gestor marca CANCELLED.

11. Fluxo 9 — Visão de Clientes na Carteira#

Quem é um cliente da carteira? Qualquer Client que aparece como DEBTOR em pelo menos um contrato não cancelado.
Pontos sobre o collectionStatus:
Calculado em tempo de leitura — não é armazenado. Sempre reflete o estado atual.
Derivado dos status das parcelas e contratos do cliente — sem configuração de limiar separada.
O job diário (Cliente → collectionStatus) avalia e detecta transições, emitindo eventos de domínio (ex.: cliente entrou em CRITICAL) para consumo futuro por módulos de cobrança/notificação.

12. Visão consolidada — Fluxo end-to-end#


13. Conceitos-chave#

13.1. Hierarquia + Visibilidade#

"Cada empresa organiza seus contratos em um ou mais portfolios (silos isolados, geralmente por safra, filial ou tipo de operação). Dentro de cada portfolio existem uma ou mais carteiras — é onde os contratos efetivamente vivem (por gestor, região, produto, etc.). Quem vê o quê é controlado por atribuição direta ao portfolio ou à carteira — não há mágica."

13.2. Templates flexíveis com snapshot#

"Cada tipo de contrato (CPR, CCB, duplicata) tem campos pré-definidos pela plataforma, e a empresa adiciona campos próprios conforme sua operação. Quando o template é criado, ele captura uma fotografia dos campos base — se a plataforma evoluir depois, contratos antigos continuam funcionando. A empresa decide quando atualizar."

13.3. Modelo de participantes flexível#

"Em vez de um único 'cliente', cada contrato tem participantes tipados: credores, devedores e garantidores. Suporta cessão, cofinanciamento, devedores solidários e avalistas — situações comuns em crédito agro."

13.4. Snapshot duplo nas baixas#

"Quando uma baixa é registrada, o sistema captura dois snapshots: o que ele calculou (multa, juros) e o que foi efetivamente cobrado. Isso permite registrar acordos comerciais (desconto, perdão de mora) sem perder rastreabilidade."

13.5. Sem editar, só cancelar#

"Baixas são imutáveis após criação. Para corrigir erros, cancela e cria nova — modelo padrão da indústria financeira. Garante auditoria completa."

13.6. Inadimplência híbrida#

"O sistema monitora automaticamente (job noturno) quando parcelas vencem, calcula encargos diariamente e propaga o status para o contrato. Em paralelo, o gestor pode intervir manualmente quando reconhece formalmente uma inadimplência ou registra uma renegociação."

13.7. Cliente na carteira em tempo real#

"A visão de clientes mostra quem deve, quanto deve, há quanto tempo. Calculado em tempo de leitura — sempre reflete o estado atual. Detecta transições (ex.: cliente entrou em CRITICAL) e fica pronto para integrar com módulos futuros de cobrança e notificação."

Modificado em 2026-06-02 14:59:53
Página anterior
Dicionário de campos base (Necessário validar)
Próxima página
Gestão da carteira
Built with