POST customer_events/referrals/create
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- George Rossides (Unlicensed)
- p_demou (Deactivated)
This method is used to create a referral customer event in a posted life cycle state
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_by_business_unit_identifier (semi-optional) | Business Unit Identifier | The business unit that initiated the customer event. The allowed identifier fields are the following
Available from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
performed_by_unit_identifier (semi-optional) | Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following
For releases prior CRM.COM R17.0.0, this attribute was mandatory From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified Deprecated from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
performed_by_tap_identifier (semi-optional) | Transaction Acquiring Point Identifier | The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following
Available from CRM.COM R17.0.0 From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified | ||||||||||||||||||||||||||||||
performed_on (mandatory) | Date | The date that the customer event was actually performed | ||||||||||||||||||||||||||||||
description (optional) | String | A description of the customer event | ||||||||||||||||||||||||||||||
referred_accounts_receivable_identifier (mandatory) | Accounts Receivable Identifier | The referred accounts receivable. The allowed identifier fields are the following:
Available from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
referred_by_accounts_receivable_identifier (mandatory) | Accounts Receivable Identifier | The accounts receivable that provided the referral. The allowed identifier fields are the following:
Available from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
referred_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The referred rewards participant. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
referred_by_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant that provided the referral. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
external_system (optional) | String | Defines the third party system that generates the customer event Available from CRM.COM R10.0.0 | ||||||||||||||||||||||||||||||
external_system_reference_number (optional) | String | Defines unique reference number of the customer event in the external system Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
authorized_by_access_token_identifier (optional) | Access Token Identifier | The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
promo_code (optional) | String | The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided. Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved referral customer event |
| number | String | The number of the retrieved referral customer event |
| type | String | The type of the retrieved referral customer event which in this case is set to REFERRAL |
| life_cycle_state | String | The life cycle state of the customer event which can be POSTED or CANCELLED |
| performed_on | Date | The date that the customer event was actually performed |
| description | String | A description of the customer event |
| process_immediately | boolean | Defines if the customer event was processed immediately by various business processes or not Deprecated from CRM.COM R15.0.0 |
| external_system | String | Defines the third party system that generated the customer event Available from CRM.COM R10.0.0 |
| external_system_reference_number | String | Defines the reference number that uniquely identifies the customer event in the external system Available from CRM.COM R10.1.0 |
| total_awarded_amount | Number | The total amount that was awarded for the customer event in system currency Available from CRM.COM R13.1.0 |
| total_awarded_alternative_amount | Number | The total amount that was awarded for the customer event in the alternative currency. Available from CRM.COM R14.2.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 |
| classification | Customer Event Classification Object | The classification of the customer event |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable |
| performed_by_unit | Unit Object | The unit that initiated the customer event Deprecated from CRM.COM R18.0.0 |
| performed_by_business_unit | Business Unit Object | The business unit that initiated the customer event Available from CRM.COM R18.0.0 |
| performed_by_tap | Transaction Acquiring Point Object | The transaction acquiring point that initiated the customer event Available from CRM.COM R17.0.0 |
| authorized_by_access_token | Access Token Object | The access token that was used to identify and authorize the customer Available from CRM.COM R15.0.0 Deprecated from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved invoice | |
| referred_accounts_receivable | Accounts Receivable Object | The referred accounts receivable Available from CRM.COM R17.0.0 |
| referred_by_accounts_receivable | Accounts Receivable Object | The accounts receivable that provided the referral Available from CRM.COM R17.0.0 |
| referred_rewards_participant | Rewards Participant Object | The referred rewards participant Deprecated from CRM.COM R17.0.0 |
| referred_by_rewards_participant | Rewards Participant Object | The rewards participant that provided the referral Deprecated from CRM.COM R17.0.0 |
| award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the referral customer event |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"classification_identifier":{"name":"Referral 1"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"Testing creation of referral customer event",
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"referred_rewards_participant_identifier":{"number":"16"},
"referred_by_rewards_participant_identifier":{"number":"12"}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "35",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"referred_reward_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": null,
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": {
"annual_turnover": null,
"tax_reference_number": null,
"profile_year": null,
"number_of_employees": null,
"established_date": null,
"industry_sector": null,
"vat_registration_number": "867586",
"registered_in_country": null,
"vat_registered_by": null,
"vat_registration_date": null,
"industry": null,
"registration_number": null
},
"title": null,
"first_name": null,
"type": "COMPANY",
"id": "B858A00B4D0890B46A84CBF0480939B7",
"name": "Company XY Rewards",
"company_name": "Company XY Rewards",
"demographics": null
},
"life_cycle_state": "ACTIVE",
"number": "ACR000336",
"id": "4267869D4165D062A99C06A60A83674F",
"name": "Company XY Rewards"
},
"number": "16",
"id": "ACC5D657E29561282724364393746180"
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable": {
"account_owner": {
"last_name": "Rewards",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Jessica",
"type": "PERSON",
"id": "79B02448A3F3A9890FCFA899A94D6D72",
"name": "Rewards Jessica",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "867583",
"passport_number": "867583",
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "867582",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000331",
"id": "1F695BE767C2EC001433CA9E1C0F47BA",
"name": "Jessica Rewards"
},
"id": "AE8B054ABB1548B899090840DA8A36BF",
"referred_by_reward_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Rewards",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Jessica",
"type": "PERSON",
"id": "79B02448A3F3A9890FCFA899A94D6D72",
"name": "Rewards Jessica",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "867583",
"passport_number": "867583",
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "867582",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000331",
"id": "1F695BE767C2EC001433CA9E1C0F47BA",
"name": "Jessica Rewards"
},
"number": "12",
"id": "A0FB2D7627CB27AFD5D394B9AC1D1572"
},
"award_reward_transactions_set": null,
"classification": {
"id": "41FA352BB5DB45CA90B2382BC631F4E6",
"name": "Referral 1",
"alternative_code": "R1"
},
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"process_immediately": 0,
"log_information": {
"updated_date": "2016-06-28T17:59:05",
"created_date": "2016-06-28T17:59:05",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"type": "REFERRAL",
"description": "Testing creation of referral customer event",
"performed_on": "2014-05-05T15:49:59"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"classification_identifier":{"name":"3rd Party System Initiated"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"first purchase event",
"process_immediately":1,
"referred_rewards_participant_identifier":{"number":"97"},
"referred_by_rewards_participant_identifier":{"number":"1"},
"fields_set":"number,id,performed_by_unit,classification,referred_rewards_participant"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"classification": {
"id": "602130E6B9F01FA657C5EC0891E93CD0",
"name": "3rd Party System Initiated",
"alternative_code": "3PSI"
},
"number": "33",
"referred_rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Croft",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Lara",
"type": "PERSON",
"id": "4B248A60C1D94C3785369C8D4F70E05E",
"name": "Croft Lara",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "1234567",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000910",
"id": "AC9E86722C56441388D169FB5E3EC1C5",
"name": "ACR000910"
},
"number": "97",
"id": "79B969002B2E4693A1F3485A9BCD5F04"
},
"id": "42DE35ECA2884496BAAEF397CAF18CCB",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
}
}
}