Campos principais - Lerian

Esta página reúne os campos fundamentais que aparecem em várias APIs da Lerian. Esses campos identificam dados, rastreiam eventos do ciclo de vida, paginam resultados e garantem rastreabilidade.

1. Identificadores únicos

Campo	Descrição	Usado em
id	Identificador único universal (UUID v4)	Midaz, CRM, Fee, Auth, Pix, Identity
accountId	Identificador único da conta no ledger	Midaz, CRM, Pix
organizationId	Identificador da organização proprietária	Midaz, Fee
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
endToEndId	Identificador end-to-end do Pix	Pix
protocolId	Identificador de protocolo DICT do 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
jobId	Identificador de job de processamento	Reporter
clientId	Identificador de cliente OAuth2	Auth
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

2. Campos temporais (timestamps)

Campo	Descrição	Usado em
createdAt	Timestamp de criação (ISO 8601)	Midaz, CRM, Fee, Pix, Identity
updatedAt	Timestamp da última atualização	Midaz, CRM, Fee, Pix, Identity
deletedAt	Timestamp de exclusão lógica	Midaz, CRM, Fee, Identity
executedAt	Timestamp efetivo de execução	Pix
scheduledAt	Horário de execução agendado	Pix
expiresAt	Timestamp de expiração	Pix, Auth
settledAt	Timestamp de liquidação financeira	Pix
transactionAt	Timestamp da transação	Pix
dueDate	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 genérico do evento	Auth, JD Mock
uptime	Tempo de atividade do sistema	Pix, JD Mock

| 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
page	Página atual	Midaz, CRM, Fee

| total | Número total de itens | Midaz, CRM, Fee | | items | Itens na página atual | Midaz, CRM, Fee | | sortOrder | Direção de ordenação: ASC ou DESC (padrão DESC) | Flowker | | includeDeleted | Incluir itens excluídos logicamente | CRM | | hardDelete | Solicita remoção sujeita à política de retenção e conformidade | CRM |

4. Metadados de controle e auditoria

Campo	Descrição	Usado em
version	Versão do recurso ou da API	Pix, JD Mock
environment	Ambiente (prod/dev/stage)	Pix, JD Mock
traceId	Identificador de rastreamento de log	Pix
createdBy	Usuário criador	Identity
updatedBy	Usuário que fez a última atualização	Identity
deletedBy	Usuário que excluiu o recurso	Identity