...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This method is used to create a purchase customer event in a posted life cycle state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
| Tip |
|---|
From CRM.COM R15.0.0, access_token_identifier is supported |
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
process_immediately
(optional)
...
Defines if the customer event was processed immediately by various business processes or not
...
| Excerpt |
|---|
This method is used to create a purchase customer event in a posted life cycle state |
Resource URL
Parameters
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Â
Request:
Body:
...
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following:
|
reference_number
(mandatory)
payment_medium_brand_identifier
(optional)
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:
| Tip |
|---|
Available from CRM.COM R10.0.0 |
payment_medium_type_identifier
(optional)
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:
| Tip |
|---|
Available from CRM.COM R10.0.0 |
payment_medium_identifier
(optional)
| ||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed fields are the following
| ||||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed identifier fields are the following
| ||||||||
performed_by_business_unit_identifier (semi-optional) | Business Unit Identifier | The business unit that initiated the customer event. The allowed identifier fields are the following
|
|
performed_by_unit_identifier (semi-optional) |
Defines the third party system that generates the purchase customer event
| Tip |
|---|
Available from CRM.COM R10.0.0 |
external_system_reference_number
(optional)
Defines the reference number that uniquely identifies the purchase customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
authorized_by_access_token_identifier
(optional)
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:
| Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following
| |||||||||
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
|
|
invoice_identifier
(optional)
intended_currency_identifier
(optional)
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:
| Tip |
|---|
promo_code
(optional)
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)
| ||||||||||
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 (mandatory) | String | The reference number of the retrieved purchase customer event | ||||||||
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:
|
|
|
payment_ |
medium_ |
type_identifier (optional) |
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_5
(optional)
String
User Defined Field of type String
| Payment Medium Type Identifier | 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:
| |||||||||
payment_medium_identifier (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)
The payment medium identifier with which the purchase customer event has been made
| ||
external_system (optional) | String |
User Defined Field of type String
Defines the third party system that generates the purchase customer event
|
|
external_system_ |
reference_ |
number (optional) | String |
Defines the reference number that uniquely identifies the purchase customer event in the external system
|
authorized_ |
udf_string_12
(optional)
String
by_access_token_identifier (optional) |
String
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
| 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:
|
|
User Defined Field of type String
|
udf_string_13
(optional)
String
|
|
|
invoice_ |
User Defined Field of type String
identifier (optional) |
String
| Invoice Identifier | The CRM.COM |
invoice related with the purchase. The allowed invoice identifier fields are the following:
| ||||||
intended_currency_identifier (optional) |
String
| 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 thrown. 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:
|
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.
|
|
|
disable_ |
instant_ |
udf_float_2
(optional)
Float
User Defined Field of type Float
spend (optional) |
Float
User Defined Field of type Float
| 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.
| ||
terminal_identifier (optional) |
Float
User Defined Field of type Float
| String | An identifier of the terminal that submitted the purchase customer event
| ||
total_discount_amount (optional) |
Float
| Number | The total discount amount on the purchase 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) |
List of Strings, comma separated
Â
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
| ||
udf_string_10 (optional) | String | User Defined Field of type String
| ||
udf_string_11 (optional) | String | User Defined Field of type String
|
...
udf_string_12 (optional) | String | User Defined Field of type String
| ||
udf_string_13 (optional) | String | User Defined Field of type String
| ||
udf_string_14 (optional) | String | User Defined Field of type String
| ||
udf_string_15 (optional) | String | User Defined Field of type String
| ||
udf_string_16 (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 | ||
(optional) | Spend Request Object | Information related with the spend request that should be created as part of the purchase customer event
| ||
(mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product | ||
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
|
Anchor create purchase customer event referred parameters create purchase customer event referred parameters
Referred Parameter Objects
| create purchase customer event referred parameters | |
| create purchase customer event referred parameters |
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
| Expand | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
| ||||||||||||||||||
| Expand | ||||||||||||||||||
| ||||||||||||||||||
HTTP Method: POST Â Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
| ||||||||||||||||||
| Expand | ||||||||||||||||||
| ||||||||||||||||||
HTTP Method: POST Â Request: Body:
Response:
|