Skip to main content
Use leave transactions when you need the audit trail behind a leave balance.

​
Attributes

​
string
Unique identifier for the leave transaction, for example lvtx_7mNpK4wYz3qRsF.
​
string
ID of the leave balance this transaction belongs to.
​
string | null
ID of the entitlement that produced this transaction. Returns null for manual adjustments or transactions not tied to a specific entitlement.
​
string
Transaction type. One of accrual, usage, reversal, adjustment, carryover, expiry, forfeit, or payout.
​
string
Transaction status. posted means the entry is final. pending means the entry is expected for a future date and may still change before it is posted.
​
number
Signed balance change for the transaction. Credits are positive and debits are negative.
​
string
ISO 8601 effective date of the transaction.
​
string | null
Optional freeform description for the transaction.
​
string | null
Leave ID linked to the transaction. Returns null unless the transaction is tied to leave usage or a reversal.
​
string
ISO 8601 timestamp of when the transaction was created.
​
string
ISO 8601 timestamp of the most recent update to the transaction.