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

# Campos principais

> Consulte os campos fundamentais compartilhados entre APIs Lerian — identificadores, timestamps de ciclo de vida, paginação e rastreabilidade.

Esta página consolida os campos fundamentais que aparecem em várias APIs Lerian. Esses campos representam a espinha dorsal de como identificamos dados, rastreamos eventos de ciclo de vida, paginamos resultados e garantimos rastreabilidade.

## 1. Identificadores únicos

***

| Campo           | Descrição                                        | Usado em                                      |
| --------------- | ------------------------------------------------ | --------------------------------------------- |
| id              | Identificador único universal (UUID v4)          | Midaz, CRM, Fee, Auth, Flowker, PIX, Identity |
| accountId       | Identificador único da conta no ledger           | Midaz, CRM, PIX                               |
| organizationId  | Identificador da organização proprietária        | Midaz, Fee, Flowker                           |
| org\_id         | ID da organização (contexto workflow)            | Flowker                                       |
| ledgerId        | Identificador único do ledger                    | Midaz, CRM, Fee                               |
| holderId        | Identificador do titular da conta                | CRM                                           |
| transactionId   | Identificador único da transação financeira      | Midaz, PIX                                    |
| externalId      | ID de correlação para sistemas externos          | CRM, PIX, Flowker                             |
| endToEndId      | Identificador PIX ponta a ponta                  | PIX                                           |
| protocolId      | Identificador de protocolo DICT PIX              | PIX                                           |
| segmentId       | Identificador de segmento organizacional         | Midaz, Fee                                    |
| portfolioId     | Identificador de portfólio                       | Midaz                                         |
| assetId         | Identificador de ativo financeiro                | Midaz                                         |
| routeId         | Identificador de rota de operação                | Midaz                                         |
| templateId      | Identificador de template                        | Reporter, Flowker                             |
| workflowId      | Identificador de workflow                        | Flowker                                       |
| runId           | Identificador de execução de workflow            | Flowker                                       |
| jobId           | Identificador de job de processamento            | Flowker, Reporter                             |
| tenantId        | Identificador de tenant em sistemas multi-tenant | Flowker                                       |
| clientId        | Identificador de cliente OAuth2                  | Auth, Flowker                                 |
| userId          | Identificador de usuário                         | Auth, Identity                                |
| groupId         | Identificador de grupo                           | Identity                                      |
| roleId          | Identificador de papel                           | Identity                                      |
| bankId          | Código ISPB do banco (8 dígitos)                 | PIX                                           |
| providerId      | Identificador de provider (OAuth2)               | Flowker                                       |
| batchId         | Identificador de lote de processamento           | Flowker                                       |
| keyId           | Identificador de chave API                       | Flowker                                       |
| versionId       | Identificador de versão                          | Flowker                                       |
| targetVersionId | Identificador de versão alvo (comparação)        | Flowker                                       |

## 2. Campos temporais (timestamps)

***

| Campo              | Descrição                          | Usado em                                |
| ------------------ | ---------------------------------- | --------------------------------------- |
| createdAt          | Timestamp de criação (ISO 8601)    | Midaz, CRM, Fee, PIX, Flowker, Identity |
| updatedAt          | Timestamp da última atualização    | Midaz, CRM, Fee, PIX, Flowker, Identity |
| deletedAt          | Timestamp de deleção lógica        | Midaz, CRM, Fee, Identity               |
| executedAt         | Timestamp de execução efetiva      | PIX, Flowker                            |
| scheduledAt        | Hora de execução agendada          | PIX, Flowker                            |
| expiresAt          | Timestamp de expiração             | PIX, Auth                               |
| settledAt          | Timestamp de liquidação financeira | PIX                                     |
| transactionAt      | Timestamp da transação             | PIX                                     |
| dueDate            | Data de vencimento                 | PIX                                     |
| birthDate          | Data de nascimento (YYYY-MM-DD)    | CRM                                     |
| foundingDate       | Data de fundação da empresa        | CRM                                     |
| accountOpeningDate | Data de abertura da conta          | PIX                                     |
| timestamp          | Timestamp de evento genérico       | Auth, JD Mock, Flowker                  |
| uptime             | Tempo de atividade do sistema      | PIX, JD Mock                            |
| startDate          | Data de início (RFC3339)           | Flowker                                 |
| endDate            | Data de fim (RFC3339)              | Flowker                                 |
| startTimeFrom      | Tempo de início da busca workflow  | Flowker                                 |
| startTimeTo        | Tempo de fim da busca workflow     | Flowker                                 |
| lastLoginAt        | Timestamp do último login          | Identity                                |
| lastActivityAt     | Timestamp da última atividade      | Identity                                |

## 3. Paginação e navegação

***

***

| Campo          | Descrição                                                        | Usado em                      |
| -------------- | ---------------------------------------------------------------- | ----------------------------- |
| limit          | Itens por página (padrão: 10)                                    | Midaz, CRM, Fee, PIX, Flowker |
| page           | Página atual                                                     | Midaz, CRM, Fee               |
| page\_size     | Tamanho da página (busca workflow)                               | Flowker                       |
| page\_token    | Token de paginação                                               | Flowker                       |
| offset         | Offset de paginação                                              | Flowker                       |
| total          | Número total de itens                                            | Midaz, CRM, Fee               |
| items          | Itens na página atual                                            | Midaz, CRM, Fee               |
| sortOrder      | Ordem de classificação (asc/desc)                                | CRM                           |
| sort\_by       | Campo de classificação                                           | Flowker                       |
| sort\_order    | Ordem de classificação (asc/desc)                                | Flowker                       |
| includeDeleted | Incluir itens deletados logicamente                              | CRM                           |
| hardDelete     | Solicita a remoção sujeita à política de retenção e conformidade | CRM                           |
| search         | Termo de busca                                                   | Flowker                       |

## 4. Metadados de controle e auditoria

***

| Campo         | Descrição                       | Usado em              |
| ------------- | ------------------------------- | --------------------- |
| version       | Versão do recurso ou API        | PIX, JD Mock, Flowker |
| environment   | Ambiente (prod/dev/stage)       | PIX, JD Mock          |
| traceId       | Identificador de trace de log   | PIX, Flowker          |
| correlationId | ID de correlação entre serviços | Flowker               |
| retryCount    | Contador de tentativas          | Flowker               |
| maxRetries    | Número máximo de tentativas     | Flowker               |
| backoffDelay  | Delay de retry exponencial      | Flowker               |
| createdBy     | Usuário criador                 | Identity              |
| updatedBy     | Usuário da última atualização   | Identity              |
| deletedBy     | Usuário que deletou o recurso   | Identity              |