> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Dicionário de campos da Lerian

> Explore o dicionário centralizado de todos os campos usados nos produtos Lerian — Midaz, Flowker, PIX, CRM, Fee, Auth, Reporter e outros.

Este guia organiza todos os campos usados no ecossistema Lerian em uma referência única, confiável e fácil de navegar. Ele apoia parceiros e equipes de desenvolvimento que precisam de clareza e consistência entre Midaz, Flowker, Identity, CRM, Fee, PIX, Auth, Reporter e plugins relacionados.

Este dicionário ajuda você a validar payloads, melhorar a interoperabilidade, otimizar o QA e acelerar o desenvolvimento de integrações.

## Por que este dicionário importa

***

APIs evoluem rapidamente. Novos recursos, plugins e versões trazem novos campos e comportamentos. Este dicionário centraliza todas as definições, facilitando o entendimento de como nossos produtos se comunicam entre si.

Use-o para:

* Construir integrações com confiança
* Reduzir ambiguidade entre fluxos de trabalho
* Validar estruturas de payload
* Apoiar QA, observabilidade e debugging
* Acelerar o onboarding de novos desenvolvedores e parceiros

## Como usar esta página

***

Cada seção agrupa campos por categorias semânticas. Cada campo inclui:

* Nome do campo
* Descrição
* Onde é usado nos produtos Lerian

Se você está trabalhando com um produto específico, role para baixo para encontrar subseções dedicadas para Flowker, PIX, Identity, Fees Engine e Reporter.

<Danger>
  Para validação estrita de schema, sempre verifique as especificações oficiais OpenAPI. Esses arquivos refletem a estrutura exata exigida por cada endpoint.
</Danger>

## Antes de explorar

***

Este dicionário segue convenções consistentes em todos os produtos.

* Datas usam formatos ISO 8601 ou RFC3339
* UUIDs seguem formatação v4
* Campos PIX seguem padrões do BACEN
* Campos de workflow seguem a semântica de runtime e autoria do Flowker
* Campos do Fees Engine refletem o modelo v2 mais recente
* Metadata é sempre um par chave-valor flexível

<Warning>
  Se sua integração usa operações sensíveis como PIX, Identity ou Fees Engine, verifique o comportamento e formatos aceitos diretamente nas APIs do produto. Alguns campos se comportam diferentemente dependendo do contexto de execução.
</Warning>

## Estrutura do dicionário

***

O dicionário está dividido nas seguintes categorias:

<Columns cols={2}>
  <Card title="Campos principais" icon="layer-group" href="/pt/partners-hub/field-dictionary/fd-core-fields">
    Campos essenciais compartilhados em todas as APIs Lerian, incluindo identificadores, timestamps, paginação e metadados de auditoria.
  </Card>

  <Card title="Pessoas e organizações" icon="users" href="/pt/partners-hub/field-dictionary/fd-people-organizations">
    Campos que descrevem indivíduos, empresas, usuários, grupos e estruturas organizacionais.
  </Card>

  <Card title="Dados financeiros" icon="money-bills" href="/pt/partners-hub/field-dictionary/fd-financial-data">
    Campos relacionados a detalhes bancários, operações PIX, transações financeiras, QR Codes e limites operacionais.
  </Card>

  <Card title="Autenticação e segurança" icon="unlock-keyhole" href="/pt/partners-hub/field-dictionary/fd-auth-security">
    Campos usados para autenticação, autorização, fluxos OAuth2, validação de webhooks e monitoramento de saúde do sistema.
  </Card>

  <Card title="Workflows e relatórios" icon="signs-post" href="/pt/partners-hub/field-dictionary/fd-workflows-reporting">
    Campos relacionados à orquestração de workflows (Flowker), relatórios (Reporter), cálculos de tarifas e tratamento de erros.
  </Card>

  <Card title="Tracer" icon="shield-check" href="/pt/partners-hub/field-dictionary/fd-tracer">
    Campos para validação de transações, regras, limites de gastos e respostas de decisão.
  </Card>

  <Card title="Operações PIX" icon="arrows-rotate" href="/pt/partners-hub/field-dictionary/fd-pix-operations">
    Campos para resolução de disputas PIX — reivindicações, relatórios de infração, solicitações de reembolso e marcadores de fraude.
  </Card>

  <Card title="Operações de ledger" icon="scale-balanced" href="/pt/partners-hub/field-dictionary/fd-ledger-operations">
    Campos para saldos, rotas de transação, rotas de operação e índices de metadados.
  </Card>
</Columns>
