Versions Compared

Old Version 36

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

String

...


...

Name

...

Type

...

Description

...

id

...

String

...

The ID of the retrieved purchase customer event


Defines if the customer event was processed immediately by various business processes or not

Name

Type

Description

id

String

The ID of the retrieved purchase customer event

number

String

The number of the retrieved purchase customer event

typeStringThe type of the retrieved purchase customer event which in this case is set to PURCHASE
life_cycle_stateStringThe life cycle state of the customer event which can be POSTED or CANCELLED
performed_onDateThe date that the customer event was actually performed
descriptionStringA description of the customer event
process_immediatelyBoolean

Defines if the customer event was processed immediately by various business processes or not

Tip

Deprecated from CRM.COM R15.0.0


reference_numberStringThe reference number of the retrieved purchase customer event
payment_medium_identifierString

The payment medium identifier with which the purchase customer event has been made

Tip

Available from CRM.COM R10.0.0


total_amountNumberThe total amount of the retrieved purchase customer event
typenet_amountStringNumberThe type total net amount of the retrieved purchase customer event which in this case is set to PURCHASE
life_cycle_stateStringThe life cycle state of the customer event which can be POSTED or CANCELLED
performed_onDateThe date that the customer event was actually performed
descriptionStringA description of the customer event
process_immediatelyBoolean
Tip

Deprecated from CRM.COM R15.0.0

reference_numberStringThe reference number of the retrieved purchase customer eventpayment_medium_identifierStringThe payment medium identifier with which the purchase customer event has been madevat_amountNumberThe total VAT amount of the retrieved purchase customer eventexternal_systemString

Defines the third party system that generated the retrieved purchase customer event

Tip

Available from CRM.COM R10.0.0


external_system_reference_numberString

Defines the unique reference of the external system that uniquely identifies the purchase customer event

Tip

Available from CRM.COM R10.1.0


requested_spend_amountNumber

The amount requested to be spent by the specified customer event in system currency

Tip

Available from CRM.COM R17.0.0


requested_spend_alternative_amountNumber

The amount requested to be spent by the specified customer event in alternative currency

Tip

Available from CRM.COM R17.0.0


total_awarded_amountNumber

The total amount that was awarded for that purchase customer event in system currency

Tip

Available from CRM.COM R10R12.06.0


total_awarded_alternative_amountNumber

The total amount

of the retrieved purchase

that was awarded for the customer event

net_amountNumberThe total net amount of the retrieved purchase customer eventvat

in the alternative currency.

Tip

Available from CRM.COM R14.2.0


total_spend_amountNumber

The total

VAT amount of the retrieved purchase customer eventexternal_systemString

Defines the third party system that generated the retrieved purchase customer eventamount that was spent on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount

Tip

Available from CRM.COM R10R12.06.0


externaltotal_systemspend_referencealternative_numberamountStringDefines the unique reference of the external system that uniquely identifies the purchase customer eventNumber

The total alternative amount that was spent on that purchase customer event. The total spend alternative amount = Total instant spend alternative amount + Total automatic spend alternative amount + Total additional spend alternative amount

Tip

Available from CRM.COM R10COM R17.10.0


total total_instant_awardedspend_amountNumber

The  The total amount that was awarded for spent instantly on that purchase customer event in system currency

Tip

Available from CRM.COM R12.6.0


total total_instant_awardedspend_alternative_amountNumber

The  The total alternative amount that was awarded for the spent instantly on that purchase customer event in the alternative currency.

Tip

Available from CRM.COM R14COM R17.20.0


total total_automatic_spend_amountNumber

The  The total amount that was spent automatically on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount, if the automatic awards spending is allowed

Tip

Available from CRM.COM R12.6.0


 total_instantautomatic_spend_alternative_amountNumber

 The total total alternative amount that was spent instantly automatically on that purchase customer event, if the automatic awards spending is allowed

Tip

