Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...


Name

Type

Description

id

String

The ID of the retrieved reward spend transaction

number

String

The number of the retrieved reward spend transaction

life_cycle_stateStringThe life cycle state of the retrieved reward spend transaction. The available values are POSTED and CANCELLED
amountNumberThe amount of the retrieved reward spend transaction in rewards participant's currency
alternative_amountNumber

The amount of the retrieved reward spend transaction in rewards participant's alternative currency

Tip

Available from CRM.COM R14.2.0


dateDateThe date and time that the amount was spent
spend_methodString

Defines how the awarded amount was spent

Supported values

  • SPEND_ON_REQUEST
  • SPEND_AUTOMATICALLY
  • SPEND_INSTANTLY
Tip

Available from CRM.COM R17.9.0


accounts_receivableAccounts Receivable Object

The accounts receivable who spends the amount represented by the retrieved reward spend transaction

Tip

Available from CRM.COM R17.0.0


rewards_participantRewards Participant
objectThe Unit
Object

The rewards participant who spends the amount represented by the retrieved reward spend transaction

Tip

Deprecated from CRM.COM R17.0.0


unit
Units object
Unit Object

The unit a which the amount was spend on

Tip

Deprecated from CRM.COM R18.0.0


business_unitBusiness Unit Object

The business unit a which the amount was spend on

Tip

Available from CRM.COM R18.0.0


purchase_customer_eventPurchase Customer Event Object

The purchase customer event that caused the spend reward transaction

Tip

Available from CRM.COM R17.0.0


spend_request_customer_eventSpend Request Customer Event
object
Object

The spend request customer event that caused the spend reward transaction

Tip

Deprecated from CRM.COM R17.0.0


log_information

Log Information

object

Object

The log information related with the retrieved spend reward transaction

voucherVoucher Object

The voucher that was issued when an awarded amount was spent

TipAvailable from CRM.COM R14.2.0

initiated_currencyCurrency Object

The currency in which the reward transaction was initiated in

Tip

Available from CRM.COM R14.2.0


currency_rate_periodCurrency Rate Period Object

The currency rate period of the spend transaction

Tip

Available from CRM.COM R10.0.0


credit_noteCredit Note Object

The credit note financial transaction that was automatically generated as part of the back-end reduction process

Tip

Available from CRM.COM R11.0.0


refundRefund Object

The refund financial transaction that was automatically generated as part of the back-end reduction process

Tip

Available from CRM.COM R13.0.0


wallet_transactions_setSet of Wallet Transaction objectsThe debit wallet transaction that were generated by the spend reward transaction
items_setSet of Products ObjectsA list of products on which the amount was spent, along with the amount spent per product

Anchor
reward spend transaction referred objects
reward spend transaction referred objects
Referred Objects Response Data

Include Page
rewards_participant_short
rewards_participant_short

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
unit_short
unit_short

Include Page
business_unit_short
business_unit_short

Include Page
purchase_customer_event_short
purchase_customer_event_short

Include Page
spend_transaction_spend_request_customer_event_short
spend_transaction_spend_request_customer_event_short

...

Include Page
log_information_short
log_information_short
Include Page
voucher_shortvoucher_short

Include Page
currency_short
currency_short

...