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

# Lerian field dictionary

> Explore the centralized dictionary of every field used across Lerian products — Midaz, Flowker, Pix, CRM, Fee, Auth, Reporter, and more.

This guide organizes every field used across the Lerian ecosystem into a single, reliable, and well-structured reference. It supports partners and development teams who need clarity and consistency across Midaz, Flowker, Identity, CRM, Fee, Pix, Auth, Reporter, and related plugins.

This dictionary helps you validate payloads, improve interoperability, streamline QA, and accelerate integration development.

## Why this dictionary matters

***

APIs evolve fast. New features, plugins, and versions bring new fields and behavior. This dictionary centralizes all definitions, making it easier to understand how our products communicate with each other.

Use it to:

* Build integrations with confidence
* Reduce ambiguity across workflows
* Validate payload structures
* Support QA, observability, and debugging
* Accelerate onboarding for new developers and partners

## How to use this page

***

Each section groups fields by semantic categories. Every field includes:

* Field name
* Description
* Where it is used across Lerian products

If you're working with a specific product, scroll down to find dedicated subsections for Flowker, Pix, Identity, Fees Engine, and Reporter.

<Danger>
  For strict schema validation, always check the official OpenAPI specifications. Those files reflect the exact structure required by each endpoint.
</Danger>

## Before you explore

***

This dictionary follows consistent conventions across all products.

* Dates use ISO 8601 or RFC3339 formats
* UUIDs follow v4 formatting
* Pix fields follow BACEN standards
* Workflow fields follow Flowker’s runtime and authoring semantics
* Fees Engine fields reflect the latest v2 model
* Metadata is always a flexible key-value

<Warning>
  If your integration uses sensitive operations like Pix, Identity, or Fees Engine, verify behavior and accepted formats directly in the product APIs. Some fields behave differently depending on the execution context.
</Warning>

## Structure of the dictionary

***

The dictionary is divided into the following categories:

<Columns cols={2}>
  <Card title="Core fields" icon="layer-group" href="/en/partners-hub/field-dictionary/fd-core-fields">
    Essential fields shared across all Lerian APIs, including identifiers, timestamps, pagination, and audit metadata.
  </Card>

  <Card title="People & Organizations" icon="users" href="/en/partners-hub/field-dictionary/fd-people-organizations">
    Fields that describe individuals, companies, users, groups, and organizational structures.
  </Card>

  <Card title="Financial data" icon="money-bills" href="/en/partners-hub/field-dictionary/fd-financial-data">
    Fields related to banking details, Pix operations, financial transactions, QR Codes, and operational limits.
  </Card>

  <Card title="Authentication & Security" icon="unlock-keyhole" href="/en/partners-hub/field-dictionary/fd-auth-security">
    Fields used for authentication, authorization, OAuth2 flows, webhook validation, and system health monitoring.
  </Card>

  <Card title="Workflows & Reporting" icon="signs-post" href="/en/partners-hub/field-dictionary/fd-workflows-reporting">
    Fields related to workflow orchestration (Flowker), reporting (Reporter), fee calculations, and error handling.
  </Card>

  <Card title="Tracer" icon="shield-check" href="/en/partners-hub/field-dictionary/fd-tracer">
    Fields for transaction validation, rules, spending limits, and decision responses.
  </Card>

  <Card title="Pix operations" icon="arrows-rotate" href="/en/partners-hub/field-dictionary/fd-pix-operations">
    Fields for Pix dispute resolution — claims, infraction reports, refund requests, and fraud markers.
  </Card>

  <Card title="Ledger operations" icon="scale-balanced" href="/en/partners-hub/field-dictionary/fd-ledger-operations">
    Fields for balances, transaction routes, operation routes, and metadata indexes.
  </Card>
</Columns>