Available from CRM.COM R15.0.0
This method is used to preview the amount that will be awarded for an achievement customer event, prior to submitting the achievement customer event.
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following:
Available from CRM.COM R17.0.0 For releases prior CRM.COM R17.0.0, this parameter was semi-optional From CRM.COM R17.0.0, the access token attributes are supported | ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||||||||||||||||||||||||||
product_identifier (optional) | Product Identifier | The product of the customer event. Any type of products can be specified. The allowed product identifier fields are the following:
| ||||||||||||||||||||||||||||||
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified. The allowed payment medium type identifier fields are the following:
| ||||||||||||||||||||||||||||||
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. The allowed payment medium brand identifier fields are the following:
| ||||||||||||||||||||||||||||||
payment_medium_identifier (optional) | String | The payment medium identifier of the customer event. | ||||||||||||||||||||||||||||||
amount (optional) | Number | The achievement customer event's amount | ||||||||||||||||||||||||||||||
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_on (mandatory) | Date | The date that the customer event was actually performed | ||||||||||||||||||||||||||||||
description (optional) | String | A description of the customer event | ||||||||||||||||||||||||||||||
external_system (optional) | String | The third party system that generates the customer event | ||||||||||||||||||||||||||||||
external_system_reference_number (optional) | String | The external system's unique reference number of customer event | ||||||||||||||||||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| total_award_amount | Number | The total amount that will be awarded for that achievement customer event in system currency |
| total_award_alternative_amount | Number | The total amount that will be awarded for that achievement customer event in alternative currency and only if the awarded amount will be in alternative currency |
rewards_participant_id | String | The ID of the achievement customer event's rewards participant |
| rewards_participant_name | String | The full name of the retrieved rewards participant |
| wallet_balance | Number | The current wallet balance of the customer in wallet currency |
| wallet_alternative_balance | Number | The current wallet balance of the customer in wallet alternative |
| voucher_types_set | Set of Voucher Types Objects | The set of type of the voucher that will be awarded instantly if such an achievement customer event is performed |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000126"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2018-09-24T09:49:59",
"description":"first purchase event",
"payment_medium_brand_identifier":{"name":"PMB Test"},
"payment_medium_type_identifier":{"name":"PMT Test"},
"payment_medium_identifier":"PI000001",
"product_identifier":{"code":"Gold"},
"amount":"5",
"external_system":"UserA21 54 45 "
}
Response:
{
"data": {
"total_award_alternative_amount": 0,
"rewards_participant_id": "C0AC5F16E9DB4057BAAEFC9DAA12FF3D",
"wallet_balance": 1440,
"wallet_alternative_balance": 0,
"rewards_participant_name": "Ekaterini Financial Statement",
"total_award_amount": 0
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}