v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Accounting

Get journal reference by id

Returns journal/outbox reference data by journal reference ID.

get/api/v1/journal-references/{id}

Path parameters

idstring uuid required

Journal reference identifier.

Response

correlationIdstring required

Correlation identifier the reference was resolved by, linking it to the originating run.

externalJournalReferenceIdstring

Reference ID assigned by the external ledger/journal system; omitted until posting has been acknowledged.

idstring required

UUID of the journal reference record.

outboxEventIdstring

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

postingStatusstring required

Status of the downstream ledger posting for this reference (e.g. pending, posted).

Example response

{
  "correlationId": "550e8400-e29b-41d4-a716-446655440007",
  "id": "550e8400-e29b-41d4-a716-446655440006",
  "outboxEventId": "550e8400-e29b-41d4-a716-446655440008",
  "postingStatus": "posted"
}