Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlespend request customer event object response data

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_immediatelybooleanDefines if the customer event was processed immediately by various business processes or not
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

spend_alternative_amountFloat

The amount that is spend by the retrieved spend request customer event in alternative currency.

Tip

Available from CRM.COM R14.2.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 R12.6.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 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

initiated_currencyCurrency Object

The currency in which the customer event was initiated in

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

log_information

Log Information Object

The log information related to the retrieved invoice

spend_reward_transactionSpend Reward Transaction ObjectThe spend reward transaction that was created as a result of the spend request
currencyCurrency Object

The Currency of the spend request customer event

Tip

Available from CRM.COM R10.0.0

voucherVoucher Object

The voucher that was issued because on an instant spent on vouchers

Tip

Available from CRM.COM R14.2.0


Anchor
spend request customer event short referred objects
spend request customer event short referred objects
Referred Objects Response Data

Include Page
currency_short
currency_short

Include Page
customer_event_classification_short
customer_event_classification_short

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
unit_short
unit_short

Include Page
log_information_short
log_information_short

Include Page
spend_reward_transaction_short
spend_reward_transaction_short

Include Page
currency_short
currency_short

Include Page
voucher_short
voucher_short