> ## 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

> O dicionário centralizado dos campos usados nos produtos da Lerian: Midaz, seu CRM e Fees embutidos, Flowker, Pix, Auth, Reporter e plugins relacionados.

Este guia organiza os campos usados no ecossistema da Lerian em uma única referência. Ele apoia as equipes de engenharia que trabalham com o Midaz, seus componentes embutidos de CRM e Fees Engine, Flowker, Identity, Pix, Auth, Reporter e plugins relacionados.

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

## O que o dicionário cobre

***

Novos recursos, plugins e versões trazem novos campos e comportamentos. Este dicionário centraliza todas as definições, para que você veja como nossos produtos se comunicam entre si.

Use-o para:

* Criar integrações com confiança
* Reduzir a ambiguidade entre workflows
* Validar estruturas de payload
* Apoiar QA, observabilidade e depuração
* Acelerar o onboarding de novos desenvolvedores

## 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 da Lerian

Se você trabalha com um produto específico, abra a página do dicionário para essa área, listada em Estrutura do dicionário, abaixo.

> [!CAUTION]
>
> Para validação rigorosa de schema, sempre consulte as especificações oficiais do OpenAPI. Esses arquivos refletem a estrutura exata exigida por cada endpoint.

## Antes de explorar

***

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

* Datas usam os formatos ISO 8601 ou RFC3339
* Campos do Pix seguem os padrões do BACEN
* Campos de workflow seguem a semântica de runtime e criação do Flowker
* Campos do Fees Engine refletem o modelo v2 mais recente
* Metadados são sempre um par flexível de chave-valor

> [!WARNING]
>
> Se sua integração usa operações sensíveis como Pix, Identity ou Fees Engine, verifique o comportamento e os formatos aceitos diretamente nas APIs do produto. Alguns campos se comportam de forma diferente dependendo do contexto de execução.

## Estrutura do dicionário

***

O dicionário tem as seguintes categorias:

> [card] [Campos principais](https://docs.lerian.studio/pt/reference/field-dictionary/fd-core-fields.md)
>
> Campos essenciais compartilhados entre todas as APIs da Lerian, incluindo identificadores, timestamps, paginação e metadados de auditoria.

> [card] [Pessoas e organizações](https://docs.lerian.studio/pt/reference/field-dictionary/fd-people-organizations.md)
>
> Campos que descrevem indivíduos, empresas, usuários, grupos e estruturas organizacionais.

> [card] [Dados financeiros](https://docs.lerian.studio/pt/reference/field-dictionary/fd-financial-data.md)
>
> Campos relacionados a dados bancários, operações Pix, transações financeiras, QR Codes e limites operacionais.

> [card] [Autenticação e segurança](https://docs.lerian.studio/pt/reference/field-dictionary/fd-auth-security.md)
>
> Campos usados para autenticação, autorização, fluxos OAuth2, validação de webhook e monitoramento de saúde do sistema.

> [card] [Workflows e relatórios](https://docs.lerian.studio/pt/reference/field-dictionary/fd-workflows-reporting.md)
>
> Campos relacionados à orquestração de workflows (Flowker), relatórios (Reporter), cálculo de tarifas e tratamento de erros.

> [card] [Tracer](https://docs.lerian.studio/pt/reference/field-dictionary/fd-tracer.md)
>
> Campos para validação de transações, regras, limites de gastos e respostas de decisão.

> [card] [Operações Pix](https://docs.lerian.studio/pt/reference/field-dictionary/fd-pix-operations.md)
>
> Campos para resolução de disputas do Pix: reivindicações, relatos de infração, solicitações de devolução e marcadores de fraude.

> [card] [Operações de ledger](https://docs.lerian.studio/pt/reference/field-dictionary/fd-ledger-operations.md)
>
> Campos para saldos, rotas de transação, rotas de operação e índices de metadados.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.