Balances are derived from leave transactions. Plane refreshes the ledger first, then recomputes
the balance snapshot from those transactions.
Attributes
string
Unique identifier for the leave balance, for example
lvb_8kPqR2nYx1mVtD.string
ID of the worker this balance belongs to.
string | null
Representative leave policy for this balance. Returns
null when the balance no longer has a
primary policy pointer.string
Leave type tracked by this balance.
string
Unit used for all numeric values. One of
days or hours.object
Period window covered by this balance.
number
Total credited leave for the period from accrual and adjustment transactions, including future
pending accruals.
number
Leave already used, based on past usage and reversal transactions.
number
Approved leave scheduled for future dates in the period.
number
Net available balance for the period after entitled, carried, used, and scheduled leave are
applied.
number
Net carried amount, including carryover, expiry, forfeit, and payout effects.
string
ISO 8601 timestamp of when the balance was created.
string
ISO 8601 timestamp of the most recent refresh of the balance.