Sign in
Ledger Entries

Get ledger entry by ID

Changed on

Returns a single ledger entry.

get/api/ledger-entries/{id}

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/ledger-entries/{id}
  • Auth: none required

Path parameters

idstring uuid required

Ledger entry ID

Response

Ledger entry

account_holder_idstring uuid required
amountinteger required

Amount in minor currency units (e.g. cents for USD). Must be >= 0.

currencystring required

ISO 4217 three-letter currency code — inherited from LedgerAccount → Ledger.

entry_datestring date nullable

ISO 20022 ValDt — value/settlement date

entry_type'credit' | 'debit' required
external_entry_idstring nullable

Opaque external SoE identifier (upsert identity)

idstring uuid
inserted_atstring date-time
ledger_account_idstring uuid required
rejected_codestring nullable

e.g. LIMIT_EXCEEDED.

rejected_direction'debit' | 'credit' nullable
rejected_ledger_account_idstring uuid nullable

LedgerAccount whose control limit was breached (NULL unless rejected).

rejected_period'daily' | 'weekly' | 'monthly' | 'yearly' nullable
rejected_rulestring nullable

Rule that set the breached cap.

status'pending' | 'posted' | 'reversed' | 'voided' nullable
tenant_idstring uuid
updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "amount": 0,
  "currency": "",
  "entry_date": "2020-04-20",
  "entry_type": "credit",
  "external_entry_id": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "ledger_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "limits_at_entry": [
    null
  ],
  "rejected_code": "",
  "rejected_direction": "debit",
  "rejected_ledger_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "rejected_period": "daily",
  "rejected_rule": "",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status