Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...


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_immediatelyboolean

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

Tip

Deprecated from CRM.COM R15.0.0


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

classificationCustomer Event Classification ObjectThe classification of the customer event
accounts_receivableAccounts
receivable
Receivable ObjectThe related accounts receivable
performed_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 with the retrieved invoice

referred_accounts_receivableAccounts Receivable Object

The referred accounts receivable

Tip

Available from CRM.COM R17.0.0


referred_by_accounts_receivableAccounts Receivable Object

The accounts receivable that provided the referral

Tip

Available from CRM.COM R17.0.0


referred_rewards_participantRewards Participant Object

The referred rewards participant

Tip

Deprecated from CRM.COM R17.0.0


referred_by_rewards_participantRewards Participant Object

The rewards participant that provided the referral

Tip

Deprecated from CRM.COM R17.0.0


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 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

...