Ledger Transactions

🚧
Beta testing phase
If you are interested in early access to this feature please contact [email protected]!

A ledger_transaction represents a transfer between two or more ledger accounts. It must include at least one credit entry and one debit entry, with the total credit amount equal to the total debit amount. Once posted, a ledger transaction becomes immutable.

Attribute	Type	Description
id	string	Unique identifier for the ledger transaction.
external_id	string	(Optional) A user-defined unique identifier.
description	string	(Optional) A free-form description for internal use.
status	string	The current status of the transaction: `pending`, `posted`, or `archived`.
metadata	object	Additional key-value pairs for storing structured data. Both keys and values must be strings.
ledger_entries	array object	An array of associated ledger entry objects.
posted_at	datetime	The timestamp when the transaction was posted. Will be null if the status is pending.
effective_at	datetime	The effective time of the transaction for reporting purposes.
ledger_id	string	The ID of the ledger to which this transaction belongs.
reversed_by_ledger_transaction_id	string	The ID of the ledger transaction that reversed this one, if applicable.
reverses_ledger_transaction_id	string	The ID of the original transaction that this one reverses, if applicable.
created_at	datetime	The timestamp when the transaction was created.
updated_at	datetime	The timestamp of the most recent update to the transaction.

{
    "id": "e551896f-26c1-49c5-b440-0bf0b5145928",
    "object": "ledger_transaction",
    "live_mode": true,
    "external_id": "Test Account_PayMongo wallet transfer_RC1f9Mj1siSoouLk9cEc_credit",
    "ledgerable_type": null,
    "ledgerable_id": null,
    "ledger_id": "ef4d6f0f-9bd0-40b6-a0a8-7e14060e7439",
    "description": null,
    "status": "posted",
    "metadata": {
        "day": "15",
        "client": "Test Account",
        "bank_id": "824",
        "purpose": "PayMongo wallet transfer",
        "paymongo": "true"
    },
    "reversed_by_ledger_transaction_id": null,
    "reverses_ledger_transaction_id": null,
    "posted_at": "2025-07-15T10:42:33Z",
    "effective_at": "2025-07-15T10:42:33Z",
    "effective_date": "2025-07-15",
    "created_at": "2025-07-15T10:42:33Z",
    "updated_at": "2025-07-15T10:42:33Z",
    "ledger_entries": [
        {
            "id": "010364b5-3ac4-402c-b372-f54f5b2647d5",
            "object": "ledger_entry",
            "live_mode": true,
            "amount": 8050,
            "direction": "credit",
            "status": "posted",
            "ledger_account_id": "0196adaf-2b5b-75af-a05a-9108d3d5d33b",
            "ledger_account_name": "Test Account - org_ekTMVhwzcJs8KmCjr4X9jndd",
            "ledger_account_currency": "PHP",
            "ledger_account_currency_exponent": 2,
            "ledger_transaction_id": "e551896f-26c1-49c5-b440-0bf0b5145928",
            "resulting_ledger_account_balances": {
                "pending_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                },
                "posted_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                },
                "available_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                }
            },
            "metadata": null,
            "discarded_at": null,
            "created_at": "2025-07-15T10:42:33Z",
            "updated_at": "2025-07-15T10:42:33Z"
        },
        {
            "id": "bdc3eb8a-8c97-45f5-af69-aa60e5c7a26c",
            "object": "ledger_entry",
            "live_mode": true,
            "amount": 8050,
            "direction": "debit",
            "status": "posted",
            "ledger_account_id": "14dc346e-965b-418b-9810-dbc1972e754b",
            "ledger_account_name": "PM Master Ledger",
            "ledger_account_currency": "PHP",
            "ledger_account_currency_exponent": 2,
            "ledger_transaction_id": "e551896f-26c1-49c5-b440-0bf0b5145928",
            "resulting_ledger_account_balances": {
                "pending_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                },
                "posted_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                },
                "available_balance": {
                    "credits": 0,
                    "debits": 0,
                    "amount": 0,
                    "currency": "PHP",
                    "currency_exponent": 2
                }
            },
            "metadata": null,
            "discarded_at": null,
            "created_at": "2025-07-15T10:42:33Z",
            "updated_at": "2025-07-15T10:42:33Z"
        }
    ]
}