| Tip |
|---|
Available from CRM.COM R5.0.0 |
Table of Contents maxLevel 2
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type purchase can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
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 | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
reference_number (optional) | String | The reference number of the retrieved purchase customer event | ||||||
invoice_identifier (optional) | Invoice Identifier | The CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:
| ||||||
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 | ||||||
(mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type referrals can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
referred_rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the referred rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| referred_accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the referred accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
referred_by_rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the referred by rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| referred_by_accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the referred by accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| |||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
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 | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
referred_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The referred rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
referred_by_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant that provided the referral. The allowed rewards participant identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type social media can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
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 | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
social_media (mandatory) | String | The social media related with the customer event, which can be one of the following: FACEBOOK | ||||||
profile (mandatory) | String | The social media profile related with the customer event | ||||||
action (mandatory) | String | The social media action that was performed. The following actions per social media are supported (if the social media is set to Facebook) LIKE | ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type web can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
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 | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
website (mandatory) | String | The website URL related with the customer event | ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type achievement can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
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 | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be returned as a result. Only customer events of type spend request can be specified. The allowed customer event identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||||
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 | ||||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||||
purchase_customer_request_identifier (mandatory) | Customer Event identifier | The purchase customer event which is requested to be settled by the specified spend request. Only customer events of type purchase can be specified. The allowed customer event identifier fields are the following:
| ||||||||
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 |
...