Ledgerable Event

A ledgerable_event is an object that records a generic financial event, which may be translated to a ledger transaction through a ledger event handler.

📘

This is an Early Access feature.

Features in early access may undergo changes in the future. Reach out to your customer success manager or support team in case of any questions.

AttributeDescription
id
string
Unique identifier of the Ledgerable Event.
description
string
An optional free-form description.
name
string
Name of the ledgerable event.
custom_data
object
Additionally data to be used by ledger event handlers.
ledger_event_handler_id
string
ID of the ledger event handler that matches this ledgerable event.
metadata
object
Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.
live_mode
boolean
This field will be true if this object was created with a production API key or false if created with a test API key.