...
...
Name
...
Type
...
Description
...
id
...
String
...
The ID of the retrieved purchase customer event
...
String
...
The number of the retrieved purchase customer event
...
Defines if the customer event was processed immediately by various business processes or not
Tip |
---|
Deprecated from CRM.COM R15.0.0 |
Name | Type | Description | |||||
---|---|---|---|---|---|---|---|
id | String | The ID of the retrieved purchase customer event | |||||
number | String | The number of the retrieved purchase customer event | |||||
type | String | The type of the retrieved purchase customer event which in this case is set to PURCHASE | |||||
life_cycle_state | String | The life cycle state of the customer event which can be POSTED or CANCELLED | |||||
performed_on | Date | The date that the customer event was actually performed | |||||
description | String | A description of the customer event | |||||
process_immediately | Boolean | Defines if the customer event was processed immediately by various business processes or not
| |||||
reference_number | String | The reference number of the retrieved purchase customer event | |||||
payment_medium_identifier | String | The payment medium identifier with which the purchase customer event has been made
| |||||
total_amount | Number | The total amount of the retrieved purchase customer event | |||||
net_amount | Number | The total net amount of the retrieved purchase customer event | |||||
vat_amount | Number | The total VAT amount of the retrieved purchase customer event | |||||
external_system | String | Defines the third party system that generated the retrieved purchase customer event
| |||||
external_system_reference_number | String | Defines the unique reference of the external system that uniquely identifies the purchase customer event
| |||||
requested_spend_amount | Number | The amount requested to be spent by the specified customer event in system currency
| |||||
requested_spend_alternative_amount | Number | The amount requested to be spent by the specified customer event in alternative currency
| |||||
total_awarded_amount | Number | The total amount that was awarded for that purchase customer event in system currency
| |||||
total_amount | Number | The total amount of the retrieved purchase customer event | |||||
net_amount | Number | The total net amount of the retrieved purchase customer event | |||||
vatawarded_alternative_amount | Number | The total amount | external_system | String | Defines the third party system that generated the retrieved purchase customer eventthat was awarded for the customer event in the alternative currency.
| ||
externaltotal_systemspend_reference_numberamount | String | Defines the unique reference of the external system that uniquely identifies the purchase customer eventNumber | The total amount that was spent on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount
| ||||
total_spend_awardedalternative_amount | Number | The total alternative amount that was awarded for spent on that purchase customer event in system currency. The total spend alternative amount = Total instant spend alternative amount + Total automatic spend alternative amount + Total additional spend alternative amount
| |||||
total total_awardedinstant_alternativespend_amount | Number | The The total amount that was awarded for the spent instantly on that purchase customer event in the alternative currency.
| |||||
total total_instant_spend_alternative_amount | Number | The The total alternative amount that was spent instantly on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount
| |||||
total_instantautomatic_spend_amount | Number | The total amount that was spent instantly automatically on that purchase customer event, if the automatic awards spending is allowed
| |||||
total_automatic_spend_alternative_amount | Number | The total total alternative amount that was spent automatically on that purchase customer event, if the automatic awards spending is allowedawards spending is allowed
| |||||
total_additional_spend_amount | Number | The total amount that was spent additionally on that purchase customer event
| |||||
total_additional_spend_alternative_amount | Number | The total alternative amount that was spent additionally on that purchase customer event
| |||||
disable_instant_spend | 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 | String | An identifier of the terminal that submitted the purchase customer event
| |||||
udf_string_1 | String | User Defined Field of type String | |||||
udf_string_2 | String | User Defined Field of type String | |||||
udf_string_3 | String | User Defined Field of type String | |||||
udf_string_4 | String | User Defined Field of type String | |||||
udf_string_5 | String | User Defined Field of type String | |||||
udf_string_6 | String | User Defined Field of type String | |||||
udf_string_7 | String | User Defined Field of type String | |||||
udf_string_8 | String | User Defined Field of type String | |||||
udf_string_9 | String | User Defined Field of type String
| |||||
udf_string_10 | String | User Defined Field of type String
| |||||
udf_string_11 | String | User Defined Field of type String
| |||||
udf_string_12 | String | User Defined Field of type String
| |||||
udf_string_13 | String | User Defined Field of type String
| |||||
udf_string_14 | String | User Defined Field of type String
| |||||
udf_string_15 | String | User Defined Field of type String
| |||||
udf_string_16 | String | User Defined Field of type String
| |||||
udf_float_1 | Float | User Defined Field of type Float | |||||
udf_float_2 | Float | User Defined Field of type Float | |||||
udf_float_3 | Float | User Defined Field of type Float | |||||
udf_float_4 | Float | User Defined Field of type Float | |||||
udf_date_1 | Date | User Defined Field of type Date | |||||
udf_date_2 | Date | User Defined Field of type Date | |||||
udf_date_3 | Date | User Defined Field of type Date | |||||
udf_date_4 | Date | User Defined Field of type Date | |||||
udf_date_4 | Date | User Defined Field of type Date | |||||
classification | Customer Event Classification Object | The classification of the customer event | |||||
accounts_receivable | Accounts receivable Object | The related accounts receivable Field of type Date | |||||
classification | Customer Event Classification Object | The classification of the customer event | |||||
accounts_receivable | Accounts receivable Object | The related accounts receivable | |||||
performed_by_unit | Unit Object | The unit that initiated the customer event
| |||||
performed_by_business_unit | Business Unit Object | The business unit that initiated the customer event
| |||||
performed_by_unittap | Unit Transaction Acquiring Point Object | The transaction acquiring point that initiated the customer event
| |||||
authorized_by_access_token | Access Token Object | The access token that was used to identify and authorize the customer Tip |
| ||||
Log Information Object | The log information related to the retrieved invoice | ||||||
invoice | Invoice Object | The CRM.COM invoice related to the purchase | |||||
instant_spend_request | Spend Request Customer Event Object | The spend request customer event that was created instantly while processing and awarding the purchase customer event]
| |||||
automatic_spend_request | Spend Request Customer Event Object | The spend request customer event that was created automatically as part of the automatic awards spending process
| |||||
currency | Currency Object | The purchase customer event's related currency
| |||||
payment_medium_brand | Payment Medium Brand Object | The payment medium brand with which the purchase customer event has been made
| |||||
payment_medium_type | Payment Medium Brand Object | The payment medium type with which the purchase customer event has been made
| |||||
products_set | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product | |||||
award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the purchase customer event | |||||
spend_reward_transactions_set | Set of Spend Reward Transaction Object | The spend reward transactions that were created as a result of the purchase customer event
| |||||
spend_requests_set | Set of Spend Request Customer Event Objects | The spend request customer events that were submitted to the purchase customer event
|
Referred Objects Response Data Anchor purchase customer event referred objects purchase customer event referred objects
...
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
...
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|