Name | Type | Description |
request_unique_identifier (mandatory) | String | A unique identifier of the request, provided by the caller, in order to identify the successful or failed results. Note that this information should be unique and is not stored within CRM.COM |
accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable | access_token_identifier (semi-optional) | Access Token Identifier | The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following Name | Type | Description |
---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified | one_time_password (semi-optional) | Integer | The one-time password (OTP) of the access token |
|
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant | access_token_identifier (semi-optional) | Access Token Identifier | The identifier of the access token which is related with the rewards participant. Only effective access tokens can be used to identify a rewards participant. The allowed access token identifier fields are the following: Name | Type | Description |
---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified | one_time_password (semi-optional) | Integer | The one-time password (OTP) of the access token |
|
|
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
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: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
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: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the payment medium type | name (semi-optional) | String | The name of the payment medium type | alternative_code (semi-optional) | String | The alternative code of the payment medium type |
|
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: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the payment medium brand | name (semi-optional) | String | The name of the payment medium brand | alternative_code (semi-optional) | String | The alternative code of the payment medium brand |
|
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 (semi-optional) | Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following Name | Type | Description |
---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
performed_by_tap_identifier (semi-optional) | Transaction Acquiring Point Identifier | The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following Name | Type | Description |
---|
id (semi-optional) | String | The ID of the transaction acquiring point | name (semi-optional) | String | The name of the transaction acquiring point | code (semi-optional) | String | The code of the transaction acquiring point |
|
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 unique reference number of the customer event in the external system |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |