Skip to main content
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


CampoDescriçãoUsado em
idIdentificador único universal (UUID v4)Midaz, CRM, Fee, Auth, Flowker, PIX, Identity
accountIdIdentificador único da conta no ledgerMidaz, CRM, PIX
organizationIdIdentificador da organização proprietáriaMidaz, Fee, Flowker
org_idID da organização (contexto workflow)Flowker
ledgerIdIdentificador único do ledgerMidaz, CRM, Fee
holderIdIdentificador do titular da contaCRM
transactionIdIdentificador único da transação financeiraMidaz, PIX
externalIdID de correlação para sistemas externosCRM, PIX, Flowker
endToEndIdIdentificador PIX ponta a pontaPIX
protocolIdIdentificador de protocolo DICT PIXPIX
segmentIdIdentificador de segmento organizacionalMidaz, Fee
portfolioIdIdentificador de portfólioMidaz
assetIdIdentificador de ativo financeiroMidaz
routeIdIdentificador de rota de operaçãoMidaz
templateIdIdentificador de templateReporter, Flowker
workflowIdIdentificador de workflowFlowker
runIdIdentificador de execução de workflowFlowker
jobIdIdentificador de job de processamentoFlowker, Reporter
tenantIdIdentificador de tenant em sistemas multi-tenantFlowker
clientIdIdentificador de cliente OAuth2Auth, Flowker
userIdIdentificador de usuárioAuth, Identity
groupIdIdentificador de grupoIdentity
roleIdIdentificador de papelIdentity
bankIdCódigo ISPB do banco (8 dígitos)PIX
providerIdIdentificador de provider (OAuth2)Flowker
batchIdIdentificador de lote de processamentoFlowker
keyIdIdentificador de chave APIFlowker
versionIdIdentificador de versãoFlowker
targetVersionIdIdentificador de versão alvo (comparação)Flowker

2. Campos temporais (timestamps)


CampoDescriçãoUsado em
createdAtTimestamp de criação (ISO 8601)Midaz, CRM, Fee, PIX, Flowker, Identity
updatedAtTimestamp da última atualizaçãoMidaz, CRM, Fee, PIX, Flowker, Identity
deletedAtTimestamp de deleção lógicaMidaz, CRM, Fee, Identity
executedAtTimestamp de execução efetivaPIX, Flowker
scheduledAtHora de execução agendadaPIX, Flowker
expiresAtTimestamp de expiraçãoPIX, Auth
settledAtTimestamp de liquidação financeiraPIX
transactionAtTimestamp da transaçãoPIX
dueDateData de vencimentoPIX
birthDateData de nascimento (YYYY-MM-DD)CRM
foundingDateData de fundação da empresaCRM
accountOpeningDateData de abertura da contaPIX
timestampTimestamp de evento genéricoAuth, JD Mock, Flowker
uptimeTempo de atividade do sistemaPIX, JD Mock
startDateData de início (RFC3339)Flowker
endDateData de fim (RFC3339)Flowker
startTimeFromTempo de início da busca workflowFlowker
startTimeToTempo de fim da busca workflowFlowker
lastLoginAtTimestamp do último loginIdentity
lastActivityAtTimestamp da última atividadeIdentity

3. Paginação e navegação



CampoDescriçãoUsado em
limitItens por página (padrão: 10)Midaz, CRM, Fee, PIX, Flowker
pagePágina atualMidaz, CRM, Fee
page_sizeTamanho da página (busca workflow)Flowker
page_tokenToken de paginaçãoFlowker
offsetOffset de paginaçãoFlowker
totalNúmero total de itensMidaz, CRM, Fee
itemsItens na página atualMidaz, CRM, Fee
sortOrderOrdem de classificação (asc/desc)CRM
sort_byCampo de classificaçãoFlowker
sort_orderOrdem de classificação (asc/desc)Flowker
includeDeletedIncluir itens deletados logicamenteCRM
hardDeleteDeleção física permanenteCRM
searchTermo de buscaFlowker

4. Metadados de controle e auditoria


CampoDescriçãoUsado em
versionVersão do recurso ou APIPIX, JD Mock, Flowker
environmentAmbiente (prod/dev/stage)PIX, JD Mock
traceIdIdentificador de trace de logPIX, Flowker
correlationIdID de correlação entre serviçosFlowker
retryCountContador de tentativasFlowker
maxRetriesNúmero máximo de tentativasFlowker
backoffDelayDelay de retry exponencialFlowker
createdByUsuário criadorIdentity
updatedByUsuário da última atualizaçãoIdentity
deletedByUsuário que deletou o recursoIdentity