| Tip |
|---|
Deprecated from CRM.COM R17.0.0. Note that spending an awarded amount will be available from the purchase customer event APIexisting POST customer_events/purchases/create |
| Excerpt |
|---|
This method is used to create a spend request customer event in a posted life cycle state |
...
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:
| ||||||||
spend_amount (optional) | Float | The amount to be spent by the specified spend request in system currency. This is applicable depending on the classification of the spend request and only if it is allowed by a spend request customer event rule, as defined through the active customer event definition
| ||||||||
spend_alternative_amount (optional) | Float | The amount to be spent by the specified spend request in alternative currency. This is applicable depending on the classification of the spend request and only if it is allowed by a spend request customer event rule, as defined through the active customer event definition
| ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||
initiated_currency (optional) | Currency Identifier | The currency that the user is intended to use for the customer event which can either be the system currency or the alternative currency. The allowed currency identifier fields are the following:
| ||||||||
external_system (optional) | String | Defines the third party system that generates the spend request customer event
| ||||||||
external_system_reference_number (optional) | String | Defines the unique reference number of the spend request customer event in the external system
| ||||||||
authorized_by_access_token_identifier (optional) | Access Token Identifier | The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token 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 | ||||||||
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
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...