| Tip |
|---|
Available from CRM.COM R10.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 financial 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. Only financial achievement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:
| ||||||
submitted_after_date (optional) | Date | if specified then information related with financial achievements customer events that was submitted after the specified date should be retrieved
| ||||||
submitted_before_date (optional) | Date | if specified then information related with financial achievements customer events that was submitted before the specified date should be retrieved
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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. Only financial achievement classifications are allowed to be specified. 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 financial 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 | Defines the third party system that generated the customer event
| ||||||
external_system_reference_number (optional) | String | Defines 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 | ||||||
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 | ||||||
customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be cancelled. Only customer events of type financial achievement which are posted 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
|
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...