Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2.42 KB

LoyaltyProgramBalance.md

File metadata and controls

31 lines (24 loc) · 2.42 KB

TalonOne::LoyaltyProgramBalance

Properties

Name Type Description Notes
current_balance Float Sum of currently active points.
pending_balance Float Sum of pending points.
negative_balance Float Sum of negative points. This implies that `currentBalance` is `0`.
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]
tentative_negative_balance Float The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` 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.

Code Sample

require 'TalonOne'

instance = TalonOne::LoyaltyProgramBalance.new(current_balance: 100.0,
                                 pending_balance: 10.0,
                                 negative_balance: 10.0,
                                 expired_balance: 0.0,
                                 spent_balance: 0.0,
                                 tentative_current_balance: 100.0,
                                 tentative_pending_balance: 20.0,
                                 tentative_negative_balance: 100.0)