Versions Compared

Key

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


Expand
titleaccounts_receivable_rewards_participant_update_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 of the first reward scheme (oldest from the reward scheme set) that the participant signed-up; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

sign_up_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit that signed up the accounts receivable

  • If not specified, defaults to the logged in user's unit; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

The allowed business unit identifier fields are the following:

Include Page
business_unit_identifier
business_unit_identifier

Tip

Available from CRM.COM R18.0.0


sign_up_by_unit_identifier

(optional)

Unit identifier

The unit that signed up the rewards participantthe accounts receivable

  • If not specified, defaults to the unit of the first reward scheme (oldest from the reward scheme set) that the participant signed-uplogged in user's unit; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

The allowed unit identifier fields are the following:

Include Page
unit_identifier
unit_identifier

Tip

Deprecated from CRM.COM R18.0.0


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

(optional)

Set of Participating Rewards Participant Scheme Objects

A list of reward schemes that the rewards accounts receivable participant has jointjoined

Include Page
Web API - Updating Sets
Web API - Updating Sets

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 participantaccounts receivable, considering that those merchants are also allowing automatic awards spendingsspending. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled.

Include Page
Web API - Updating Sets
Web API - Updating Sets

Anchor
accounts_receivable_rewards

_participant

_update referred objects parameters
accounts_receivable_rewards

_participant

_update referred objects parameters
Referred Parameter Objects Data

Include Page
rewards_participant_schemes_update_parameter
rewards_participant_schemes_update_parameter

Include Page
authorised_rewards_participating_merchants_update_parameters
authorised_rewards_participating_merchants_update_parameters

...