Journal Entries

Get a journal entry

Retrieve a journal entry by ID, including its double-entry postings.

get/v1/journal-entries/{journal_entry_id}

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/journal-entries/{journal_entry_id}
  • Auth: HTTP bearer

Path parameters

journal_entry_idstring uuid required

The journal entry's id.

Response

Journal entry with postings

action_type'CREDIT' | 'DEBIT' | 'TRANSFER' | 'HOLD' | 'RELEASE' | 'FORFEIT' | 'EXPIRATION' | 'REDEMPTION' | 'REVERSAL' | 'BURN' | 'FUND' | 'ADJUSTMENT' | 'MATURITY' | 'VOID_PENDING'

The kind of ledger action the entry records. A manual adjustment is a CREDIT or DEBIT; no operation creates ADJUSTMENT entries.

created_atstring date-time

When this entry was created (RFC 3339)

descriptionstring

Human-readable explanation of the entry's purpose

entry_hashstring

SHA-256 hash sealing this entry into the organization's hash chain

event_idstring uuid

Event that triggered this entry (null if created via direct API call)

idstring uuid

Unique identifier for this journal entry

program_idstring uuid

Program this entry belongs to

program_namestring

The name of the program the entry ran under.

reference_idstring

Correlation ID linking holds to releases

rule_idstring uuid

Rule that triggered this entry. It is null for direct API calls and for entries Scrip creates itself.

Example response

{
  "action_type": "HOLD",
  "created_at": "2027-01-15T10:30:00Z",
  "description": "Purchase reward: 10 POINTS",
  "entry_hash": "b3a1d9f8c2e4a7b6d1e3f5a8c9b2d4e6f7a1b3c5d7e9f2a4b6c8d0e1f3a5b7c9",
  "event_id": "e5dc1b6a-7f3d-4e2a-8c1b-9a0f4d7e6c05",
  "id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
  "postings": [
    {
      "amount": "100.00",
      "asset_symbol": "POINTS",
      "bucket": "AVAILABLE",
      "created_at": "2027-01-15T10:30:00Z",
      "entity_type": "PARTICIPANT",
      "group_id": "0b9e7d3c-5a41-4f68-a2c7-81e4d6b3f907",
      "id": "8c1e3a5b-7d92-4f04-a6b8-d0f2c4e6a826",
      "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01"
    }
  ],
  "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
  "program_name": "Q1 Sales Bonus",
  "reference_id": "auth_12345",
  "rule_id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03"
}

Changes

No recorded changes to this operation across all 1 revision of this API.