Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Expand
titleaccounts_receivable_rewards_participant_parameters object data


Name

Type

Description

sign_up_on

(optional)

Date

The date that the rewards participant accounts receivable signed up

  • If not specified, defaults to the current date

sign_up_by_unit_identifier

(optional)

Unit identifier

The unit that signed up the rewards participantaccounts receivable

  • If not specified, defaults to the logged in user's unit

The allowed unit identifier fields are the following:

Include Page
unit_identifier
unit_identifier

enable_automatic_spend

(optional)

Boolean

Defines whether the rewards participant accounts receivable requires automatic spend on purchase events or not

minimum_wallet_balance

(optional)

Float

The minimum wallet balance that should be available in order for an automatic awards spending to be applied.

minimum_spend_amount

(optional)

Float

The minimum amount that can be spend by that specific rewards participant accounts receivable during auto spend

maximum_spend_amount

(optional)

Float

The maximum amount that can be spend by that specific rewards participant accounts receivable during auto spend

participating_schemes_set

(mandatory)

Set of Rewards Participant Scheme ObjectsA list of reward schemes that the rewards participant accounts receivable has jointjoined

authorised_rewards_participating_merchants_set

(optional)

Set of Rewards Participating Merchants

It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled

Anchor
accounts receivable_rewards_

participant_

create referred objects parameters
accounts receivable_rewards

_participant

_create referred objects parameters
Referred Parameter Objects Data

Include Page
rewards_participant_schemes_parameter
rewards_participant_schemes_parameter

Include Page
authorised_rewards_participating_merchants_parameters
authorised_rewards_participating_merchants_parameters

...