Available from CRM.COM R12COM R17.60.0


 total_automaticadditional_spend_amountNumber

 The total amount that was spent automatically additionally on that purchase customer event, if the automatic awards spending is allowed

Tip

Available from CRM.COM R12.6.0


 total_additional_spend_alternative_amountNumber

 The total alternative amount that was spent additionally on that purchase customer event

Tip

Available from CRM.COM R12R17.60.0


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.

Tip

Available from CRM.COM R14.4.0


terminal_identifier

String

An identifier of the terminal that submitted the purchase customer event

Tip

Available from CRM.COM R15.1.0


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

Tip

Available from CRM.COM R10.1.0


udf_string_10

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_11


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_12


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_13


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_14


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_15


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_16


String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


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

String
Tip

Available from CRM.COM R10.1.0

Float

udf_float_14

Float

User Defined Field of type Float

udf_floatdate_21

FloatDate

User Defined Field of type FloatDate

udf_floatdate_32

FloatDate

User Defined Field of type FloatDate

udf_floatdate_43

FloatDate

User Defined Field of type FloatDate

udf_date_14

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

classificationCustomer Event Classification ObjectThe classification of the customer eventaccounts_receivableAccounts receivable ObjectThe related accounts receivableperformed_by_unitUnit ObjectThe unit that initiated the customer event

Date

classificationCustomer Event Classification ObjectThe classification of the customer eventaccounts_receivableAccounts receivable ObjectThe related accounts receivableperformed_by_unitUnit Object

The unit that initiated the customer event

Tip

Deprecated from CRM.COM R18.0.0


performed_by_business_unitBusiness Unit Object

The business unit that initiated the customer event

Tip

Available from CRM.COM R18.0.0


performed_by_tapTransaction Acquiring Point Object

The transaction acquiring point that initiated the customer event

Tip

Available from CRM.COM R17.0.0


authorized_by_access_tokenAccess Token Object

The access token that was used to identify and authorize the customer

Tip

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R18.0.0


log_information

Log Information Object

The log information related to the retrieved invoice

invoiceInvoice ObjectThe CRM.COM invoice related to the purchaseinstant_spend_requestSpend Request Customer Event Object

The spend request customer event that was created instantly while processing and awarding the purchase customer event]

Tip

Available from CRM.COM R10.0.0

Deprecated from CRM.COM R17.0.0


automatic_spend_requestSpend Request Customer Event Object

The spend request customer event that was created automatically as part of the automatic awards spending process

Tip

 Available from CRM.COM R13.0.0

Deprecated from CRM.COM R17.0.0


currencyCurrency Object

The purchase customer event's related currency

Tip

Available from CRM.COM R10.0.0


payment_medium_brandPayment Medium Brand Object

The payment medium brand with which the purchase customer event has been made

Tip

Available from CRM.COM R10.0.0


payment_medium_typePayment Medium Brand Object

The payment medium type with which the purchase customer event has been made

Tip

Available from CRM.COM R10.0.0


products_setSet of  Purchase Product ObjectsThe purchased products, along with the total amount, net amount and VAT amount for each productaward_reward_transactions_setSet of Award Reward Transaction ObjectThe award reward transactions that were created as a result of the purchase customer eventspend_reward_transactions_setSet of Spend Reward Transaction Object

The spend reward transactions that were created as a result of the purchase customer event

Tip

Available from CRM.COM R17.0.0


spend_requests_setSet of Spend Request Customer Event Objects

The spend request customer events that were submitted to the purchase customer event

Tip

Available from CRM.COM R12.6.0

Deprecated from CRM.COM R17.0.0


Anchor
purchase customer event referred objects
purchase customer event referred objects
Referred Objects Response Data

...

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
unit_short
unit_short

Include Page
business_unit_short
business_unit_short

Include Page
transaction_acquiring_point_short
transaction_acquiring_point_short

Include Page
access_token_short
access_token_short

...