Name | Type | Description |
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:| Include Page |
|---|
| customer_event_classification_identifier |
|---|
| customer_event_classification_identifier |
|---|
|
|
description (optional) | String | A description of the customer event |
reference_number (mandatory) | String | The reference number of the retrieved purchase customer event |
external_system_reference_number (optional) | String | Defines the unique reference number of the purchase customer event in the external system | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The identifier of the payment medium brand with which the purchase customer event has been made. If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium brand as specified in the related access token classification The allowed payment medium brand identifier fields are the following: | Include Page |
|---|
| payment_medium_brand_identifier |
|---|
| payment_medium_brand_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R10.0.0 |
|
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The identifier of the payment medium type with which the purchase customer event has been made If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification The allowed payment medium type identifier fields are the following: | Include Page |
|---|
| payment_medium_type_identifier |
|---|
| payment_medium_type_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R10.0.0 |
|
payment_medium_identifier (optional) | String | The payment medium identifier with which the purchase customer event has been made | Tip |
|---|
Available from CRM.COM R10.0.0 |
|
invoice_identifier (optional) | Invoice Identifier | The CRM.COM invoice related to the purchase. The allowed invoice identifier fields are the following:| Include Page |
|---|
| invoice_identifier |
|---|
| invoice_identifier |
|---|
|
|
promo_code (optional) | String | The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided. | Tip |
|---|
Available from CRM.COM R15.0.0 |
|
disable_instant_spend (optional) | Boolean | It determines if instant spend offers should be disabled (i.e. not applied) or not. By default all instant spend offers are applied if their conditions are met. | Tip |
|---|
Available from CRM.COM R14.4.0 |
|
terminal_identifier (optional) | String | An identifier of the terminal that submitted the purchase customer event | Tip |
|---|
Available from CRM.COM R15.1.0 |
|
| total_discount_amount | Number | The total discount made on the purchase customer event | Tip |
|---|
Available from CRM.COM R16.10.0 |
|
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_string_9 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_10 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_11 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_12 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_13 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_14 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_15 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
udf_string_16 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
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 |
products_set (mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |