Versions Compared

Old Version 2

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

compared with

New Version 3

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

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

Available from CRM.COM R15.0.0

Excerpt

This method is used to preview the amount that will be awarded for an achievement customer event, prior to submitting the achievement customer event.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

The related accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

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:

Include Page
V4:product_identifier
V4:product_identifier

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:

Include Page
V4:payment_medium_type_identifier
V4:payment_medium_type_identifier

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:

Include Page
V4:payment_medium_brand_identifier
V4:payment_medium_brand_identifier

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 IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA 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

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
   "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:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "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,
        "reduction_method": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}