LedgerPointsEntryIntegrationAPI.md

TalonOne::LedgerPointsEntryIntegrationAPI

Properties

Name	Type	Description	Notes
id	Integer	ID of the transaction that adds loyalty points.
transaction_uuid	String	Unique identifier of the transaction in the UUID format.
created	DateTime	Date and time the loyalty points were added.
program_id	Integer	ID of the loyalty program.
customer_session_id	String	ID of the customer session where points were added.	[optional]
name	String	Name or reason of the transaction that adds loyalty points.
start_date	String	When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time.
expiry_date	String	Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time.
subledger_id	String	ID of the subledger.
amount	Float	Amount of loyalty points added in the transaction.
validity_duration	String	The duration for which the points remain active, relative to the activation date. Note: This only applies to points for which `awaitsActivation` is `true` and `expiryDate` is not set.	[optional]

Code Sample

require 'TalonOne'

instance = TalonOne::LedgerPointsEntryIntegrationAPI.new(id: 123,
                                 transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
                                 created: null,
                                 program_id: 324,
                                 customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,
                                 name: Reward 10% points of a purchase's current total,
                                 start_date: 2022-01-02T15:04:05Z07:00,
                                 expiry_date: 2022-08-02T15:04:05Z07:00,
                                 subledger_id: sub-123,
                                 amount: 10.25,
                                 validity_duration: 30D)