Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.96 KB

LedgerInfo.md

File metadata and controls

31 lines (24 loc) · 1.96 KB

TalonOne::LedgerInfo

Properties

Name Type Description Notes
current_balance Float Sum of currently active points.
pending_balance Float Sum of pending points.
expired_balance Float DEPRECATED Value is shown as 0.
spent_balance Float DEPRECATED Value is shown as 0.
tentative_current_balance Float 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.
tentative_pending_balance Float 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]
current_tier Tier [optional]
points_to_next_tier Float Points required to move up a tier. [optional]

Code Sample

require 'TalonOne'

instance = TalonOne::LedgerInfo.new(current_balance: 100.0,
                                 pending_balance: 10.0,
                                 expired_balance: 0.0,
                                 spent_balance: 0.0,
                                 tentative_current_balance: 100.0,
                                 tentative_pending_balance: 20.0,
                                 current_tier: null,
                                 points_to_next_tier: 20.0)