Get a ledger entry | The Penny Inc

{
  "ledger_entry_id": "ledger_entry_01937394-e0a9-7dfe-8071-e0a9dfe07161",
  "direction": "debit",
  "currency": "USD",
  "available_balance_change": "100.00",
  "total_balance_change": "100.00",
  "applied_time": "2024-01-15T10:30:00Z",
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
  "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
  "program_id": "program_019377de-7f88-7f02-894f-7f88f0294fcb",
  "type": "payment",
  "channel": "internal",
  "source": {
    "transaction_id": "transaction_01937a7d-ad6b-77ca-8046-ad6b7ca046ce",
    "transaction_stage": 1,
    "transaction_event_id": "transaction_event_01937dd5-0f62-7e20-810f-0f62e2010f7d"
  },
  "account_id": "account_019372e3-b8dc-7de2-80b6-b8dcde20b6c9",
  "control_account_id": "account_019372e3-b8dc-7de2-80b6-b8dcde20b6c9"
}

Retrieve a ledger entry by its ID.

Required permissions: ledger:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

ledger_entry_idstringRequired

The ID of the ledger entry.

Response

The ledger entry.

ledger_entry_idstring

Unique identifier for this ledger entry.

directionenum

Direction of the ledger entry. A debit represents value deducted from the account, while a credit represents value added to the account.

Allowed values:

currencyenum

ISO 4217 currency code for the monetary values represented by this ledger entry.

Allowed values:

available_balance_changestringformat: "^-?\d+(\.\d+)?$"

Amount applied to the account's available balance by this ledger entry. The available balance represents funds currently available for use.

total_balance_changestringformat: "^-?\d+(\.\d+)?$"

Amount applied to the account's total balance by this ledger entry. The total balance includes all funds recorded against the account, including amounts that may not yet be available for use.

applied_timedatetime

Date and time at which the ledger entry was applied to the account's balances, represented as an ISO 8601 timestamp.

business_idstring

Unique identifier of the business associated with this ledger entry.

business_entity_idstring

Unique identifier of the business entity associated with this ledger entry.

program_idstring

Unique identifier of the program under which this ledger entry was recorded.

typeenum

Type of financial activity that resulted in this ledger entry.

Allowed values:

channelenum

Channel through which the financial activity associated with this ledger entry was processed.

Allowed values:

sourceobject

References to the originating transaction and transaction event associated with this ledger entry.

account_idstring or nullOptional

Unique identifier of the account affected by this ledger entry.

control_account_idstring or nullOptional

Unique identifier of the associated Control account, when applicable. This field is omitted when the ledger entry is not associated with a Control account.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors