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

> Referencia de los campos fundamentales compartidos entre las APIs de Lerian: identificadores, marcas de tiempo del ciclo de vida, paginación y metadatos de trazabilidad.

Esta página consolida los campos fundamentales que aparecen en múltiples APIs de Lerian. Estos campos identifican datos, registran eventos del ciclo de vida, paginan resultados y garantizan la trazabilidad.

## 1. Identificadores únicos

***

| Campo          | Descripción                                      | Usado en                             |
| -------------- | ------------------------------------------------ | ------------------------------------ |
| id             | Identificador único universal (UUID v4)          | Midaz, CRM, Fee, Auth, Pix, Identity |
| accountId      | Identificador único de cuenta en el ledger       | Midaz, CRM, Pix                      |
| organizationId | Identificador de la organización propietaria     | Midaz, Fee                           |
| ledgerId       | Identificador único del ledger                   | Midaz, CRM, Fee                      |
| holderId       | Identificador del titular de la cuenta           | CRM                                  |
| transactionId  | Identificador único de la transacción financiera | Midaz, Pix                           |
| externalId     | ID de correlación para sistemas externos         | CRM, Pix                             |
| endToEndId     | Identificador end-to-end de Pix                  | Pix                                  |
| protocolId     | Identificador de protocolo DICT de Pix           | Pix                                  |
| segmentId      | Identificador de segmento organizacional         | Midaz, Fee                           |
| portfolioId    | Identificador de portafolio                      | Midaz                                |
| assetId        | Identificador de activo financiero               | Midaz                                |
| routeId        | Identificador de ruta de operación               | Midaz                                |
| templateId     | Identificador de plantilla                       | Reporter                             |
| jobId          | Identificador de trabajo de procesamiento        | Reporter                             |
| clientId       | Identificador de cliente OAuth2                  | Auth                                 |
| userId         | Identificador de usuario                         | Auth, Identity                       |
| groupId        | Identificador de grupo                           | Identity                             |
| roleId         | Identificador de rol                             | Identity                             |
| bankId         | Código de banco ISPB (8 dígitos)                 | Pix                                  |

## 2. Campos temporales (marcas de tiempo)

***

| Campo              | Descripción                                | Usado en                       |
| ------------------ | ------------------------------------------ | ------------------------------ |
| createdAt          | Marca de tiempo de creación (ISO 8601)     | Midaz, CRM, Fee, Pix, Identity |
| updatedAt          | Marca de tiempo de la última actualización | Midaz, CRM, Fee, Pix, Identity |
| deletedAt          | Marca de tiempo de eliminación lógica      | Midaz, CRM, Fee, Identity      |
| executedAt         | Marca de tiempo de ejecución efectiva      | Pix                            |
| scheduledAt        | Hora de ejecución programada               | Pix                            |
| expiresAt          | Marca de tiempo de expiración              | Pix, Auth                      |
| settledAt          | Marca de tiempo de liquidación financiera  | Pix                            |
| transactionAt      | Marca de tiempo de la transacción          | Pix                            |
| dueDate            | Fecha de vencimiento                       | Pix                            |
| birthDate          | Fecha de nacimiento (YYYY-MM-DD)           | CRM                            |
| foundingDate       | Fecha de fundación de la empresa           | CRM                            |
| accountOpeningDate | Fecha de apertura de cuenta                | Pix                            |
| timestamp          | Marca de tiempo genérica del evento        | Auth, JD Mock                  |
| uptime             | Tiempo de actividad del sistema            | Pix, JD Mock                   |

\| lastLoginAt        | Marca de tiempo del último inicio de sesión           | Identity                                |
\| lastActivityAt     | Marca de tiempo de la última actividad     | Identity                                |

## 3. Paginación y navegación

***

***

| Campo | Descripción                               | Usado en             |
| ----- | ----------------------------------------- | -------------------- |
| limit | Elementos por página (predeterminado: 10) | Midaz, CRM, Fee, Pix |
| page  | Página actual                             | Midaz, CRM, Fee      |

\| total          | Número total de elementos           | Midaz, CRM, Fee               |
\| items          | Elementos en la página actual       | Midaz, CRM, Fee               |
\| sortOrder      | Dirección de ordenamiento: `ASC` o `DESC` (predeterminado `DESC`) | Flowker            |

\| includeDeleted | Incluir elementos eliminados lógicamente | CRM                           |
\| hardDelete     | Solicita la eliminación sujeta a la política de retención y cumplimiento | CRM                           |

## 4. Metadatos de control y auditoría

***

| Campo       | Descripción                              | Usado en     |
| ----------- | ---------------------------------------- | ------------ |
| version     | Versión del recurso o de la API          | Pix, JD Mock |
| environment | Entorno (prod/dev/stage)                 | Pix, JD Mock |
| traceId     | Identificador de traza de log            | Pix          |
| createdBy   | Usuario creador                          | Identity     |
| updatedBy   | Usuario que hizo la última actualización | Identity     |
| deletedBy   | Usuario que eliminó el recurso           | Identity     |
