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

# Core fields

> Reference the foundational fields shared across Lerian APIs: identifiers, lifecycle timestamps, pagination, and traceability metadata.

This page consolidates the foundational fields that appear across multiple Lerian APIs. These fields identify data, track lifecycle events, paginate results, and guarantee traceability.

## 1. Unique identifiers

***

| Field          | Description                             | Used in                              |
| -------------- | --------------------------------------- | ------------------------------------ |
| id             | Universal unique identifier (UUID v4)   | Midaz, CRM, Fee, Auth, Pix, Identity |
| accountId      | Unique account identifier in the ledger | Midaz, CRM, Pix                      |
| organizationId | Identifier of the owning organization   | Midaz, Fee                           |
| ledgerId       | Unique ledger identifier                | Midaz, CRM, Fee                      |
| holderId       | Identifier of the account holder        | CRM                                  |
| transactionId  | Unique financial transaction identifier | Midaz, Pix                           |
| externalId     | Correlation ID for external systems     | CRM, Pix                             |
| endToEndId     | Pix end-to-end identifier               | Pix                                  |
| protocolId     | DICT Pix protocol identifier            | Pix                                  |
| segmentId      | Organizational segment identifier       | Midaz, Fee                           |
| portfolioId    | Portfolio identifier                    | Midaz                                |
| assetId        | Financial asset identifier              | Midaz                                |
| routeId        | Operation route identifier              | Midaz                                |
| templateId     | Template identifier                     | Reporter                             |
| jobId          | Processing job identifier               | Reporter                             |
| clientId       | OAuth2 client identifier                | Auth                                 |
| userId         | User identifier                         | Auth, Identity                       |
| groupId        | Group identifier                        | Identity                             |
| roleId         | Role identifier                         | Identity                             |
| bankId         | ISPB bank code (8 digits)               | Pix                                  |

## 2. Temporal fields (timestamps)

***

| Field              | Description                    | Used in                        |
| ------------------ | ------------------------------ | ------------------------------ |
| createdAt          | Creation timestamp (ISO 8601)  | Midaz, CRM, Fee, Pix, Identity |
| updatedAt          | Last update timestamp          | Midaz, CRM, Fee, Pix, Identity |
| deletedAt          | Logical deletion timestamp     | Midaz, CRM, Fee, Identity      |
| executedAt         | Effective execution timestamp  | Pix                            |
| scheduledAt        | Scheduled execution time       | Pix                            |
| expiresAt          | Expiration timestamp           | Pix, Auth                      |
| settledAt          | Financial settlement timestamp | Pix                            |
| transactionAt      | Transaction timestamp          | Pix                            |
| dueDate            | Due date                       | Pix                            |
| birthDate          | Date of birth (YYYY-MM-DD)     | CRM                            |
| foundingDate       | Company founding date          | CRM                            |
| accountOpeningDate | Account opening date           | Pix                            |
| timestamp          | Generic event timestamp        | Auth, JD Mock                  |
| uptime             | System uptime                  | Pix, JD Mock                   |

\| lastLoginAt        | Last login timestamp           | Identity                                |
\| lastActivityAt     | Last activity timestamp        | Identity                                |

## 3. Pagination and navigation

***

***

| Field | Description                  | Used in              |
| ----- | ---------------------------- | -------------------- |
| limit | Items per page (default: 10) | Midaz, CRM, Fee, Pix |
| page  | Current page                 | Midaz, CRM, Fee      |

\| total          | Total number of items           | Midaz, CRM, Fee               |
\| items          | Items in the current page       | Midaz, CRM, Fee               |
\| sortOrder      | Sort direction: `ASC` or `DESC` (default `DESC`) | Flowker            |

\| includeDeleted | Include logically deleted items | CRM                           |
\| hardDelete     | Requests removal subject to retention and compliance policy | CRM                           |

## 4. Control and audit metadata

***

| Field       | Description                   | Used in      |
| ----------- | ----------------------------- | ------------ |
| version     | Resource or API version       | Pix, JD Mock |
| environment | Environment (prod/dev/stage)  | Pix, JD Mock |
| traceId     | Log trace identifier          | Pix          |
| createdBy   | Creator user                  | Identity     |
| updatedBy   | Last updater user             | Identity     |
| deletedBy   | User who deleted the resource | Identity     |