Pular para o conteúdo principal
GET
Get journal reference by id

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Journal reference identifier.

Resposta

OK

correlationId
string
obrigatório

Correlation identifier the reference was resolved by. For an accrual run it links the reference to the originating run; for a single acknowledged posting it is that posting's key, which is the same value the ledger carries in the transaction's correlationId metadata.

Exemplo:

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

id
string
obrigatório

UUID of the journal reference record.

Exemplo:

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

postingStatus
string
obrigatório

Status of the downstream ledger posting for this reference. "pending" means the ledger has not confirmed it yet, "posted" means the ledger accepted it, and "no_items" means the run recorded no recognition, so no posting was sent.

Exemplo:

"posted"

externalJournalReferenceId
string

The external ledger's own identifier for the transaction this posting became — the reconciliation key, usable to look the transaction up in the ledger directly. Omitted until the posting has been acknowledged, and always omitted on an accrual RUN reference, whose grain is many postings rather than one. A 404 on this endpoint is not proof the posting never happened: it also covers a posting intent that has not been relayed successfully yet, which is then either still in flight or quarantined on its outbox event.

outboxEventId
string

UUID of the emitted outbox event; omitted when no outbox event was recorded.

Exemplo:

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