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

​
Attributes

​
id
string
Unique identifier for the leave transaction, for example lvtx_7mNpK4wYz3qRsF.
​
balance
string
ID of the leave balance this transaction belongs to.
​
entitlement
string | null
ID of the entitlement that produced this transaction. Returns null for manual adjustments or transactions not tied to a specific entitlement.
​
type
string
Transaction type. One of accrual, usage, reversal, adjustment, carryover, expiry, forfeit, or payout.
​
amount
number
Signed balance change for the transaction. Credits are positive and debits are negative.
​
date
string
ISO 8601 effective date of the transaction.
​
description
string | null
Optional freeform description for the transaction.
​
leave
string | null
Leave ID linked to the transaction. Returns null unless the transaction is tied to leave usage or a reversal.
​
created
string
ISO 8601 timestamp of when the transaction was created.
​
updated
string
ISO 8601 timestamp of the most recent update to the transaction.
{
  "id": "lvtx_7mNpK4wYz3qRsF",
  "balance": "lvb_8kPqR2nYx1mVtD",
  "entitlement": "lve_3vNqM7xRk2pWsT",
  "type": "accrual",
  "amount": "2.08",
  "date": "2026-03-01",
  "description": "Policy accrual",
  "leave": null,
  "created": "2026-03-01T00:00:00Z",
  "updated": "2026-03-01T00:00:00Z"
}