accounts_receivable_rewards_update_parameters
Joseph Ioannou (Unlicensed)
Name | Type | Description | ||||||||||||
sign_up_on (optional) | Date | The date that the accounts receivable signed up
| ||||||||||||
sign_up_by_business_unit_identifier (optional) | Business Unit identifier | The business unit that signed up the accounts receivable
The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
sign_up_by_unit_identifier (optional) | Unit identifier | The unit that signed up the accounts receivable
The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
enable_automatic_spend (optional) | Boolean | Defines whether the 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 accounts receivable during auto spend | ||||||||||||
maximum_spend_amount (optional) | Float | The maximum amount that can be spend by that specific accounts receivable during auto spend | ||||||||||||
(optional) | Set of Participating Rewards Scheme Objects | A list of reward schemes that the accounts receivable participant has joined
If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
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 accounts receivable, considering that those merchants are also allowing automatic awards spending. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled.
If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
|
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| action (mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, UPDATE, REMOVE | ||||||||||||
sign_up_on (mandatory and applicable only on add and update) | Date | The date that the rewards participant signed up for that specific reward scheme | ||||||||||||
email_address (semi-optional and only on add and update) | String | The email address that is associated with the unique reference code and was used while signing up to a reward scheme based on supported domains This available and mandatory only it is required by the specific reward scheme (that is domain specific) and the reference code generation method is set to "AUTO_GENERATED" Available from CRM.COM R15.2.0 | ||||||||||||
reference_code (mandatory on conditions and only on add and update) | String | The unique reference code that was used while signing up to that specific reward scheme This is available and mandatory only if it is required by the specific reward scheme (that is domain specific) or if an email is defined instead of a reward scheme Available from CRM.COM R12.7.0 | ||||||||||||
sign_up_by_unit_identifier (mandatory and applicable only on add and update) | Unit identifier | The unit that signed up the rewards participant to that specific reward scheme. The allowed unit identifier fields are the following:
| ||||||||||||
| sign_off_on | Date | The date that the rewards participant signed off from that specific reward scheme Available from CRM.COM R9.0.0 | ||||||||||||
rewards_participant_scheme_identifier (mandatory and applicable only on update or remove) | Rewards Participant Scheme Identifier | The identifier of the activity service to be updated. The allowed activity service identifier fields are the following:
| ||||||||||||
reward_scheme_identifier (semi-optional and applicable only on add) | Reward Scheme Identifier | The reward scheme that the rewards participant has joint. The allowed reward scheme identifier fields are the following:
For releases prior CRM.COM R15.2.0 this parameter is mandatory From CRM.COM R15.2.0 and onwards this parameter will be semi-optional and It should be specified if the email address is not specified |
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| action (mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, REMOVE | ||||||||||||||||||||||||||||||||||||
rewards_participating_merchant_identifier (mandatory) | Rewards Participating Merchant Identifier | The rewards participating merchant that should be authorised or de-authorised to perform automatic awards spending. The allowed rewards participating merchant identifier fields are the following:
|