Update Ledger Transaction

patch

https://app.moderntreasury.com/api/ledger_transactions/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
For pending ledger transactions, any of the below attributes can be updated. For posted ledger transactions, only the metadata or external_id attributes can be updated.

Ledger Entries are immutable, meaning that for any updates on a Ledger Transaction that could affect the account balances, the existing Ledger Entries are discarded and new Ledger Entries are created. This allows you to look up which Ledger Entry contributed to a certain Ledger Account lock_version. See Verifying Prior Ledger States for more details.

Path Params

string

required

The ID or external_id of the ledger transaction.

Body Params

description

string

An optional free-form description for internal use. Maximum of 1000 characters allowed.

status

string

To post the ledger transaction, use posted. To archive a pending ledger transaction, use archived.

metadata

json

Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or null as the value.

effective_at

date-time

Format: ISO8601 to 6 decimal places.

ledger_entries

array of objects

Note that updating entries will overwrite any prior entries on the ledger transaction. The metadata will not be copied over from the previous entries so any attached metadata must be sent in the payload.

ledger_entries

ledger_account_category_balance_locks

array of objects

An array of one or more ledger account category balance locks. Use this to lock on a ledger account category's balance.

ledger_account_category_balance_locks

ledgerable_type

string

If the ledger transaction can be reconciled to another object in Modern Treasury, add the ledgerable type here, otherwise null. See possible types at Ledger Transactions

ledgerable_id

string

If the ledger transaction can be reconciled to another object in Modern Treasury, add the id of that object here, otherwise null.

external_id

string

An optional user-defined 180 character unique identifier

Response

200200