Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved referral customer event

number

String

The number of the retrieved referral customer event

typeStringThe type of the retrieved referral customer event which in this case is set to REFERRAL
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
external_systemString

Defines the third party system that generated the customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_numberString

Defines the reference number that uniquely identifies the customer event in the external system

Tip

Available from CRM.COM R10.1.0

total_awarded_amountNumber

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

Tip

Available from CRM.COM R13.1.0

total_awarded_alternative_amountNumber

The total amount that was awarded for the customer event in the alternative currency.

Tip

Available from CRM.COM R14.2.0

udf_string_1String

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_currency

The currency in which the awarded amount 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 with the retrieved invoice

referred_rewards_participantRewards Participant ObjectThe referred rewards participant
referred_by_rewards_participantRewards Participant ObjectThe rewards participant that provided the referral
award_reward_transactions_setSet of Award Reward Transaction ObjectThe award reward transactions that were created as a result of the referral customer event

Anchor
referral customer event referred objects
referral customer event referred objects
Referred Objects Response Data Include Pagecurrency_shortcurrency_short

Include Page
customer_event_classification_short
customer_event_classification_short

...