Skip to main content
GET
Get accrual run

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Accrual run identifier.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

Resposta

OK

businessDate
string
obrigatório

Business date the run was executed for (YYYY-MM-DD, UTC).

Exemplo:

"2026-06-14"

correlationId
string
obrigatório

Correlation identifier linking the run to its journal lineage and downstream events. Not unique: several runs can share one.

Exemplo:

"accrual-run-2026-05-31"

createdAt
string
obrigatório

Creation timestamp (RFC3339, UTC).

Exemplo:

"2026-06-14T03:00:00Z"

id
string
obrigatório

Accrual run identifier (uuid).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

journalReferenceId
string
obrigatório

Journal reference (uuid) recording this run's posting lineage.

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

postingStatus
string
obrigatório

State of the downstream ledger posting. "pending" means the ledger has not confirmed it, "posted" means it accepted it, "no_items" means the run recognized nothing so nothing was sent.

Exemplo:

"pending"

status
string
obrigatório

Lifecycle status of the run.

Exemplo:

"queued"

updatedAt
string
obrigatório

Last update timestamp (RFC3339, UTC).

Exemplo:

"2026-06-14T03:05:00Z"

externalJournalReferenceId
string

Always omitted on a run: a run emits one posting per contract per competência per kind, so no single ledger transaction identifies it. The ledger's identifier is per posting — resolve one through GET /api/v1/journal-references with that posting's correlation identifier.