Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved spend request customer event

number

String

The number of the retrieved spend request customer event

typeStringThe type of the retrieved spend request customer event which in this case is set to SPEND REQUEST
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

spend_amountFloat

The amount that is spend by the retrieved spend request customer event in system currency. If not specified then the spend amount is equal to the total amount of the related purchase customer event

Tip

Available from CRM.COM R9.0.0

spend_alternative_amountFloat

The amount that is spend by the retrieved spend request customer event in alternative currency. If not specified then the spend amount is equal to the total amount of the related purchase customer event

Tip

Available from CRM.COM R14.2.0

external_systemString

Defines the third party system that generated the spend request customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_numberString

Defines the unique reference number of the spend request customer event in the external system

Tip

Available from CRM.COM R10.1.0

instant_spendboolean

It defines that the spend request customer event was created instantly as a result of an instant spend offer

Tip

Available from CRM.COM R10.0.0

automatic_spendboolean

It defines that the spend request customer event was created as part of the automatic awards spending process

Tip

Available from CRM.COM R13.0.0

reduction_methodString

It defines how the amount that was requested to be spend will be reduced. The allowed methods are the following:

  • FRONT_END_REDUCTION: If selected then the reduction will be done by the front-end system (for example the POS). This is the default option
  • BACK_END_REDUCTION: If selected then the reduction will be done by a back-end system (for example Paypal). If this option is selected then it is mandatory to specify the back-end reduction settings


Tip

Available from CRM.COM R13.0.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_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

initiated _currencyCurrency

The currency in which the customer event was initiated

Tip

Available from CRM.COM R14.2.0

classificationCustomer Event Classification ObjectThe classification of the customer event
accounts_receivableAccounts receivable ObjectThe related accounts receivable
performed_by_unitUnit ObjectThe unit that initiated the customer event
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

log_information

Log Information Object

The log information related with the retrieved invoice

currencyCurrency Object

The Currency of the spend request

Tip

Available from CRM.COM R10.0.0

purchase_customer_eventPurchase Customer Event ObjectThe purchase customer event which is requested to be settled by the specified spend request
spend_reward_transactionSpend Reward Transaction ObjectThe spend reward transaction that was created as a result of the spend request

...

Include Page
unit_short
unit_short

Include Page
access_token_short
access_token_short

Include Page
log_information_short
log_information_short

...