Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.63 KB

LedgerInfo.md

File metadata and controls

20 lines (13 loc) · 1.63 KB

LedgerInfo

The balance in a Loyalty Program for some Customer.

Properties

Name Type Description Notes
currentBalance BigDecimal Sum of currently active points.
pendingBalance BigDecimal Sum of pending points.
expiredBalance BigDecimal DEPRECATED Value is shown as 0.
spentBalance BigDecimal DEPRECATED Value is shown as 0.
tentativeCurrentBalance BigDecimal The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
tentativePendingBalance BigDecimal The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. [optional]
currentTier Tier [optional]
pointsToNextTier BigDecimal Points required to move up a tier. [optional]