Skip to main content
View as Markdown

The LedgerEntry object

Ledger entry

note

8 of 8 fields on this object have no description yet. Field documentation lives in the SDK types (api/ledger.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
id
REQUIRED		string
entryType
REQUIRED		string
amount
REQUIRED		number
currency
REQUIRED		string
balance
REQUIRED		number
description
REQUIRED		string
reference
REQUIRED		string
createdAt
REQUIRED		string

Example​

{
  "id": "obj_1a2b3c",
  "entryType": "string",
  "amount": 5000,
  "currency": "USD",
  "balance": 1,
  "description": "string",
  "reference": "string",
  "createdAt": "2026-01-15T09:30:00Z"
}