> ## 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 represent the backbone of how we 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, Flowker, Pix, Identity |
| accountId       | Unique account identifier in the ledger   | Midaz, CRM, Pix                               |
| organizationId  | Identifier of the owning organization     | Midaz, Fee, Flowker                           |
| org\_id         | Organization ID (workflow context)        | Flowker                                       |
| 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, Flowker                             |
| 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, Flowker                             |
| workflowId      | Workflow identifier                       | Flowker                                       |
| runId           | Workflow execution identifier             | Flowker                                       |
| jobId           | Processing job identifier                 | Flowker, Reporter                             |
| tenantId        | Tenant identifier in multi-tenant systems | Flowker                                       |
| clientId        | OAuth2 client identifier                  | Auth, Flowker                                 |
| userId          | User identifier                           | Auth, Identity                                |
| groupId         | Group identifier                          | Identity                                      |
| roleId          | Role identifier                           | Identity                                      |
| bankId          | ISPB bank code (8 digits)                 | Pix                                           |
| providerId      | Provider identifier (OAuth2)              | Flowker                                       |
| batchId         | Processing batch identifier               | Flowker                                       |
| keyId           | API key identifier                        | Flowker                                       |
| versionId       | Version identifier                        | Flowker                                       |
| targetVersionId | Target version identifier (comparison)    | Flowker                                       |

## 2. Temporal fields (timestamps)

***

| Field              | Description                    | Used in                                 |
| ------------------ | ------------------------------ | --------------------------------------- |
| createdAt          | Creation timestamp (ISO 8601)  | Midaz, CRM, Fee, Pix, Flowker, Identity |
| updatedAt          | Last update timestamp          | Midaz, CRM, Fee, Pix, Flowker, Identity |
| deletedAt          | Logical deletion timestamp     | Midaz, CRM, Fee, Identity               |
| executedAt         | Effective execution timestamp  | Pix, Flowker                            |
| scheduledAt        | Scheduled execution time       | Pix, Flowker                            |
| 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, Flowker                  |
| uptime             | System uptime                  | Pix, JD Mock                            |
| startDate          | Start date (RFC3339)           | Flowker                                 |
| endDate            | End date (RFC3339)             | Flowker                                 |
| startTimeFrom      | Workflow search start time     | Flowker                                 |
| startTimeTo        | Workflow search end time       | Flowker                                 |
| 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, Flowker |
| page           | Current page                                                | Midaz, CRM, Fee               |
| page\_size     | Page size (workflow search)                                 | Flowker                       |
| page\_token    | Pagination token                                            | Flowker                       |
| offset         | Pagination offset                                           | Flowker                       |
| total          | Total number of items                                       | Midaz, CRM, Fee               |
| items          | Items in the current page                                   | Midaz, CRM, Fee               |
| sortOrder      | Sort order (asc/desc)                                       | CRM                           |
| sort\_by       | Sort field                                                  | Flowker                       |
| sort\_order    | Sort order (asc/desc)                                       | Flowker                       |
| includeDeleted | Include logically deleted items                             | CRM                           |
| hardDelete     | Requests removal subject to retention and compliance policy | CRM                           |
| search         | Search term                                                 | Flowker                       |

## 4. Control and audit metadata

***

| Field         | Description                   | Used in               |
| ------------- | ----------------------------- | --------------------- |
| version       | Resource or API version       | Pix, JD Mock, Flowker |
| environment   | Environment (prod/dev/stage)  | Pix, JD Mock          |
| traceId       | Log trace identifier          | Pix, Flowker          |
| correlationId | Cross-service correlation ID  | Flowker               |
| retryCount    | Retry counter                 | Flowker               |
| maxRetries    | Maximum number of retries     | Flowker               |
| backoffDelay  | Exponential retry delay       | Flowker               |
| createdBy     | Creator user                  | Identity              |
| updatedBy     | Last updater user             | Identity              |
| deletedBy     | User who deleted the resource | Identity              |